REST input plain HTTP

POST 
/http.input/:connectionID

The REST input plain HTTP endpoint supports the conversion of large files (larger than 100 MB). In the request body, provide a file you want to convert as the multipart/form-data content type.

Request

Path Parameters

connectionID stringrequired
The connectionID defines which Connection you want to run using the Simple API. The Conversion Service comes with a preconfigured Connection that has an ID archive-pdfa2-default. To use another custom integration:
1. Go to the Conversion Service Configurator > Integration.
2. Click the pencil icon next to one of the integrations.
3. Under the Input section, click the pencil icon next to one of the Input configurations.
4. Copy the connectionID from the Connection ID field.

multipart/form-data

Body

required

Upload the file to be converted as multipart/form-data content type. Include the binary data of your document in the data field.

data binaryrequired

Include data of the file to be uploaded.

Responses

200

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

application/pdf

Schema

Schema

string

success

Successful file conversion

BINARY_CONTENT

202

The file was successfully submitted for conversion and the conversion will start.

400

• The job must contain at least one data element.

• Exception message that occurred during processing.

application/json

Schema

Schema

error stringrequired

An error occurred.

Example (from schema)

{
  "error": "An error occurred."
}

badRequest

Invalid File Upload

{
  "error": "Invalid file format or corrupted file."
}

404

• The provided connectionID was not found.

415

Unsupported media type. Returns ProblemDetails:

• A file format is not supported.

application/problem+json

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string"
}

serverErrorJson:

Unsupported format

{
  "type": "http://www.pdf-tools.com/service/rest/errors/workflow/unsupportedFormat",
  "title": "Unsupported file format.",
  "detail": "A file format is not supported.",
  "status": 415
}

application/problem+xml

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

<root>
  <type>string</type>
  <title>string</title>
  <status>0</status>
  <detail>string</detail>
</root>

serverErrorXml

Unsupported format

<problem xmlns="urn:ietf:rfc:7807">
  <type>http://www.pdf-tools.com/service/rest/errors/workflow/unsupportedFormat</type>
  <title>Unsupported file format.</title>
  <detail>A file format is not supported.</detail>
  <status>415</status>
</problem>

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.

application/problem+json

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string"
}

serverErrorJson:

Incompatible conformance

{
  "type": "http://www.pdf-tools.com/service/rest/errors/workflow/conformance",
  "title": "Incompatible conformance.",
  "detail": "The conformance is not compatible.",
  "status": 422
}

application/problem+xml

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

<root>
  <type>string</type>
  <title>string</title>
  <status>0</status>
  <detail>string</detail>
</root>

serverErrorXml

Incompatible conformance

<problem xmlns="urn:ietf:rfc:7807">
  <type>http://www.pdf-tools.com/service/rest/errors/workflow/conformance</type>
  <title>Incompatible conformance.</title>
  <detail>The conformance is not compatible</detail>
  <status>422</status>
</problem>

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.

application/problem+json

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string"
}

serverErrorJson:

Server error

{
  "type": "http://www.pdf-tools.com/service/rest/errors/workflow/internal",
  "title": "Internal server error.",
  "detail": "An internal error happened during processing.",
  "status": 500
}

application/problem+xml

Schema

Schema

type string

A URI reference that identifies the problem type. Note that this URI cannot be dereferenced.

title stringrequired

A short, human-readable summary of the problem type.

status integerrequired

The HTTP status code.

detail stringrequired

A human-readable explanation specific to this occurrence of the problem.

Example (from schema)

<root>
  <type>string</type>
  <title>string</title>
  <status>0</status>
  <detail>string</detail>
</root>

serverErrorXml

Server error

<problem xmlns="urn:ietf:rfc:7807">
  <type>http://www.pdf-tools.com/service/rest/errors/workflow/internal</type>
  <title>Internal server error.</title>
  <detail>An internal error happened during processing</detail>
  <status>500</status>
</problem>

Loading...