Import upload callback API
Availability
This API is a simple callback API to let a third-party service when a file has been uploaded in the Import page.
Enabling the callback API
You enable the callback API by setting the following property in your properties-local.xml file:
<property
as="xs:string"
name="oxf.fr.import.attachment-callback.uri.*.*"
value="http://localhost:8084/post"/>Replace http://localhost:8084/post with the endpoint where the callback should be sent.
Where the *.* suffix means that this applies to all applications and all forms. You can also set this property for a specific application and/or form by replacing the * with the application name and/or form name.
Request format
When a file is uploaded in the Import page, a POST request is sent to the configured endpoint. The request contains the following URL parameters:
filename: the name of the uploaded file as reported by the browser at upload timeapp: the current form's app nameform: the current form's form nameform-version: the form definition version in usedocument: the current document id, if it was passed to the Import page (as thedocument-idURL parameter)
Headers:
Content-Type: the media type of the uploaded file
Example URL generated:
Expected response
If the callback endpoint responds with a 2xx status code, the upload is considered successful.
If the callback endpoint responds with a non-2xx status code, or if the connection fails, the upload is considered failed, and an error message is shown in the log files. However, the import process is allowed to continue.
See also
Last updated