The Athento API has an endpoint available to execute an operation that is configured, overwriting the value of the parameters that are configured (if desired). The endpoint available for this is:
POST /file/api/file/{uuid}/run-operation/
A configured example operation can be seen here:
In this screenshot you can see the "key" value in each of the parameters. It is an important value, which is used to overwrite the parameters from the call to the endpoint.
In the following Swagger screenshot you can see how the operation can be launched from the endpoint by modifying its parameters:
The parameters of this endpoint are the following:
- data: JSON with the key of the parameter to overwrite and the new value to be taken.
- op_uuid: UUID of the operation to be executed. It can be obtained from the operation configuration.
- uuid: UUID of the document on which the operation applies.
The parameters have the following restrictions, which can be checked with the help of the above screenshot:
- If a parameter is marked as multiple, the new value has to be sent as a list: [].
- Dates and dates with time must be provided in ISO format (https://en.wikipedia.org/wiki/ISO_8601). See the example in the screenshot.
- For Athento's own entities (User, Series, DocumentType, MetadataType) the UUID of the element to be used must be provided.
Comments
0 comments
Please sign in to leave a comment.