REST input JSON

POST 
/http.inputstructured/:connection-id

REST input JSON allows for structured input and output for your documents. Upload documents using a URL or in Base64 encoded format.

Request

Path Parameters

connection-id stringrequired
The connection-id 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 connection-id from the Connection ID field.

application/json

Body

required

Include one or more files for conversion. There are two possibilities how to inlcude files:

• Encoded in Base64 format. Use the content parameter.

• Share a URL pointing to the file. Use the url parameter.

name string

Name of the conversion job.

data

object[]

required

Array [

url urinullable

URL to a file.

content stringnullable

Base64-encoded content of the file.

fileName stringrequired

Name of the file.

options

object[]

nullable

Document options.

Array [

name stringnullable

Name of the option.

value stringnullable

Value of the option.

]

]

variables

object

nullable

Job variables represented as key-value pairs.

property name* string

options

object[]

nullable

Job options.

Array [

name stringnullable

Name of the option.

value stringnullable

Value of the option.

]

Responses

200

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

application/json

Schema

Schema

data

object[]

required

List of converted files.

Array [

fileName stringrequired

Name of the converted file.

content stringrequired

Base64-encoded content of the resulting file.

]

Example (from schema)

{
  "data": [
    {
      "fileName": "hello_world.pdf",
      "content": "JVBERi0xLjcKJeLjz9MKOSAwIG9iagpbL0NhbEdyYXkgPDwKL1..."
    }
  ]
}

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/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"
}

badRequestJson

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "status": 400,
  "title": "Bad request",
  "detail": "The job must contain at least one data element."
}

404

• The provided connection-id 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:

{
  "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

<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:

{
  "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

<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:

{
  "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

<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...