POST a conversion order
This API allows you to request a conversion order to create a new document in an expected format.
API technical description
Endpoint:
POST /conversions
Body:
| Attribute | Type | Required | Description |
|---|---|---|---|
| documentId | String | yes | Source document id. |
| format | String | yes | Target document format. |
Response:
| Attribute | Type | Description |
|---|---|---|
| conversionOrderId | ConversionOrderId | conversion order ID. This can allow you to use other APIs like the one to retrieve some information about the conversion or to delete it. |
Examples
Convert a document
The call below generates a conversion request for a document already known from the rendition.
curl -X 'POST' \
'http://localhost:8761/conversions' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"documentId": "docId",
"format": "pdf",
}'