REST input JSON

POST 
/http.inputstructured/:connectionID

Submit files for conversion using structured JSON input. Upload documents using a URL or in Base64-encoded format. This endpoint supports structured input and output, including job options and metadata.

The connectionID path parameter determines which pre-installed or custom Connection to use. For available values, refer to Pre-installed connections.

Request

Responses

200

The file was successfully submitted for conversion and the Simple API included the converted file in the API response.

202

The file was successfully submitted for conversion. This response is returned when the Response setting in the REST Input Connector is set to Immediately. The file will be processed asynchronously.

400

• The job must contain at least one data element.
• Exception message that occurred during processing.

404

• The provided connectionID was not found.

415

Unsupported media type. Returns ProblemDetails:

• A file format is not supported.

422

Unprocessable file. Returns ProblemDetails:

• The conformance is not compatible.
• The file is corrupt.
• A generic error happened during processing.
• One of the specified options is invalid.
• The password is missing or incorrect.
• A file contains a feature that is not supported.

500

An internal server error. Returns ProblemDetails:

• The job was canceled.
• The service is not configured correctly.
• An internal error happened during processing.
• A timeout occurred during processing.
• If an unknown error occurs the message you receive is empty.