La API de Athento tiene disponible un endpoint para ejecutar una operación que esté configurada, sobreescribiendo el valor de los parámetros que hay configurados (si se desea). El endpoint disponible para esto es:
POST /file/api/file/{uuid}/run-operation/
Aquí se puede ver una operación de ejemplo configurada:
En esta captura se puede observar el valor "key" que hay en cada uno de los parámetros. Es un valor importante, que sirve para poder sobreescribir los parámetros desde la llamada al endpoint.
En la siguiente captura de Swagger se puede observar cómo se puede lanzar la operación desde el endpoint modificando sus parámetros:
Los parámetros de este endpoint son los siguientes:
- data: JSON con la "key" del parámetro a sobreescribir y el nuevo valor que va a tomar.
- op_uuid: UUID de la operación a ejecutar. Se puede obtener desde la configuración de la operación.
- uuid: UUID del documento sobre el que se aplica la operación.
Los parámetros tienen las siguientes restricciones, que se pueden comprobar con ayuda de la captura anterior:
- Si un parámetro está marcado como múltiple, el nuevo valor hay que enviarlo como una lista: []
- Las fechas y fechas con hora hay que proporcionarlas en formato ISO (https://en.wikipedia.org/wiki/ISO_8601). Ver el ejemplo de la captura.
- Para las entidades propias de Athento (User, Serie, DocumentType, MetadataType) hay que aportar el UUID del elemento a utilizar.
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.