Puntos de conexión de Autoruns/Plugins (2022/06)
Los endpoints de Autoruns/Plugins permiten a los usuarios administrar plugins de ejecución automática en una red.
URL base para este endpoint: https://api.bsn.cloud/2022/06/REST/Autoruns/Plugins
_________________________________________________________________________
GET /
Devuelve una lista de plugins de ejecución automática en una red
Token de alcance requerido
bsn.api.main.autoruns.plugins.retrieve
______________________________________________________________
Parámetros de cadena de consulta
- filtro string opcional: Una expresiónexpresión para filtrar resultados de búsqueda. El valor predeterminado es null.
- clasificar string opcional: Una expresión para ordenar los resultados de búsqueda. La expresión de ordenación especifica la entrada utilizada para ordenar y el orden de clasificación ascendente/descendente (ASC/DESC) (consulte esta páginaesta página para obtener más información). El valor predeterminado es null.
- marcador string opcional: Un valor que especifica qué página recuperar. Este valor es útil si la entrada isTruncated en el cuerpo de respuesta de la llamada GET anterior indica que el número de instancias de plugins de ejecución automática excede el pageSize.Este parámetro solo es necesario si necesita más elementos en la lista paginada que el pageSize (100).
- pageSize int opcional: El número máximo de instancias de plugins de ejecución automática que se pueden incluir en el cuerpo de respuesta. Esto utiliza de forma predeterminada el tamaño máximo de página permitido (100).
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- marcador value is set to the [PagedList].[NextMarker] property value from the previous BSN.Cloud API response.
- pageSize se establece en 1
- filtro se establece en [FileInfo].[Type] ES 'Stored' Y [FileInfo].[Size] ES MAYOR QUE 0 Y [FileInfo].[Name] ES '*.brs'
- clasificar se establece en [FileInfo].[CreationDate] ASC
GET /2022/06/REST/Autoruns/Plugins/?marker=MjAyMy0wOC0zMVQyMDo1Nzo0Mi41MDdaLDE1Mjc3&pageSize=1&filter=%5BFileInfo%5D.%5BType%5D%20IS%20%27Stored%27%20AND%20%5BFileInfo%5D.%5BSize%5D%20IS%20GREATER%20THAN%200%20AND%20%5BFileInfo%5D.%5BName%5D%20IS%20%27*.brs%27&sort=%5BFileInfo%5D.%5BCreationDate%5D%20ASC HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de respuesta exitoso
200: Devuelve una lista paginadalista paginada de Entidad de plugin de ejecución automáticaEntidad de plugin de ejecución automática en una red. Esto devolverá no más de 100 entidades junto con la información necesaria para devolver cualquier otra página restante.
Ejemplo
{
"items": [ {
"id": 15342,
"name": "liveTextPlugin",
"fileInfo": {
"id": 15342,
"path": "https://bsncloud.s3.amazonaws.com/bsts/9b6a47d278ad065a03ba680c345f0ea7",
"type": "Stored",
"name": "livetextboth.brs",
"size": 12,
"hash": "430CE34D020724ED75A196DFC2AD67C77772D169",
"creationDate": "2023-09-08T15:44:01.717Z",
"lastModifiedDate": "2023-09-08T15:44:01.717Z"
},
"presentations": [ {
"id": 65425,
"name": "GreatPresentation",
"type": "Presentation",
"link": null
}],
"totalItemCount": 4,
"matchingItemCount": 4,
"pageSize": 1,
"nextMarker": "MjAyMy0wOS0wOFQxNTo0NDowMS43MTdaLDE1MzQy",
"prevMarker": "MjAyMy0wOS0wOFQxNTo0NDowMS43MTdaLDE1Gh78",
"isTruncated": false,
"sortExpression": "[FileInfo].[CreationDate] ASC",
"filterExpression": "[FileInfo].[Type] IS 'Stored' AND [FileInfo].[Size] IS GREATER THAN 0 AND [FileInfo].[Name] IS '*.brs'"
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se ha especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (según se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
POST /
Crear un nuevo plugin de ejecución automática en una red
Token de alcance requerido
bsn.api.main.autoruns.plugins.create
______________________________________________________________
Cuerpo de la solicitud
- La Entidad de plugin de ejecución automáticaAutorun Plugin Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo están configurados de la siguiente manera:
POST /2022/06/REST/Autoruns/Plugins/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 271Este es el cuerpo de la solicitud de ejemplo:
{
"id":0,
"name":"liveTextPlugin",
"fileInfo": {
"id":0,
"name":"livetextboth.brs",
"type":"New",
"body":"aGVsbG8gd29ybGQh",
"transferEncoding":"base64",
"size":0,
"hash":"",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
},
"presentations":null
}
______________________________________________________________
Cuerpo de respuesta exitoso
201: Devuelve la Entidad de plugin de ejecución automáticaAutorun Plugin Entity creada y referenciada por el Uri (proporcionado por el campo de encabezado Location) en la respuesta.
Ejemplo
{
"id": 15342,
"name": "liveTextPlugin",
"fileInfo": {
"id": 15342,
"path": "https://bsncloud.s3.amazonaws.com/bsts/9b7f49d765ad795k06ba600c345f0ea7",
"type": "Stored",
"name": "livetextboth.brs",
"size": 12,
"hash": "430CE34D020724ED75A196DFC2AD67C77772D169",
"creationDate": "2023-09-08T15:44:01.7152901Z",
"lastModifiedDate": "2023-09-08T15:44:01.7152901Z"
},
"presentations": null
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud están mal formados y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio (por ejemplo, el nombre debe ser único)
401: El token de acceso no es válido o no se ha especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /
Elimina los plugins de autorun que coinciden con la expresión de filtro especificada de una red. Esto permite eliminar varios plugins de autorun a la vez.
Token de Scope requerido
bsn.api.main.autoruns.plugins.delete
______________________________________________________________
Parámetros de Query String
- filtro string required: Una expresiónexpresión para filtrar resultados de búsqueda.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [FileInfo].[Name] IS 'livetextboth.brs'
DELETE /2022/06/REST/Autoruns/Plugins/?filter=%5BFileInfo%5D.%5BName%5D%20IS%20%27livetextboth.brs%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve el número de plugins de autorun afectados como un valor entero.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay varias representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se ha especificado
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /Count/
Devuelve el número de plugins de autorun que coinciden con la expresión de filtro especificada en la red
Token de Scope requerido
bsn.api.main.autoruns.plugins.retrieve
______________________________________________________________
Parámetros de Query String
- filtro string optional: Una expresiónexpresión para filtrar resultados de búsqueda. El valor predeterminado es null.
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- filtro se establece en [FileInfo].[Type] ES 'Stored' Y [FileInfo].[Size] ES MAYOR QUE 0 Y [FileInfo].[Name] ES '*.brs'
GET /2022/06/REST/Autoruns/Plugins/Count/?filter=%5BFileInfo%5D.%5BType%5D%20IS%20%27Stored%27%20AND%20%5BFileInfo%5D.%5BSize%5D%20IS%20GREATER%20THAN%200%20AND%20%5BFileInfo%5D.%5BName%5D%20IS%20%27*.brs%27 HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: El recuento de plugins autorun se devuelve como un valor entero.
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque es válido, no proporciona acceso a este método
406: El servidor no puede devolver la representación de datos que usted solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
GET /{id}/
Devuelve el plugin autorun especificado en una red
Token de ámbito requerido
bsn.api.main.autoruns.plugins.retrieve
______________________________________________________________
Segmento
- id int: Un identificador único para una instancia de plugin autorun
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
GET /2022/06/REST/Autoruns/Plugins/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Cuerpo de la respuesta exitosa
200: Devuelve la Entidad de plugin autorunAutorun Plugin Entity
Ejemplo
{
"id": 12345,
"name": "liveTextPlugin",
"fileInfo": {
"id": 15342,
"path": "https://bsncloud.s3.amazonaws.com/bsts/9b7f47d765ad105k06ba680c345f0ea7",
"type": "Stored",
"name": "livetextboth.brs",
"size": 12,
"hash": "430CE34D020724ED75A196DFC2AD67C77772D169",
"creationDate": "2023-09-08T15:44:01.717Z",
"lastModifiedDate": "2023-09-08T15:44:01.717Z"
},
"presentations": [
{
"id": 65425,
"name": "GreatPresentation",
"type": "Presentation",
"link": null
}
]
}Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud está mal formada y, por lo tanto, no es válida
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: Un plugin de autorun con el id especificado no existe
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
5XX: Cualquier código 500 es un error interno del servidor
PUT /{id}/
Actualice un plugin de autorun especificado en una red
Token de Scope requerido
bsn.api.main.autoruns.plugins.update
______________________________________________________________
Segmento
- id int: Un identificador único para una instancia de plugin de autorun
______________________________________________________________
Cuerpo de la solicitud
La Entidad de plugin de autorunAutorun Plugin Entity
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera:
- id es 12345
PUT /2022/06/REST/Autoruns/Plugins/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 421Este es el cuerpo de la solicitud de ejemplo:
{
"id": 0,
"name": "liveTextPlugin",
"fileInfo": {
"id": 1,
"path": "https://bsncloud.s3.amazonaws.com/bsts/3d1a47da65ed068k76ba641c345f3dd5",
"type": "Stored",
"name": "plugin.brs",
"size": 4,
"hash": "5BF1FD927DFB8679496A2E6CF00CBE50C1C87145",
"creationDate": "0001-01-01T00:00:00",
"lastModifiedDate": "0001-01-01T00:00:00"
},
"presentations": []
}______________________________________________________________
Respuesta exitosa
204: El plugin de autorun especificado ha sido actualizado en la red
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tiene un formato incorrecto y, por lo tanto, es inválido, o se rechaza de acuerdo con las reglas de negocio
401: El token de acceso es inválido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado
406: El servidor no puede devolver la representación de datos que solicitó (como se especifica en el encabezado "Accept")
412: Falló la condición previa (el recurso/plugin de autorun cambió desde el momento especificado en el valor del encabezado “If-Unmodified-Since”)
415: El servidor no puede aceptar la representación de datos que envió (como se especifica en el encabezado "Content-Type")
5XX: Cualquier código 500 es un error interno del servidor
DELETE /{id}/
Elimine un plugin de autorun especificado de una red
Token de Scope requerido
bsn.api.main.autoruns.plugins.delete
______________________________________________________________
Segmento
- id int: Un identificador único para una instancia de plugin de autorun
______________________________________________________________
Ejemplo de solicitud
Los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera:
- id se establece en 12345
DELETE /2022/06/REST/Autoruns/Plugins/12345/ HTTP/1.1
Host: api.bsn.cloud
Connection: Keep-Alive
Authorization: Bearer {{UserAccessToken}}}
Accept: application/json, application/vnd.bsn.error+json
Accept-Encoding: gzip,deflate______________________________________________________________
Respuesta correcta
204: El plugin de autorun especificado se ha eliminado de la red
Respuesta de error
300: La representación solicitada no pudo devolverse porque es ambigua (hay múltiples representaciones solicitadas)
400: La solicitud o el cuerpo de la solicitud tienen un formato incorrecto y, por lo tanto, no son válidos, o se rechazan de acuerdo con las reglas de negocio
401: El token de acceso no es válido o no se especificó
403: El token de acceso proporcionado, aunque válido, no proporciona acceso a este método
404: El servidor no puede encontrar el recurso solicitado
406: El servidor no puede devolver la representación de datos que usted solicitó (según se especifica en el encabezado "Accept")
412: La condición previa falló (el recurso cambió desde la hora especificada en el valor del encabezado “If-Unmodified-Since”)
5XX: Cualquier código 500 es un error interno del servidor