Puntos de conexión de Autoruns/Plugins (2022/06)

12 min

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ón docid\ cot2dfqig9wykoya94hex 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ágina docid\ cot2dfqig9wykoya94hex 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 paginada docid 1gsmbtulb07tf6mcfqcxp de entidad de plugin de ejecución automática docid\ dfawcok8atggwtlvxep61 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ática docid\ dfawcok8atggwtlvxep61 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 271 este 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ática docid\ dfawcok8atggwtlvxep61 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ón docid\ cot2dfqig9wykoya94hex 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ón docid\ cot2dfqig9wykoya94hex 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 autorun docid\ dfawcok8atggwtlvxep61 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 autorun docid\ dfawcok8atggwtlvxep61 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 421 este 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