openapi: 3.0.0
info:
  title: PDFreactor Web Service Conversion REST API
  description: This is the conversion REST API definition and documentation of the PDFreactor Web Service.
  termsOfService: https://www.pdfreactor.com
  contact:
    name: PDFreactor Support Team
    email: support@realobjects.com
    url: http://www.pdfreactor.com
  license:
    name: PDFreactor Software License Agreement
    url: https://www.pdfreactor.com
  x-logo:
    url: https://www.realobjects.com/wp-content/uploads/images/logos/prlogo-180x180.png
    altText: PDFreactor Logo
  version: 11.6.11

servers:
  - url: http://localhost:9423/service/rest
  - url: https://cloud.pdfreactor.com/service/rest
paths:
  /convert:
    post:
      description: >
        Converts the specified configuration or asset package into PDF or image and returns the generated PDF or image.
      summary: Convert synchronously
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Configuration'
          application/xml:
            schema:
              $ref: '#/components/schemas/Configuration'
          application/zip:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Conversion successful
          content: &responseResult
            application/json:
              schema: 
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
            application/pdf:
              schema:
                type: string
                format: binary
            application/octet-stream:
              schema:
                type: string
                format: binary
            text/plain:
              schema:
                type: string
                format: base64
        '400': &response400
          description: >
            Multiple Reasons: (1) No configuration was supplied to the operation. (2) No input document was specified in the configuration. (3) The page number you specified is either below 0 or exceeds the document's total number of pages. (4) The supplied configuration was not valid for some reason. See the error message for details. (5) The version of the client that was used is outdated and no longer supported. This is only available for the PDFreactor REST clients.
          content: &responseResultError
            application/json:
              schema: 
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
            '*/*':
              schema:
                type: string
        '401': &response401
          description: &response401desc >
            The client failed an authorization check, e.g. because a supplied API key was invalid.
          content: *responseResultError
        '422': &response422
          description: &response422desc >
            The supplied configuration was accepted by PDFreactor but could not be converted for some reason. See the error message for details.
          content: *responseResultError
        '500': &response500
          description: &response500desc >
            Multiple Reasons: (1) The configuration could not be processed and should be re-checked. (2) The supplied configuration is valid, however the conversion could not be completed for some reason. See the error message for details.
          content: *responseResultError
        '503': &response503
          description: &response503desc >
            Multiple Reasons: (1) Asynchronous conversions are not available in this PDFreactor Web Service. (2) The PDFreactor Web Service is running and reachable, but not in a state to perform the requested task.
          content: *responseResultError
  /convert/async:
    post:
      description: >
        Converts the specified configuration or asset package into PDF or image. This operation responds immediately and does not wait for the conversion to finish. This is especially useful for very large or complex documents where the conversion will take some time.
      summary: Convert asynchronously
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Configuration'
          application/xml:
            schema:
              $ref: '#/components/schemas/Configuration'
          application/zip:
            schema:
              type: string
              format: binary
      responses:
        '202':
          description: Conversion successful started
          headers:
            Location:
              description: The relative URL where the progress of the conversion can be polled.
              schema:
                type: string
                format: url
                example: "/progress/{documentId}"
        '400': *response400
        '401': *response401
        '422': *response422
        '500': *response500
        '503':
          description: >
            Multiple Reasons: (1) Asynchronous conversions are not available in this PDFreactor Web Service. (2) The PDFreactor Web Service is running and reachable, but not in a state to perform the requested task.
          content: *responseResultError
  /progress/{id}:
    get:
      description: >
        Retrieves progress information about the asynchronous conversion with the given ID.
      summary: Retrieve progress for async conversion
      parameters:
        - &documentIdParam
          in: path
          name: id
          schema:
            type: string
          required: true
          description: The ID of the document.
      responses:
        '200':
          description: The current estimated progress, including log output.
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/Progress'
            application/xml:
              schema: 
                $ref: '#/components/schemas/Progress'
        '201':
          description: The conversion is finished and the result can be accessed via the URL indicated in the 'Location' header.
          headers:
            Location:
              description: The location where the document can be downloaded.
              schema:
                type: string
                format: url
                example: "/document/{documentId}"
        '401': *response401
        '404': &response404
          description: &response404desc >
            Multiple Reasons: (1) A web service resource was not found. (2) Conversion does not exist.
          content: *responseResultError
        '500': *response500
        '503': *response503
  /document/{id}:
    get:
      description: >
        Retrieves the asynchronously converted document with the given ID.
      summary: Retrieve converted document
      parameters:
        - *documentIdParam
      responses:
        '200':
          description: The document was found and the conversion has finished.
          content: *responseResult
        '400': *response400
        '401': *response401
        '404': *response404
        '422': *response422
        '500': *response500
        '503': *response503
    delete:
      description: >
        Deletes the asynchronously converted document with the given ID. If the conversion is still running, it gets terminated.
      summary: Delete converted document or terminate its conversion
      parameters:
        - *documentIdParam
      responses:
        '204':
          description: A message indicating that the document has been successfully deleted.
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503
  /document/metadata/{id}:
    get:
      description: >
        Retrieves the metadata of the asynchronously converted document with the given ID.
      summary: Retrieve metadata of converted document
      parameters:
        - *documentIdParam
      responses:
        '200':
          description: The document's metadata only, meaning the properties 'document' and 'documentArray' will me missing.
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/Result'
            application/xml:
              schema:
                $ref: '#/components/schemas/Result'
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503  
  /document/{id}/{page}:
    get:
      description: >
        Retrieves the specified page of the asynchronously converted multi-page image with the specified ID. This operation only functions when converting into image types, not PDF. Additionally, the configuration option "multiPage" has to be set to "true", otherwise there are no multiple pages.
      summary: Retrieve page of converted multi-page image
      parameters:
        - *documentIdParam
        - &pageParam
          in: path
          name: page
          schema:
            type: integer
            minimum: 1
          required: true
          description: The page number.
      responses:
        '200':
          description: A page of the converted document.
          content: &responseImage
            image/bmp:
              schema:
                type: string
                format: binary
            image/gif:
              schema:
                type: string
                format: binary
            image/jpeg:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
            image/tiff:
              schema:
                type: string
                format: binary
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503 
  /document/{id}/show/{filename}:
    get:
      description: >
        Displays the asynchronously converted document in the browser. When downloading the document, browsers will save it under the specified filename.
      summary: Display converted document in browser
      parameters:
        - *documentIdParam
        - &filenameParam
          in: path
          name: filename
          schema:
            type: string
          required: true
          description: The desired file name including the file extension.
      responses:
        '200':
          description: The converted document.
          content: &responseFile
            application/pdf:
              schema:
                type: string
                format: binary
            image/bmp:
              schema:
                type: string
                format: binary
            image/gif:
              schema:
                type: string
                format: binary
            image/jpeg:
              schema:
                type: string
                format: binary
            image/png:
              schema:
                type: string
                format: binary
            image/tiff:
              schema:
                type: string
                format: binary
            text/plain:
              schema:
                type: string
                format: base64
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503 
  /document/{id}/{page}/show/{filename}:
    get:
      description: >
        Displays the specified page of the asynchronously converted multi-page image in the browser. When downloading the document, browsers will save it under the specified filename.
      summary: Display page of multi-page image in browser
      parameters:
        - *documentIdParam
        - *pageParam
        - *filenameParam
      responses:
        '200':
          description: The converted document.
          content: *responseFile
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503
  /document/{id}/download/{filename}:
    get:
      description: >
        Downloads the asynchronously converted document in the browser. The download is triggered by an appropriate "Content-Disposition" header. When downloading the document, browsers will save it under the specified filename.
      summary: Download converted document in browser
      parameters:
        - *documentIdParam
        - *filenameParam
      responses:
        '200':
          description: The converted document.
          content: *responseFile
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503 
  /document/{id}/{page}/download/{filename}:
    get:
      description: >
        Downloads the specified page of the asynchronously converted multi-page image in the browser. The download is triggered by an appropriate "Content-Disposition" header. When downloading the document, browsers will save it under the specified filename.
      summary: Download page of multi-page image in browser
      parameters:
        - *documentIdParam
        - *pageParam
        - *filenameParam
      responses:
        '200':
          description: The converted document.
          content: *responseImage
          headers:
            Content-Disposition:
              description: A header to trigger a download in the browser.
              schema:
                type: string
        '401': *response401
        '404': *response404
        '500': *response500
        '503': *response503
  /document/bundle:
    post:
      description: >
        Retrieves the asynchonously converted documents as a ZIP.
      summary: Retrieve converted documents as ZIP
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Bundle'
          application/xml:
            schema:
              $ref: '#/components/schemas/Bundle'
      responses:
        '200':
          description: The converted documents as ZIP
          content:
            application/zip:
              schema:
                type: string
                format: binary
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: *response401desc
          content: &responseResultErrorZip
            '*/*':
              schema:
                type: string
        '404':
          description: *response404desc
          content: *responseResultErrorZip
        '422':
          description: >
            The supplied input data was accepted by PDFreactur but could not be processed for some reason. See the error message for details.
          content: *responseResultErrorZip
        '500':
          description: *response500desc
          content: *responseResultErrorZip
        '503':
          description: *response503desc
          content: *responseResultErrorZip
  /version:
    get:
      description: >
        Returns the version of the PDFreactor Web Service that is currently running.
      summary: Version of the PDFreactor Web Service
      responses:
        '200':
          description: The version.
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/Version'
            application/xml:
              schema:
                $ref: '#/components/schemas/Version'
            text/plain:
              schema:
                type: string
        '401': &response401plain
          description: *response401desc
          content:
            text/plain:
              schema:
                type: string
        '503':
          description: *response503desc
          content:
            text/plain:
              schema:
                type: string
  /status:
    get:
      description: >
        Checks if the PDFreactor Web Service is available and functional.
      summary: Healthcheck
      responses:
        '200':
          description: The service is available and functional.
          content:
            text/plain:
              schema:
                type: string
        '401': *response401plain
        '503':
          description: The service is not functional.
          content:
            text/plain:
              schema:
                type: string
  /schema:
    get:
      description: >
        Retrieves the JSON schema for all data models consumed or produced by the PDFreactor Web Service.
      summary: JSON schema
      responses:
        '200':
          description: The JSON schema for all data models consumed or produced by the PDFreactor Web Service.
          content:
            text/plain:
              schema:
                type: string
        '401': *response401plain
        '404':
          description: The schema resource was not found.
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    AddressType:
      enum:
      - "LINK_LOCAL"
      - "LOCAL"
      - "PRIVATE"
      - "PUBLIC"
      type: "string"
    Attachment:
      properties:
        data:
          description: "<p>The binary content of the attachment. May be <code><span\
            \ class='null'>null</span></code>.</p>"
          format: "base64"
          type: "string"
        description:
          description: "<p>The description of the attachment. If this is not set or\
            \ <code><span class='null'>null</span></code> the value of <code>name</code>\
            \ is used.</p>"
          type: "string"
        name:
          description: "<p>The file name associated with the attachment. It is recommended\
            \ to specify the correct file extension. If this is not set or <code><span\
            \ class='null'>null</span></code> the name is derived from <code>url</code>.</p>"
          type: "string"
        url:
          description: "<p>If <code>data</code> is not set or set to <code><span class='null'>null</span></code>,\
            \ the attachment will be retrieved from this URL.</p> <p>If this is \"\
            #\" the input document URL is used instead.</p>"
          format: "url"
          type: "string"
    BookletMode:
      properties:
        rtl:
          description: "<p>Whether or not the reading order of the booklet should\
            \ be right-to-left.</p>"
          type: "boolean"
        sheetMargin:
          description: "<p>The sheet margin as CSS margin value, for example <code>\"\
            1in\"</code>, <code>\"1cm 1.5cm\"</code> or <code>\"10mm 20mm 10mm 30mm\"\
            </code>. <code><span class='null'>null</span></code> is interpreted as\
            \ <code>\"0mm\"</code>.</p>"
          type: "string"
        sheetSize:
          description: "<p>The size of the sheet as CSS value, for example <code>\"\
            A3\"</code>, <code>\"letter landscape\"</code>, <code>\"15in 20in\"</code>\
            \ or <code>\"20cm 30cm\"</code>.</p>"
          type: "string"
    Bundle:
      properties:
        documents:
          description: "An array of documents requests."
          items:
            $ref: "#/components/schemas/Document"
          type: "array"
    Callback:
      properties:
        contentType:
          $ref: "#/components/schemas/ContentType"
          description: "<p>The content type of the payload that is posted.</p>"
        interval:
          description: "<p>The interval in seconds at which to trigger repeating callbacks.</p>\
            \ <p>Only applies <code>\"PROGRESS\"</code>.</p>"
          type: "integer"
        timeout:
          description: "<p>An optional timeout for the callback in milliseconds. A\
            \ value of zero or negative values are treated as an infinite timeout.</p>"
          type: "integer"
        type:
          $ref: "#/components/schemas/CallbackType"
          description: "<p>The event to trigger the callback.</p>"
        url:
          description: "<p>The URL to call back.</p>"
          format: "url"
          type: "string"
    CallbackType:
      enum:
      - "FINISH"
      - "PROGRESS"
      - "START"
      type: "string"
    Cleanup:
      enum:
      - "CYBERNEKO"
      - "JTIDY"
      - "NONE"
      - "TAGSOUP"
      type: "string"
    ColorSpace:
      enum:
      - "CMYK"
      - "RGB"
      type: "string"
    ColorSpaceSettings:
      properties:
        cmykIccProfile:
          $ref: "#/components/schemas/Resource"
          description: "<p>Specifies the ICC profile which defines the CMYK color\
            \ space into or from which CSS colors and images are converted, if <code>conversionEnabled</code>.</p>"
        conversionEnabled:
          description: "<p>Enables the conversion of CSS colors and images to the\
            \ <code>targetColorSpace</code> using the <code>cmykIccProfileUrl</code>\
            \ or naively if there is none.</p>"
          type: "boolean"
        targetColorSpace:
          $ref: "#/components/schemas/ColorSpace"
          description: "<p>Specifies the target color-space of the PDF.</p> <p>This\
            \ is the color space, CSS keyword based colors are converted to, as well\
            \ as, if <code>conversionEnabled</code>, other CSS colors and images.</p>\
            \ <p>It also is the color space for PDF/A and PDF/X documents.</p> <p>Defaults\
            \ to <code>\"RGB RGB\"</code>.</p>"
    Configuration:
      properties:
        addAttachments:
          description: "<p>Enables or disables attachments specified in style sheets.</p>\
            \ <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        addBookmarks:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 11. Use <code>disableBookmarks</code>\
            \ instead.</p>"
          type: "boolean"
        addComments:
          description: "<p>Enables or disables comments in the PDF document.</p> <p>The\
            \ default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        addLinks:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 11. Use <code>disableLinks</code>\
            \ instead.</p>"
          type: "boolean"
        addOverprint:
          description: "<p>Enables or disables overprinting.</p> <p>The default value\
            \ is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        addPreviewImages:
          description: "<p>Enables or disables embedding of image previews per page\
            \ in the PDF document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        addTags:
          description: "<p>Enables or disables tagging of the PDF document.</p> <p>The\
            \ default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowAnnotations:
          description: "<p>Enables or disables the 'annotations' restriction in the\
            \ PDF document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowAssembly:
          description: "<p>Enables or disables the 'assembly' restriction in the PDF\
            \ document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowCopy:
          description: "<p>Enables or disables the 'copy' restriction in the PDF document.</p>\
            \ <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowDegradedPrinting:
          description: "<p>Enables or disables the 'degraded printing' restriction\
            \ in the PDF document.<p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowFillIn:
          description: "<p>Enables or disables the 'fill in' restriction in the PDF\
            \ document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowModifyContents:
          description: "<p>Enables or disables the 'modify contents' restriction in\
            \ the PDF document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowPrinting:
          description: "<p>Enables or disables the 'printing' restriction in the PDF\
            \ document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        allowScreenReaders:
          description: "<p>Enables or disables the 'screen readers' restriction in\
            \ the PDF document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        appendLog:
          description: "<p>Specifies whether or not the log data should be added to\
            \ the PDF document.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        attachments:
          description: "<p>Adds a file attachment to PDF document.</p>"
          items:
            $ref: "#/components/schemas/Attachment"
          type: "array"
        authenticationCredentials:
          $ref: "#/components/schemas/KeyValuePair"
          description: "<p>Enables access to resources that are secured via Basic\
            \ or Digest authentication.</p>"
        author:
          description: "<p>Sets the value of the author field of the PDF document.</p>"
          type: "string"
        baseURL:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 11. Use <code>baseUrl</code>\
            \ instead.</p>"
          type: "string"
        baseUrl:
          description: "<p>Sets the base URL of the document.</p> <p>To resolve relative\
            \ URLs to absolute URLs a reference (base) URL is required. This reference\
            \ URL is usually the system id of the document.</p> <p>This method can\
            \ be used to specify another reference URL. If this URL is not <code><span\
            \ class='null'>null</span></code> then it will be used instead of the\
            \ system id.</p> <p>The default value is <code><span class='null'>null</span></code>.</p>"
          type: "string"
        bookletMode:
          $ref: "#/components/schemas/BookletMode"
          description: "<p>Convenience method to set pages-per-sheet properties and\
            \ page order in one step to create a booklet.</p>"
        callbacks:
          description: "<p>Adds callbacks to the conversion which will be called at\
            \ specific times. All callbacks perform a POST request to the specified\
            \ URL with the specified content type and a certain model which depends\
            \ on the callback event.<p> <p>For each callback, you can specify a timeout.\
            \ If no timeout is specified, the server's default timeout for callbacks\
            \ is used. A value of zero or negative values indicate an infinite timeout,\
            \ however the PDFreactor server may have a maximum timeout configured,\
            \ in which case that will be the used value.</p> <p>Some callbacks might\
            \ be called regularly during the course of a conversion. For these callbacks\
            \ you can specify an interval to control how frequently they are called.</p>"
          items:
            $ref: "#/components/schemas/Callback"
          type: "array"
        cleanupTool:
          $ref: "#/components/schemas/Cleanup"
          description: "<p>Sets the cleanup tool to use for documents with unparsable\
            \ content.</p> <p>The <em>Cleanup</em> constants can be used as value.\
            \ The default value specified is <code>\"CYBERNEKO\"</code>.</p> <p>The\
            \ cleanup tool is only used for <code>documentType</code> <code>\"XHTML\"\
            </code>. HTML5 utilizes an internal cleanup.</p>"
        colorSpaceSettings:
          $ref: "#/components/schemas/ColorSpaceSettings"
          description: "<p>Specifies color space related settings.</p>"
        conformance:
          $ref: "#/components/schemas/Conformance"
          description: "<p>Sets the conformance of the PDF.</p> <p>The <em>Conformance</em>\
            \ constants can be used as value. The default value specified is <code>\"\
            PDF\"</code>.</p>"
        contentObserver:
          $ref: "#/components/schemas/ContentObserver"
          description: "<p>Specifies parts of the document's content that should be\
            \ observed and logged in greater detail. Data logged this way can be programmatically\
            \ retrieved after the conversion has finished. The following can be observed:</p>\
            \ <ul> <li> <p>Content exceeding boundary containers.</p> <p>Use <em>ExceedingContentAnalyze</em>\
            \ constants to specify which kind of content should be observed for exceeding\
            \ content logging. The default value is <code>\"NONE\"</code>.</p> <p>Use\
            \ <em>ExceedingContentAgainst</em> constants to specify that exceeding\
            \ this content starts exceeding content logging. The default value is\
            \ <code>\"NONE\"</code>.</p> </li> <li>Resources that could not be loaded.</li>\
            \ <li>URL connection attempts made by PDFreactor.</li> </ul>"
        continuousOutput:
          $ref: "#/components/schemas/ContinuousOutput"
          description: "<p>Enables the conversion of the input document into one image.</p>"
        conversionName:
          description: "<p>Sets a name for the conversion. If a name is set, it will\
            \ be logged at level \"info\". The name can be an arbitrary string but\
            \ should be unique for every conversion or application so that the log\
            \ output can be matched to a specific conversion or application later.</p>"
          type: "string"
        conversionTimeout:
          description: "<p>Sets a timeout in seconds for the whole document conversion.\
            \ If the timeout is exceeded, the conversion will be aborted.</p> <p>A\
            \ timeout of 0 or negative values mean that the conversion will never\
            \ time out. This is also the default behavior if no timeout is specified.</p>"
          type: "integer"
        cookies:
          description: "<p>Adds a cookie to all outgoing HTTP connections. The parameters\
            \ are URL encoded (see <code>rawCookies</code>). If the key already exists,\
            \ the pair is overwritten.</p>"
          items:
            $ref: "#/components/schemas/KeyValuePair"
          type: "array"
        creator:
          description: "<p>Sets the value of creator field of the PDF document.</p>"
          type: "string"
        cssSettings:
          $ref: "#/components/schemas/CssSettings"
          description: "<p> Specifies the behavior of PDFreactor regarding the support\
            \ and validation of CSS properties and their declaration. The following\
            \ modes can be set: </p> <ul> <li> Do not validate at all, consider all\
            \ declared style as valid. See <code>\"ALL\"</code> </li> <li>Validate\
            \ all declared styles for properties only supported by PDFreactor. Properties\
            \ only supported by third party products are not supported/taken as invalid.\
            \ See <code>\"HTML\"</code></li> <li>Validate all declared styles for\
            \ properties supported by PDFreactor. Properties only supported by third\
            \ party products are supported/taken as valid. See <code>\"HTML_THIRD_PARTY\"\
            </code></li> <li>All properties supported by third party products are\
            \ supported/taken as valid. All declared styles for properties not supported\
            \ by third party products but supported by PDFreactor will be validated.\
            \ See <code>\"HTML_THIRD_PARTY_LENIENT\"</code></li> </ul>"
        customDocumentProperties:
          description: "<p>Adds a custom property to the PDF document. An existing\
            \ property of the same name will be replaced.</p>"
          items:
            $ref: "#/components/schemas/KeyValuePair"
          type: "array"
        debugSettings:
          $ref: "#/components/schemas/DebugSettings"
          description: "<p>Enables and configures debug settings, which add additional\
            \ information to the output.</p> <p>If enabled, exceptions during the\
            \ conversion will not be thrown. In such a case, instead of a document\
            \ a string containing the log and exception will be returned.</p>"
        defaultColorSpace:
          $ref: "#/components/schemas/ColorSpace"
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 10. Use <code>colorSpaceSettings</code>\
            \ and <code>targetColorSpace</code> instead.</p>"
        disableBookmarks:
          description: "<p>Disables bookmarks in the PDF document.</p> The default\
            \ value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        disableFontEmbedding:
          description: "<p>Sets whether fonts will not be embedded into the resulting\
            \ PDF. Setting this to true will reduce the file size of the output document.\
            \ However, the resulting PDF documents are no longer guaranteed to look\
            \ identical on all systems.</p> <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        disableLinks:
          description: "<p>Disables links in the PDF document.</p> <p>The default\
            \ value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        document:
          description: "<p>The input document. This can either be a URL string, XML\
            \ or HTML source code string.</p>"
          oneOf:
          - format: "xml"
            type: "string"
          - format: "html"
            type: "string"
          - format: "url"
            type: "string"
        documentDefaultLanguage:
          description: "<p>Sets the language used for documents having no explicit\
            \ language attribute set.</p> <p>The language code is used to resolve\
            \ the lang() selector correct and to determine the correct language used\
            \ for hyphenation.</p>"
          type: "string"
        documentType:
          $ref: "#/components/schemas/Doctype"
          description: "<p>Sets the document type.</p> <p>The <em>Doctype</em> constants\
            \ can be used to specify the document type. The default value specified\
            \ is <code>\"AUTODETECT\"</code>. </p>"
        enableDebugMode:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 10. Use <code>debugSettings</code>\
            \ instead.</p>"
          type: "boolean"
        encoding:
          description: "<p>Sets the encoding of the document.</p> <p>If this value\
            \ is set to <code><span class='null'>null</span></code> or it is empty\
            \ then the encoding will be detected automatically.</p> <p>The default\
            \ value is <code><span class='null'>null</span></code>.</p>"
          type: "string"
        encryption:
          $ref: "#/components/schemas/Encryption"
          description: "<p>Sets the encryption.</p> <p>Use one of the <em>Encryption</em>\
            \ constants to specify the encryption. The default value is <code>\"NONE\"\
            </code>.</p>"
        errorPolicies:
          description: "<p>Specifies error policies that will be used for the conversion.\
            \ Depending on the policy, the conversion will fail if the appropriate\
            \ criteria are not met.</p>"
          items:
            $ref: "#/components/schemas/ErrorPolicy"
          type: "array"
        fontAliases:
          description: "<p>Registers an alias font family for an existing font.</p>\
            \ <p>This function is limited to fonts loaded automatically from system\
            \ folders.</p>"
          items:
            $ref: "#/components/schemas/Font"
          type: "array"
        fontFallback:
          description: "<p>Sets a list of fallback font families used for character\
            \ substitution. This list is iterated for characters that can not be displayed\
            \ with any of the fonts specified via the CSS property <code>font-family</code>.</p>"
          items:
            type: "string"
          type: "array"
        fonts:
          description: "<p>Loads a font from a URL which can be used via the CSS property\
            \ <code>font-family</code>.</p>"
          items:
            $ref: "#/components/schemas/Font"
          type: "array"
        forceGrayscaleImage:
          description: "<p>If the output format is an image format, this setting controls\
            \ whether a grayscale image should be returned. This can not be combined\
            \ with transparency.</p>"
          type: "boolean"
        fullCompression:
          description: "<p>Enables or disables full compression of the PDF document.</p>\
            \ <p>The default value is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        httpsMode:
          $ref: "#/components/schemas/HttpsMode"
          description: "<p>Sets the HTTPS mode. In closed environment lenient can\
            \ be the preferred setting to avoid HTTPS issues that are not security\
            \ critical</p> <p>The default value specified is <code>\"STRICT\"</code>.</p>"
        ignoreAlpha:
          description: "<p>Sets whether the alpha value of CSS RGBA colors is ignored.\
            \ This can be used to avoid conformance issues in PDF/A-1.</p>"
          type: "boolean"
        inspectableSettings:
          $ref: "#/components/schemas/InspectableSettings"
          description: "<p>When enabled, makes the converted document inspectable\
            \ with the PDFreactor Development Tools.</p> <p>Only works with <code>\"\
            PDF\"</code> output and requires a license key.</p>"
        integrationStyleSheets:
          description: "<p>Adds an integration style sheet to the document.</p> <p>There\
            \ are two ways to specify the style sheet:</p> <ol> <li>Specifying the\
            \ style sheet only using an URI.</li> <li>Specifying the style sheet by\
            \ the content of the style sheet and alternatively setting a URI to resolve\
            \ relative elements. If no URI is specified then the system id/base URL\
            \ of the document will be used.</li> </ol>"
          items:
            $ref: "#/components/schemas/Resource"
          type: "array"
        javaScriptMode:
          $ref: "#/components/schemas/JavaScriptMode"
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 10. Use <code>javaScriptSettings</code>\
            \ instead.</p>"
        javaScriptSettings:
          $ref: "#/components/schemas/JavaScriptSettings"
          description: "<p>Specifies JavaScript related settings.</p>"
        keepDocument:
          description: "<p>If set to <code><span class='boolean-true'>true</span></code>\
            \ prevents the document from being deleted from the PDFreactor Web Service\
            \ after it has been accessed. This only works for asynchronous conversions.</p>"
          type: "boolean"
        keywords:
          description: "<p>Sets the value of the keywords field of the PDF document.</p>"
          type: "string"
        licenseKey:
          description: "<p>Sets the license key either as content or URL. If the license\
            \ key is set to <code><span class='null'>null</span></code> then PDFreactor\
            \ looks for a license key file file in the same directory where the 'pdfreactor.jar'\
            \ file is located. If no license key could be found then PDFreactor runs\
            \ in evaluation mode.</p> <p>The default value is <code><span class='null'>null</span></code>.</p>"
          type: "string"
        logExceedingContent:
          $ref: "#/components/schemas/LogExceedingContent"
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 9. Use <code>contentObserver</code>\
            \ instead.</p>"
        logLevel:
          $ref: "#/components/schemas/LogLevel"
          description: "<p>Sets the log level for the conversion log.</p> <p>Use one\
            \ of the <em>LogLevel</em> constants to specify the log level.</p> <p>The\
            \ default value is <code>\"INFO\"</code>.</p>"
        logMaxLines:
          description: "<p>Sets the maximum amount of log entries that will be retained\
            \ by the PDFreactor logs.</p> <p>The default value is 100000.</p> <p>A\
            \ capacity of 0 is equivalent to the default value. A negative value means\
            \ that the capacity will be unlimited."
          type: "integer"
        mediaFeatureValues:
          description: "<p>Defines the value of a Media Feature which is used to resolve\
            \ CSS3 media queries.</p>"
          items:
            $ref: "#/components/schemas/MediaFeatureValue"
          type: "array"
        mediaTypes:
          description: "<p>Sets the media types that are used to resolve CSS3 media\
            \ queries.</p> <p>Please note that this overrides the default media types\
            \ of PDFreactor, which are: </p> <p><code>\"print\"</code>, <code>\"paged\"\
            </code>, <code>\"visual\"</code>, <code>\"bitmap\"</code>, <code>\"static\"\
            </code>, <code>\"-ro-pdfreactor\"</code></p>"
          items:
            type: "string"
          type: "array"
        mergeByteArray:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 9. Use <code>mergeDocuments</code>\
            \ instead.</p>"
          format: "base64"
          type: "string"
        mergeByteArrays:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 9. Use <code>mergeDocuments</code>\
            \ instead.</p>"
          items:
            format: "base64"
            type: "string"
          type: "array"
        mergeDocuments:
          description: "<p>This method sets external PDF documents which will be merged\
            \ with the PDF document generated by the HTML source.</p>"
          items:
            $ref: "#/components/schemas/Resource"
          type: "array"
        mergeMode:
          $ref: "#/components/schemas/MergeMode"
          description: "<p>Sets the merge mode.<p> <p>The following merge methods\
            \ can be used:</p> <ul> <li>append (<code>\"APPEND\"</code>)</li> <li>prepend\
            \ (<code>\"PREPEND\"</code>)</li> <li>overlay above the content of the\
            \ generated PDF (<code>\"OVERLAY\"</code>)</li> <li>overlay below the\
            \ content of the generated PDF (<code>\"OVERLAY_BELOW\"</code>)</li> </ul>\
            \ <p>The default value is <code>\"APPEND\"</code>.</p>"
        mergeURL:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 9. Use <code>mergeDocuments</code>\
            \ instead.</p>"
          type: "string"
        mergeURLs:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 9. Use <code>mergeDocuments</code>\
            \ instead.</p>"
          items:
            type: "string"
          type: "array"
        outputFormat:
          $ref: "#/components/schemas/OutputFormat"
          description: "<p>Sets the <em>OutputFormat</em>. If not specified, a PDF\
            \ output format will be used.</p> <p>For image formats the width or height\
            \ in pixels must be specified.</p> <p>When either dimension is <1 it is\
            \ computed based on the other dimension and the aspect ratio of the input\
            \ document.</p>"
        outputIntent:
          $ref: "#/components/schemas/OutputIntent"
          description: "<p>Sets the output intent including the identifier and the\
            \ ICC profile to be embedded into the PDF.</p> <p>Set either the profile\
            \ URL or the profile data, not both. Certain PDF/X formats require neither,\
            \ just a known identifier.</p>"
        overlayRepeat:
          $ref: "#/components/schemas/OverlayRepeat"
          description: "<p>If one of the documents of an overlay process is shorter\
            \ than the other, this method allows repeating either its last page or\
            \ all of its pages in order to overlay all pages of the longer document.</p>\
            \ <p>Use one of the <em>OverlayRepeat</em> constants to specify the overlay\
            \ repeat. The default value is <code>\"NONE\"</code>.</p>"
        ownerPassword:
          description: "<p>Sets the owner password of the PDF document.</p> <p>The\
            \ default value is <code><span class='null'>null</span></code>.</p>"
          type: "string"
        pageOrder:
          description: "<p>Sets the page order of the direct result of the conversion.</p>\
            \ <p>If <code>mergeMode</code> is set to <code>\"ARRANGE\"</code>, this\
            \ method is also used to specify the position of inserted pages from an\
            \ existing PDF.</p> <p>A description of the syntax can be found in the\
            \ manual.</p>"
          oneOf:
          - $ref: "#/components/schemas/PageOrder"
          - type: "string"
        pagesPerSheetProperties:
          $ref: "#/components/schemas/PagesPerSheetProperties"
          description: "<p>Sets the properties of a sheet on which multiple pages\
            \ are being arranged.</p> <p>If <code>cols</code> or <code>rows</code>\
            \ is less than 1, no pages-per-sheet processing is done. This is the case\
            \ by default. </p> <p>Use one of the <em>PagesPerSheetDirection</em> constants\
            \ to specify the the direction. The default value is <code>\"RIGHT_DOWN\"\
            </code>.</p>"
        pdfScriptAction:
          description: "<p>Sets a pair of trigger event and PDF script. The script\
            \ is triggered on the specified event.</p> <p>A PDF script is JavaScript\
            \ that is executed by a PDF viewer (e.g. Adobe Reader). Note that most\
            \ viewers do not support this feature.</p> <p>PDF Scripts can also be\
            \ set by using the proprietary CSS property <code>pdf-script-action</code>.\
            \ More information on this property can be found in the manual.</p> <p>Please\
            \ note, that scripts set via CSS have a higher priority. If two scripts\
            \ are registered on the same event, but one via API and the other via\
            \ the CSS property, the script set in the CSS will override the other\
            \ one.</p>"
          items:
            $ref: "#/components/schemas/PdfScriptAction"
          type: "array"
        pixelsPerInch:
          description: "<p>Sets the pixels per inch.</p> <p>Changing this value changes\
            \ the physical length of sizes specified in px (including those specified\
            \ via HTML attributes).</p> <p>The default value is <code>96</code> ppi.</p>"
          type: "integer"
        pixelsPerInchShrinkToFit:
          description: "<p>Whether the pixels per inch should be adapted automatically\
            \ to avoid content exceeding pages.</p>"
          type: "boolean"
        postTransformationDocumentType:
          $ref: "#/components/schemas/Doctype"
          description: "<p>Sets the document type after the XSL-Transformations have\
            \ been applied.</p> <p>The <em>Doctype</em> constants can be used to specify\
            \ the document type. The default value specified is <code>\"AUTODETECT\"\
            </code>.</p>"
        printDialogPrompt:
          description: "<p>Enables or disables a print dialog to be shown upon opening\
            \ the generated PDF document by a PDF viewer.</p> <p>The default value\
            \ is <code><span class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        processingPreferences:
          description: "<p>Preferences that influence the conversion process without\
            \ changing the output.</p> <p>Use the <em>ProcessingPreferences</em> constants\
            \ to specify the processing preferences. By default no processing preference\
            \ is set.</p>"
          items:
            $ref: "#/components/schemas/ProcessingPreferences"
          type: "array"
        quirksSettings:
          $ref: "#/components/schemas/QuirksSettings"
          description: "<p>Allows to enable or disable behaviors that are otherwise\
            \ depend on the doctype of the input document.</p>"
        rawCookies:
          description: "<p>Adds a cookie to all outgoing HTTP connections. The parameters\
            \ are not URL encoded (see <code>cookies</code>). If the key already exists,\
            \ the pair is overwritten.</p>"
          items:
            $ref: "#/components/schemas/KeyValuePair"
          type: "array"
        requestHeaders:
          description: "<p>Adds a request header to all outgoing HTTP connections.\
            \ If the key already exists, the pair is overwritten.</p>"
          items:
            $ref: "#/components/schemas/KeyValuePair"
          type: "array"
        requestPriority:
          description: "<p>Specifies the priority of the conversion request. A higher\
            \ priority means that the web service will adjust the conversion's position\
            \ in the queue appropriately, so that it is converted before others with\
            \ lower priority.</p> <p>By default, asynchronous conversions have a priority\
            \ of 0, synchronous conversions have a priority of 10.</p>"
          type: "integer"
        resourceConnectTimeout:
          description: "<p>Sets a timeout in milliseconds for connecting to resources,\
            \ such as HTTP requests to style sheets, images etc. If the connection\
            \ could not be established until the timeout expires, the request will\
            \ be aborted and the resource will not be loaded.</p> <p>A timeout of\
            \ 0 means that the connection will not time out. A negative value means\
            \ that no timeout will be set. The default value is 60000 (1min).</p>"
          type: "integer"
        resourceReadTimeout:
          description: "<p>Sets a timeout in milliseconds for reading resources, such\
            \ as HTTP requests to style sheets, images etc. If the download does not\
            \ start until the timeout expires, the request will be aborted and the\
            \ resource will not be loaded.</p> <p>A timeout of 0 means that the download\
            \ will not time out. A negative value means that no timeout will be set.\
            \ The default value is 60000 (1min).</p>"
          type: "integer"
        resourceRequestTimeout:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 10. Use <code>resourceConnectTimeout</code>\
            \ and <code>resourceReadTimeout</code> instead.</p>"
          type: "integer"
        segmentationSettings:
          $ref: "#/components/schemas/SegmentationSettings"
          description: "<p>This property configures segmentation of the conversion,\
            \ which helps with very large documents.</p>"
        signPDF:
          $ref: "#/components/schemas/SignPDF"
          description: "<p>Sets a digital certificate to sign the newly created PDF.</p>\
            \ <p>Requires a keystore file. The included certificate may be self-signed.</p>\
            \ <p>Use the <em>KeystoreType</em> constants to specify the keystore type.</p>\
            \ <p>Use the <em>SigningMode</em> constants to specify the cryptographic\
            \ filter that is used for signing.</p>"
        subject:
          description: "<p>Sets the value of the subject field of the PDF document.</p>"
          type: "string"
        throwLicenseExceptions:
          deprecated: true
          description: "<p>Deprecated as of PDFreactor 9. Use <code>errorPolicies</code>\
            \ instead.</p>"
          type: "boolean"
        title:
          description: "<p>Sets the value of the title field of the PDF document.</p>"
          type: "string"
        urlRewriteSettings:
          $ref: "#/components/schemas/UrlRewriteSettings"
          description: "<p>Specifies settings for URL rewrites, which will transform\
            \ URLs into others according to certain rules.</p>"
        userPassword:
          description: "<p>Sets the user password of the PDF document.</p> <p>The\
            \ default value is <code><span class='null'>null</span></code>.</p>"
          type: "string"
        userScripts:
          description: "<p>Adds an user script to the document.</p> <p>There are two\
            \ ways to specify the script:</p> <ol> <li>Specifying the script only\
            \ by an URI.</li> <li>Specifying the script by the content of the script\
            \ and alternatively setting a URI to resolve relative elements. If no\
            \ URI is specified then the system id/base URL of the document will be\
            \ used.</li> </ol>"
          items:
            $ref: "#/components/schemas/Resource"
          type: "array"
        userStyleSheets:
          description: "<p>Adds a user style sheet to the document.</p> <p>There are\
            \ two ways to specify the style sheet:</p> <ol> <li>Specifying the style\
            \ sheet only using an URI.</li> <li>Specifying the style sheet by the\
            \ content of the style sheet and alternatively setting a URI to resolve\
            \ relative elements. If no URI is specified then the system id/base URL\
            \ of the document will be used.</li> </ol>"
          items:
            $ref: "#/components/schemas/Resource"
          type: "array"
        validateConformance:
          description: "<p>Enables PDFreactor to validate the generated PDF against\
            \ the <em>Conformance</em> specified via <code>conformance</code>.</p>\
            \ <p>Currently only PDF/A and PDF/UA validation is supported.</p> <p>Please\
            \ note that validation might take several minutes for larger documents.</p>"
          type: "boolean"
        viewerPreferences:
          description: "<p>Sets the page layout and page mode preferences of the PDF.</p>\
            \ <p>Use the <em>ViewerPreferences</em> constants to specify the viewer\
            \ preferences. By default no viewer preference is set.</p>"
          items:
            $ref: "#/components/schemas/ViewerPreferences"
          type: "array"
        xmp:
          $ref: "#/components/schemas/Xmp"
          description: "<p>Sets custom XMP to be embedded into the PDF document.</p>\
            \ <p>If both <code>content</code> and <code>uri</code> are not set or\
            \ <code><span class='null'>null</span></code> no custom XMP is embedded.\
            \ If <em>XmpPriority</em> is also set to <code>\"HIGH\"</code> automatic\
            \ generation of required XMP is also suppressed. <i>This may cause output\
            \ PDFs to not achieve a specified conformance.</i>"
        xsltMode:
          description: "<p>Enables or disables XSLT transformations.</p> <p>Set this\
            \ value to <code><span class='boolean-true'>true</span></code> to enable\
            \ XSLT transformations or to <code><span class='boolean-false'>false</span></code>\
            \ to disable XSLT transformations.</p> <p>The default value is <code><span\
            \ class='boolean-false'>false</span></code>.</p>"
          type: "boolean"
        xsltStyleSheets:
          description: "<p>Adds an XSLT style sheet to the document.</p> <p>There\
            \ are two ways to specify the style sheet:</p> <ol> <li>Specifying the\
            \ style sheet only by an URI.</li> <li>Specifying the style sheet by the\
            \ content of the style sheet and alternatively setting a URI to resolve\
            \ relative elements. If no URI is specified then the system id/base URL\
            \ of the document will be used. </li> </ol>"
          items:
            $ref: "#/components/schemas/Resource"
          type: "array"
      required:
      - "document"
    Conformance:
      enum:
      - "PDF"
      - "PDFA1A"
      - "PDFA1A_PDFUA1"
      - "PDFA1B"
      - "PDFA2A"
      - "PDFA2A_PDFUA1"
      - "PDFA2B"
      - "PDFA2U"
      - "PDFA3A"
      - "PDFA3A_PDFUA1"
      - "PDFA3B"
      - "PDFA3U"
      - "PDFUA1"
      - "PDFX1A_2001"
      - "PDFX1A_2003"
      - "PDFX3_2002"
      - "PDFX3_2003"
      - "PDFX4"
      - "PDFX4P"
      type: "string"
    Connection:
      properties:
        cached:
          description: "<p>Whether the response was retrieved from a cache.</p>"
          type: "boolean"
        connected:
          description: "<p>Whether a URL connection could be established by PDFreactor.\
            \ If this is <code><span class='boolean-false'>false</span></code>, see\
            \ <code>error</code> for details.</p>"
          type: "boolean"
        contentSize:
          description: "<p>The amount of content bytes downloaded or read from this\
            \ connection.</p>"
          type: "integer"
        duration:
          description: "<p>The duration in milliseconds how long this connection remained\
            \ open.</p>"
          type: "integer"
        error:
          description: "<p>The error message if the connection could not be established.</p>"
          type: "string"
        method:
          description: "<p>The request method used by the underlying HTTP request\
            \ (like \"GET\", \"POST\", etc.) or <code><span class='null'>null</span></code>\
            \ if this is not an HTTP connection or the connection could not be established.</p>"
          type: "string"
        protocol:
          description: "<p>The protocol of the URL connection.</p>"
          type: "string"
        requestContentSize:
          description: "<p>The amount of content bytes uploaded or written to this\
            \ connection.</p>"
          type: "integer"
        requestHeaders:
          description: "<p>The request headers.</p> <p>Note: If a header has multiple\
            \ values, there will be one <em>KeyValuePair</em> for each value with\
            \ the header name as key.</p>"
          items:
            $ref: "#/components/schemas/KeyValuePair"
          type: "array"
        resourceType:
          $ref: "#/components/schemas/ResourceType"
          description: "<p>The type of resource (style sheet, image, etc.) transferred\
            \ over this connection.</p>"
        responseHeaders:
          description: "<p>The response headers.</p> <p>Note: If a header has multiple\
            \ values, there will be one <em>KeyValuePair</em> for each value with\
            \ the header name as key.</p>"
          items:
            $ref: "#/components/schemas/KeyValuePair"
          type: "array"
        statusCode:
          description: "<p>The response code for HTTP connections or 0 for all other\
            \ connections.</p>"
          type: "integer"
        statusMessage:
          description: "<p>The response message for the response code or <code><span\
            \ class='null'>null</span></code> if the response code is 0 or the message\
            \ could not be determined.</p>"
          type: "string"
        timestamp:
          description: "<p>The time stamp of this connection.</p>"
          type: "integer"
        url:
          description: "<p>The URL.</p>"
          format: "url"
          type: "string"
    ConnectionRuleAction:
      enum:
      - "ALLOW"
      - "DENY"
      type: "string"
    ConnectionSettings:
      properties:
        cookies:
          description: "A collection of name-value-pairs representing the cookies\
            \ that will be added to the HTTP request to the PDFreactor Web Service.\
            \ This property is empty by default and additional cookies can be added\
            \ as required. Cookies should only be added in special environments where\
            \ it is necessary, e.g. when using a load balancer. If the PDFreactor\
            \ Web Service's response contains any cookies, they will be added to this\
            \ property, potentially overwriting cookies with the same name."
          items:
            type: "string"
          type: "array"
        headers:
          description: "A collection of name-value-pairs representing the request\
            \ headers that will be added to the HTTP request to the PDFreactor Web\
            \ Service. This property is empty by default and additional headers can\
            \ be added as required. Headers should only be added in special environments\
            \ where it is necessary."
          items:
            type: "string"
          type: "array"
    ContentObserver:
      properties:
        connections:
          description: "<p>Enables observation of URL connections done by PDFreactor.</p>"
          type: "boolean"
        exceedingContentAgainst:
          $ref: "#/components/schemas/ExceedingContentAgainst"
          description: "<p>Enables observation of exceeding content either against\
            \ the page edges, page content areas or containers.</p>"
        exceedingContentAnalyze:
          $ref: "#/components/schemas/ExceedingContentAnalyze"
          description: "<p>Enables observation of exceeding content and optionally\
            \ of boxes.</p>"
        missingResources:
          description: "<p>Enables observation of resources that could not be loaded.</p>"
          type: "boolean"
    ContentType:
      enum:
      - "BINARY"
      - "BMP"
      - "GIF"
      - "HTML"
      - "JPEG"
      - "JSON"
      - "NONE"
      - "PDF"
      - "PNG"
      - "TEXT"
      - "TIFF"
      - "XML"
      type: "string"
    ContinuousOutput:
      properties:
        height:
          description: "<p>Equivalent to the height of a browser window (view port).\
            \ For values <1 the entire height of the document is used.</p>"
          type: "integer"
        width:
          description: "<p>Equivalent to the width of a browser window (view port).\
            \ Values <1 enable paginated output.</p>"
          type: "integer"
    CssPropertySupport:
      enum:
      - "ALL"
      - "HTML"
      - "HTML_THIRD_PARTY"
      - "HTML_THIRD_PARTY_LENIENT"
      type: "string"
    CssSettings:
      properties:
        supportQueryMode:
          $ref: "#/components/schemas/CssPropertySupport"
          description: "<p>Adjusts the CSS property support behavior.</p>"
        validationMode:
          $ref: "#/components/schemas/CssPropertySupport"
          description: "<p>Adjusts the CSS property validation behavior.</p>"
    DebugSettings:
      properties:
        all:
          description: "<p>This is a convenience property that enables the following\
            \ <em>DebugSettings</em>:</p> <ul> <li><code>attachDocuments</code>,</li>\
            \ <li><code>attachResources</code>,</li> <li><code>attachLogs</code>,</li>\
            \ <li><code>appendLogs</code>,</li> <li><code>forceResult</code></li>\
            \ </ul>"
          type: "boolean"
        appendLogs:
          description: "<p>Specifies whether the logs will be appended to the resulting\
            \ PDF.</p>"
          type: "boolean"
        attachConfiguration:
          description: "<p>Specifies whether the configuration will be attached to\
            \ the generated PDF.</p>"
          type: "boolean"
        attachDocuments:
          description: "<p>Specifies whether all debug files belonging to the group\
            \ \"documents\" will be attached to the generated PDF. Please see the\
            \ manual for more information.</p>"
          type: "boolean"
        attachLogs:
          description: "<p>Specifies whether all debug files belonging to the group\
            \ \"logs\" will be attached to the generated PDF. Please see the manual\
            \ for more information.</p>"
          type: "boolean"
        attachResources:
          description: "<p>Specifies whether all debug files belonging to the group\
            \ \"resources\" will be attached to the generated PDF. Please see the\
            \ manual for more information.</p>"
          type: "boolean"
        forceResult:
          description: "<p>Forces PDFreactor to return a result, regardless of any\
            \ exceptions or errors that may have occurred during the conversion.</p>\
            \ <p>If an exception or error occurred during the conversion, its stack\
            \ trace and the PDFreactor log is written as-is into the result data stream.\
            \ This means that the resulting document will not be a valid PDF but can\
            \ be opened with an appropriate text editor to view the log and errors.</p>"
          type: "boolean"
    Doctype:
      enum:
      - "AUTODETECT"
      - "HTML5"
      - "XHTML"
      - "XML"
      type: "string"
    Document:
      properties:
        id:
          description: "The document ID."
          type: "string"
        name:
          description: "The file name representing the document in the ZIP. If the\
            \ document is a multi-image, you can use the '#' character in the file\
            \ name as a placeholder for the page number."
          type: "string"
    Encryption:
      enum:
      - "NONE"
      - "TYPE_128"
      - "TYPE_40"
      type: "string"
    ErrorPolicy:
      enum:
      - "CONFORMANCE_VALIDATION_UNAVAILABLE"
      - "LICENSE"
      - "MISSING_RESOURCE"
      - "UNCAUGHT_JAVASCRIPT_EXCEPTION"
      type: "string"
    ExceedingContent:
      properties:
        bottom:
          description: "<p>Returns whether the content exceeds the page at the bottom.</p>"
          type: "boolean"
        box:
          description: "<p>Returns whether the exceeding content is a box instead\
            \ of text or image content.</p>"
          type: "boolean"
        containerBottom:
          description: "<p>Returns the bottom coordinate of the the container box\
            \ in the page in pixels. Depending on the settings this box may be the\
            \ page.</p>"
          type: "integer"
        containerLeft:
          description: "<p>Returns the left coordinate of the the container box in\
            \ the page in pixels. Depending on the settings this box may be the page.</p>"
          type: "integer"
        containerRight:
          description: "<p>Returns the right coordinate of the the container box in\
            \ the page in pixels. Depending on the settings this box may be the page.</p>"
          type: "integer"
        containerTop:
          description: "<p>Returns the top coordinate of the the container box in\
            \ the page in pixels. Depending on the settings this box may be the page.</p>"
          type: "integer"
        description:
          description: "<p>Returns a description of the content. In case of text content,\
            \ the text is returned. In case of images the URL is returned if available.</p>"
          type: "string"
        exceedingBoxBottom:
          description: "<p>Returns the bottom coordinate of the the exceeding box\
            \ in the page in pixels.</p>"
          type: "integer"
        exceedingBoxLeft:
          description: "<p>Returns the left coordinate of the the exceeding box in\
            \ the page in pixels.</p>"
          type: "integer"
        exceedingBoxRight:
          description: "<p>Returns the right coordinate of the the exceeding box in\
            \ the page in pixels.</p>"
          type: "integer"
        exceedingBoxTop:
          description: "<p>Returns the top coordinate of the the exceeding box in\
            \ the page in pixels.</p>"
          type: "integer"
        html:
          description: "<p>Returns the HTML of the box that contains the exceeding\
            \ content.</p>"
          type: "string"
        left:
          description: "<p>Returns whether the content exceeds the page to the left.</p>"
          type: "boolean"
        pageBottom:
          description: "<p>Returns the bottom coordinate of the the page in pixels.</p>"
          type: "integer"
        pageLeft:
          description: "<p>Returns the left coordinate of the the page in pixels.</p>"
          type: "integer"
        pageNumber:
          description: "<p>Returns the number of the page that contains the exceeding\
            \ content.</p>"
          type: "integer"
        pageRight:
          description: "<p>Returns the right coordinate of the the page in pixels.</p>"
          type: "integer"
        pageTop:
          description: "<p>Returns the top coordinate of the the page in pixels.</p>"
          type: "integer"
        path:
          description: "<p>Returns an array of integers denoting the indexes of the\
            \ ancestors of the DOM node corresponding to the box containing the exceeding\
            \ content, starting from below the root node down to the element itself.</p>"
          items:
            type: "integer"
          type: "array"
        right:
          description: "<p>Returns whether the content exceeds the page to the right.</p>"
          type: "boolean"
        summary:
          description: "<p>Returns a summary of this exceeding content object.</p>"
          type: "string"
        top:
          description: "<p>Returns whether the content exceeds the page at the top.</p>"
          type: "boolean"
    ExceedingContentAgainst:
      enum:
      - "NONE"
      - "PAGE_BORDERS"
      - "PAGE_CONTENT"
      - "PARENT"
      type: "string"
    ExceedingContentAnalyze:
      enum:
      - "CONTENT"
      - "CONTENT_AND_BOXES"
      - "CONTENT_AND_STATIC_BOXES"
      - "NONE"
      type: "string"
    Font:
      properties:
        bold:
          description: "<p>Whether the alias will be labeled bold.</p>"
          type: "boolean"
        family:
          description: "<p>The alias name for that font.</p>"
          type: "string"
        italic:
          description: "<p>Whether the alias will be labeled italic.</p>"
          type: "boolean"
        source:
          description: "<p>The source URL of the font (when adding new fonts) or the\
            \ name of an existing font family (when creating an alias).</p>"
          type: "string"
    HttpsMode:
      enum:
      - "LENIENT"
      - "STRICT"
      type: "string"
    InspectableSettings:
      properties:
        enabled:
          description: "<p>Specifies whether to make the document inspectable.</p>"
          type: "boolean"
        endPage:
          description: "<p>Specifies an optional page number below which the DOM is\
            \ not inspected.</p> <p>Page numbers start at 1. The default 0 goes up\
            \ the last page. Other values are inclusive.</p>"
          type: "integer"
        startPage:
          description: "<p>Specifies an optional page number below which the DOM is\
            \ not inspected.</p> <p>Page numbers start at 1. The default 0 starts\
            \ at the first page.</p>"
          type: "integer"
    JavaScriptDebugMode:
      enum:
      - "EXCEPTIONS"
      - "FUNCTIONS"
      - "LINES"
      - "NONE"
      - "POSITIONS"
      type: "string"
    JavaScriptMode:
      enum:
      - "DISABLED"
      - "ENABLED"
      - "ENABLED_NO_LAYOUT"
      - "ENABLED_REAL_TIME"
      - "ENABLED_TIME_LAPSE"
      type: "string"
    JavaScriptSettings:
      properties:
        debugIndentation:
          description: "<p>Specifies the amount of spaces per indentation level when\
            \ using JavaScript debugging.</p> <p>The default value is 0.</p>"
          type: "integer"
        debugMode:
          $ref: "#/components/schemas/JavaScriptDebugMode"
          description: "<p>Specifies the debug mode.</p> <p>Any other value than the\
            \ default <code>\"NONE\"</code> impacts performance significantly and\
            \ should not be used in production.</p>"
        enabled:
          description: "<p>Specifies whether to process JavaScript.</p>"
          type: "boolean"
        ignoreScriptElements:
          description: "<p>Specifies whether to ignore <script> elements in the document,\
            \ only executing user scripts.</p>"
          type: "boolean"
        maxQueuedTasks:
          description: "<p>Specifies the maximum amount of tasks to be queued before\
            \ ending JavaScript processing.</p> <p>Values smaller than 1 default to\
            \ 1,000,000.</p>"
          type: "integer"
        maxScriptElements:
          description: "<p>Specifies the maximum amount of script elements in the\
            \ document to process.</p> <p>Values smaller than 1 default to 1,000,000.</p>"
          type: "integer"
        maxTasksWithoutDomChange:
          description: "<p>Specifies the maximum amount of tasks to be allowed to\
            \ be queued, while the DOM does not change, before ending JavaScript processing.</p>\
            \ <p>Values smaller than 1 default to 1,000.</p>"
          type: "integer"
        maxVirtualTimeOffset:
          description: "<p>Specifies the maximum amount of virtual time in seconds\
            \ to let pass before ending JavaScript processing.</p> <p>Values smaller\
            \ than 1 default to 3600 (1h).</p>"
          type: "integer"
        noLayout:
          description: "<p>Specifies whether to process JavaScript without causing\
            \ document layouts or updates.</p> <p>This can speed up conversions, but\
            \ will break a significant amount of functionality and libraries.</p>"
          type: "boolean"
        noVirtualTime:
          description: "<p>Specifies whether not to use virtual time for JavaScript.</p>\
            \ <p>Only use if required for a specific library.</p>"
          type: "boolean"
        timeLapse:
          description: "<p>Specifies whether to fast-forward the virtual time of JavaScript\
            \ every time it is retrieved.</p> <p>Only use if required for a specific\
            \ library.</p>"
          type: "boolean"
        timeout:
          description: "<p>Sets a timeout in seconds for JavaScript processing If\
            \ the timeout is exceeded, the conversion will be aborted.</p> <p>A timeout\
            \ of 0 or negative values mean that the conversion will never time out.\
            \ This is also the default behavior if no timeout is specified.</p>"
          type: "integer"
    KeyValuePair:
      properties:
        key:
          description: "<p>The key.</p>"
          type: "string"
        value:
          description: "<p>The value.</p>"
          type: "string"
    KeystoreType:
      enum:
      - "JKS"
      - "PKCS12"
      type: "string"
    Log:
      properties:
        records:
          description: "The log records of the main PDFreactor log."
          items:
            $ref: "#/components/schemas/Record"
          type: "array"
        recordsCss:
          description: "The log records of the PDFreactor CSS log."
          items:
            $ref: "#/components/schemas/Record"
          type: "array"
        recordsJavaScript:
          description: "The log records of the PDFreactor JavaScript log."
          items:
            $ref: "#/components/schemas/Record"
          type: "array"
    LogExceedingContent:
      properties:
        logExceedingContentAgainst:
          $ref: "#/components/schemas/ExceedingContentAgainst"
          description: "<p>Enables logging of exceeding content either against the\
            \ page edges, page content areas or containers.</p>"
        logExceedingContentAnalyze:
          $ref: "#/components/schemas/ExceedingContentAnalyze"
          description: "<p>Enables logging of exceeding content and optionally of\
            \ boxes.</p>"
    LogLevel:
      enum:
      - "DEBUG"
      - "FATAL"
      - "INFO"
      - "NONE"
      - "PERFORMANCE"
      - "WARN"
      type: "string"
    MediaFeature:
      enum:
      - "ASPECT_RATIO"
      - "COLOR"
      - "COLOR_INDEX"
      - "DEVICE_ASPECT_RATIO"
      - "DEVICE_HEIGHT"
      - "DEVICE_WIDTH"
      - "GRID"
      - "HEIGHT"
      - "MONOCHROME"
      - "ORIENTATION"
      - "RESOLUTION"
      - "WIDTH"
      type: "string"
    MediaFeatureValue:
      properties:
        mediaFeature:
          $ref: "#/components/schemas/MediaFeature"
          description: "<p>The media feature.</p>"
        value:
          description: "<p>The value that is associated with the given media feature.</p>"
          type: "string"
    MergeMode:
      enum:
      - "APPEND"
      - "ARRANGE"
      - "OVERLAY"
      - "OVERLAY_BELOW"
      - "PREPEND"
      type: "string"
    MissingResource:
      properties:
        message:
          description: "<p>The message indicating why the resource could not be found.</p>"
          type: "string"
        resource:
          description: "<p>The resource identifier. Usually a URL string.</p>"
          type: "string"
        type:
          $ref: "#/components/schemas/ResourceType"
          description: "<p>The type of resource (style sheet, image, etc.).</p>"
    OutputFormat:
      properties:
        height:
          description: "<p>The height of the output in pixels (image formats only).\
            \ Values <1 will be computed based on the specified width and the aspect\
            \ ratio of the input document.</p>"
          type: "integer"
        multiImage:
          description: "<p>Indicates whether the image output will be paginated into\
            \ multiple images.</p>"
          type: "boolean"
        pixelDensity:
          description: "<p>The pixel density of the output (image formats only). When\
            \ neither 'width' nor 'height' is specified this is used to determine\
            \ the dimensions of the image from the page size. Values <1 default to\
            \ 96dpi.</p>"
          type: "integer"
        pixelDensityUnit:
          $ref: "#/components/schemas/ResolutionUnit"
          description: "<p>The unit of the pixel density. Defaults to dpi.</p>"
        type:
          $ref: "#/components/schemas/OutputType"
          description: "<p>The output format. See <em>OutputType</em> constants. Defaults\
            \ to <code>\"PDF\"</code>.</p>"
        width:
          description: "<p>The with of the output in pixels (image formats only).\
            \ Values <1 will be computed based on the specified height and the aspect\
            \ ratio of the input document.</p>"
          type: "integer"
    OutputIntent:
      properties:
        data:
          description: "<p>The profile data.</p>"
          format: "base64"
          type: "string"
        identifier:
          description: "<p>The identifier.</p>"
          oneOf:
          - $ref: "#/components/schemas/OutputIntentDefaultProfile"
          - type: "string"
        url:
          description: "<p>The profile URL.</p>"
          format: "url"
          type: "string"
    OutputIntentDefaultProfile:
      enum:
      - "FOGRA39"
      - "GRACOL"
      - "IFRA"
      - "JAPAN"
      - "JAPAN_NEWSPAPER"
      - "JAPAN_UNCOATED"
      - "JAPAN_WEB"
      - "SWOP"
      - "SWOP_3"
      type: "string"
    OutputType:
      enum:
      - "BMP"
      - "GIF"
      - "GIF_DITHERED"
      - "JPEG"
      - "PDF"
      - "PNG"
      - "PNG_AI"
      - "PNG_TRANSPARENT"
      - "PNG_TRANSPARENT_AI"
      - "TIFF_CCITT_1D"
      - "TIFF_CCITT_1D_DITHERED"
      - "TIFF_CCITT_GROUP_3"
      - "TIFF_CCITT_GROUP_3_DITHERED"
      - "TIFF_CCITT_GROUP_4"
      - "TIFF_CCITT_GROUP_4_DITHERED"
      - "TIFF_LZW"
      - "TIFF_PACKBITS"
      - "TIFF_UNCOMPRESSED"
      type: "string"
    OverlayRepeat:
      enum:
      - "ALL_PAGES"
      - "LAST_PAGE"
      - "NONE"
      - "TRIM"
      type: "string"
    PageOrder:
      enum:
      - "BOOKLET"
      - "BOOKLET_RTL"
      - "EVEN"
      - "ODD"
      - "REVERSE"
      type: "string"
    PagesPerSheetDirection:
      enum:
      - "DOWN_LEFT"
      - "DOWN_RIGHT"
      - "LEFT_DOWN"
      - "LEFT_UP"
      - "RIGHT_DOWN"
      - "RIGHT_UP"
      - "UP_LEFT"
      - "UP_RIGHT"
      type: "string"
    PagesPerSheetProperties:
      properties:
        cols:
          description: "<p>The number of columns per sheet.</p>"
          type: "integer"
        direction:
          $ref: "#/components/schemas/PagesPerSheetDirection"
          description: "<p>The direction in which the pages are ordered on a sheet.</p>"
        rows:
          description: "<p>The number of rows per sheet.</p>"
          type: "integer"
        sheetMargin:
          description: "<p>The sheet margin as CSS margin, for example <code>\"1in\"\
            </code>, <code>\"1cm 1.5cm\"</code> or <code>\"10mm 20mm 10mm 30mm\"</code>.\
            \ <code><span class='null'>null</span></code> is interpreted as <code>\"\
            0mm\"</code>.</p>"
          type: "string"
        sheetSize:
          description: "<p>The sheet size as CSS size, for example <code>\"A4\"</code>,\
            \ <code>\"letter landscape\"</code>, <code>\"15in 20in\"</code> or <code>\"\
            20cm 30cm\"</code>.</p>"
          type: "string"
        spacing:
          description: "<p>The horizontal and vertical space between pages on a sheet\
            \ as CSS value, for example <code>\"0.1in\"</code> or <code>\"5mm 2mm\"\
            </code>. <code><span class='null'>null</span></code> is interpreted as\
            \ <code>\"0mm\"</code>.</p>"
          type: "string"
    PdfScriptAction:
      properties:
        script:
          description: "<p>The script source that should be executed.</p>"
          type: "string"
        triggerEvent:
          $ref: "#/components/schemas/PdfScriptTriggerEvent"
          description: "<p>The event on which the script is executed. Value is a <em>PdfScriptTriggerEvent</em>\
            \ constant.</p>"
    PdfScriptTriggerEvent:
      enum:
      - "AFTER_PRINT"
      - "AFTER_SAVE"
      - "BEFORE_PRINT"
      - "BEFORE_SAVE"
      - "CLOSE"
      - "OPEN"
      type: "string"
    ProcessingPreferences:
      enum:
      - "SAVE_MEMORY_IMAGES"
      type: "string"
    Progress:
      properties:
        callbackUrl:
          description: "If this object was created for a callback, this property indicates\
            \ the callback's URL."
          type: "string"
        contentType:
          description: "The content type of the resulting document as a MIME type\
            \ string. Depends on what <em>OutputType</em> was set in the <em>Configuration</em>.\
            \ If none was set, the content type defaults to \"application/pdf\"."
          type: "string"
        conversionName:
          description: "Returns the name of the conversion if it was specified via\
            \ <code>conversionName</code>."
          type: "string"
        documentId:
          description: "The document ID of the conversion. This ID can be used to\
            \ poll the progress or retrieve the result."
          type: "string"
        documentUrl:
          description: "The relative URL to the location where you can download the\
            \ generated document once it is finished."
          type: "string"
        documentUrls:
          description: "The relative URLs to the locations where you can download\
            \ the generated documents once they are finished."
          items:
            type: "string"
          type: "array"
        finished:
          description: "Indicates whether the conversion is finished yet."
          type: "boolean"
        log:
          $ref: "#/components/schemas/Log"
          description: "The log of the conversion."
        progress:
          description: "The current progress of the conversion. The value is between\
            \ 0 and 100."
          type: "integer"
        startDate:
          description: "The date and time when the conversion was started on the server."
          format: "date-time"
          type: "string"
    QuirksMode:
      enum:
      - "DETECT"
      - "QUIRKS"
      - "STANDARDS"
      type: "string"
    QuirksSettings:
      properties:
        caseSensitiveClassSelectors:
          $ref: "#/components/schemas/QuirksMode"
          description: "<p>By default in HTML CSS class selectors are case sensitive.</p>\
            \ <p>In the default <code>\"DETECT\"</code> mode this behavior is disabled\
            \ for old HTML doctypes or when there is no doctype.</p> <p>To enable\
            \ or disable it independently of the document this property can be set\
            \ to <code>\"STANDARDS\"</code> or <code>\"QUIRKS\"</code> respectively.</p>"
        minLineHeightFromContainer:
          $ref: "#/components/schemas/QuirksMode"
          description: "<p>By default the line-height of text containers, e.g. paragraph\
            \ elements, is used as the minimum line-height of their lines.</p> <p>In\
            \ the default <code>\"DETECT\"</code> mode this behavior is disabled for\
            \ old HTML doctypes or when there is no doctype.</p> <p>To enable or disable\
            \ it independently of the document this property can be set to <code>\"\
            STANDARDS\"</code> or <code>\"QUIRKS\"</code> respectively.</p>"
    Record:
      properties:
        level:
          description: "The level of the record."
          type: "integer"
        levelName:
          description: "The textual representation of the level."
          type: "string"
        message:
          description: "The logged message."
          type: "string"
        timestamp:
          description: "The timestamp."
          type: "integer"
    ResolutionUnit:
      enum:
      - "DPCM"
      - "DPI"
      - "DPPX"
      - "TDPCM"
      - "TDPI"
      - "TDPPX"
      type: "string"
    Resource:
      properties:
        beforeDocumentScripts:
          description: "<p>Use <code><span class='boolean-true'>true</span></code>\
            \ to cause PDFreactor to run the script before all scripts inside the\
            \ document and <code><span class='boolean-false'>false</span></code> to\
            \ run it after.</p> <p>Only supported for JavaScript-type resources.</p>"
          type: "boolean"
        content:
          description: "<p>The content of the resource. Only supported for Style Sheet-\
            \ and Script-type resources.</p>"
          type: "string"
        data:
          description: "<p>The binary data of the resource.</p>"
          format: "base64"
          type: "string"
        uri:
          description: "<p>The URI of the resource.</p>"
          format: "url"
          type: "string"
    ResourceType:
      enum:
      - "ATTACHMENT"
      - "DOCUMENT"
      - "FONT"
      - "ICC_PROFILE"
      - "IFRAME"
      - "IMAGE"
      - "LICENSEKEY"
      - "MERGE_DOCUMENT"
      - "OBJECT"
      - "RUNNING_DOCUMENT"
      - "SCRIPT"
      - "STYLESHEET"
      - "UNKNOWN"
      - "XHR"
      type: "string"
    Result:
      properties:
        callbackUrl:
          description: "If this object was created for a callback, this property indicates\
            \ the callback's URL."
          type: "string"
        connections:
          description: "<p>Provides a log about all URL connections attempted by PDFreactor,\
            \ including information about HTTP request and result, should the connection\
            \ be an HTTP or HTTPS connection. Depends on the mode set via <code>contentObserver</code>.</p>"
          items:
            $ref: "#/components/schemas/Connection"
          type: "array"
        contentType:
          description: "The content type of the resulting document as a MIME type\
            \ string. Depends on what <em>OutputType</em> was set in the <em>Configuration</em>.\
            \ If none was set, the content type defaults to \"application/pdf\"."
          type: "string"
        conversionName:
          description: "Returns the name of the conversion if it was specified via\
            \ <code>conversionName</code>."
          type: "string"
        document:
          description: "<p>The resulting PDF or image.</p> <p>This is not present\
            \ if only the document's metadata was retrieved.</p>"
          format: "base64"
          type: "string"
        documentArray:
          description: "<p>The resulting image as a collection of separate images,\
            \ each representing a single page. This property is only present if the\
            \ configuration option \"multiImage\" was set to <code><span class='boolean-true'>true</span></code>.</p>\
            \ <p>This is also not present if only the document's metadata was retrieved.</p>"
          items:
            format: "base64"
            type: "string"
          type: "array"
        documentId:
          description: "The document ID of the conversion. This ID can be used to\
            \ poll the progress or retrieve the result."
          type: "string"
        documentUrl:
          description: "The relative URL to the location where you can download the\
            \ generated document once it is finished."
          type: "string"
        documentUrls:
          description: "The relative URLs to the locations where you can download\
            \ the generated documents once they are finished."
          items:
            type: "string"
          type: "array"
        endDate:
          description: "<p>The date and time when the conversion was finished on the\
            \ server.</p>"
          format: "date-time"
          type: "string"
        error:
          description: "<p>Returns the error messages that might have been generated\
            \ during rendering.</p>"
          type: "string"
        exceedingContents:
          description: "<p>Provides information about content exceeding its page or\
            \ parent. Depends on the mode set via \"logExceedingContents\".</p>"
          items:
            $ref: "#/components/schemas/ExceedingContent"
          type: "array"
        javaScriptExports:
          description: "<p>Returns data that has been exported from document JavaScript\
            \ via <code>ro.exports</code> if set, <code><span class='null'>null</span></code>\
            \ otherwise. If the JavaScript data is not a string, it will be converted\
            \ to JSON. If the data can't be converted, a generic string representation\
            \ is used or <code><span class='null'>null</span></code> if none is available.</p>"
          type: "string"
        keepDocument:
          description: "<p>Indicates whether or not the <code>keepDocument</code>\
            \ property was set in the <code>Configuration</code> of this conversion.\
            \ If <code><span class='boolean-true'>true</span></code>, additional requests\
            \ can be made to retrieve this document.</p>"
          type: "boolean"
        log:
          $ref: "#/components/schemas/Log"
          description: "<p>Returns the log messages generated during rendering based\
            \ on the log level.</p>"
        missingResources:
          description: "<p>Provides information about resources that could not be\
            \ loaded during the conversion. Depends on the mode set via <code>contentObserver</code>.</p>"
          items:
            $ref: "#/components/schemas/MissingResource"
          type: "array"
        numberOfPages:
          description: "<p>Returns the number of pages of the document after conversion.</p>"
          type: "integer"
        numberOfPagesLiteral:
          description: "<p>Returns the number of pages of the resulting PDF (including,\
            \ e.g., merge operations), otherwise it will return the number pages of\
            \ the laid out input document.</p>"
          type: "integer"
        startDate:
          description: "The date and time when the conversion was started on the server."
          format: "date-time"
          type: "string"
    ScriptResource:
      properties:
        beforeDocumentScripts:
          description: "<p>Use <code><span class='boolean-true'>true</span></code>\
            \ to cause PDFreactor to run the script before all scripts inside the\
            \ document and <code><span class='boolean-false'>false</span></code> to\
            \ run it after.</p> <p>Only supported for JavaScript-type resources.</p>"
          type: "boolean"
        content:
          description: "<p>The content of the resource. Only supported for Style Sheet-\
            \ and Script-type resources.</p>"
          type: "string"
        data:
          description: "<p>The binary data of the resource.</p>"
          format: "base64"
          type: "string"
        uri:
          description: "<p>The URI of the resource.</p>"
          format: "url"
          type: "string"
    SegmentationSettings:
      properties:
        enabled:
          description: "<p>Enables or disables segmentation.</p>"
          type: "boolean"
        segmentSize:
          description: "<p>The preferred size (in number of pages) of the segments\
            \ into which the conversion will be split.</p> <p>Valid values range from\
            \ 10 to 1000. Values smaller than 1 default to 1000.</p>"
          type: "integer"
    SignPDF:
      properties:
        keyAlias:
          description: "<p>The alias of the certificate included in the keystore to\
            \ be used to sign the PDF.</p>"
          type: "string"
        keyPassword:
          description: "<p>The password for the certificate included in the keystore\
            \ to be used to sign the PDF.</p> <p>If none is provided, the keystore\
            \ password will be used for the certificate.</p>"
          type: "string"
        keystorePassword:
          description: "<p>The password of the keystore.</p>"
          type: "string"
        keystoreType:
          $ref: "#/components/schemas/KeystoreType"
          description: "<p>The format of the keystore, for example PKCS #12 or JKS.\
            \ Use one of the <em>KeystoreType</em> constants as value.</p>"
        keystoreURL:
          description: "<p>The URL to the keystore file.</p>"
          type: "string"
        signingMode:
          $ref: "#/components/schemas/SigningMode"
          description: "<p>The cryptographic filter mode that is used to sign the\
            \ PDF, like SELF_SIGNED, VERISIGN_SIGNED or WINCER_SIGNED.</p> <p>Use\
            \ one of the <em>SigningMode</em> constants as value.</p>"
    SigningMode:
      enum:
      - "SELF_SIGNED"
      - "VERISIGN_SIGNED"
      - "WINCER_SIGNED"
      type: "string"
    UrlRewriteRule:
      properties:
        pattern:
          description: "<p>The regular expression pattern which is matched against\
            \ each URL.</p> <p>Note that the URLs are always absolute. If they are\
            \ initially relative in the document or other resources, they are resolved.</p>"
          type: "string"
        substitution:
          description: "<p>If a URL matches the <code>pattern</code>, it is replaced\
            \ by this substitution. Since the pattern is a regular expression, the\
            \ substitution can include group identifiers or back references.</p>"
          type: "string"
    UrlRewriteSettings:
      properties:
        rules:
          description: "<p>The rules according to which URLs are rewritten.</p>"
          items:
            $ref: "#/components/schemas/UrlRewriteRule"
          type: "array"
    Version:
      properties:
        build:
          description: "The build number."
          type: "integer"
        label:
          description: "The label of the version."
          type: "string"
        major:
          description: "The major version."
          type: "integer"
        micro:
          description: "The micro version."
          type: "integer"
        minor:
          description: "The minor version."
          type: "integer"
        revision:
          description: "The revision number."
          type: "string"
        text:
          description: "The version as text."
          type: "string"
    ViewerPreferences:
      enum:
      - "CENTER_WINDOW"
      - "DIRECTION_L2R"
      - "DIRECTION_R2L"
      - "DISPLAY_DOC_TITLE"
      - "DUPLEX_FLIP_LONG_EDGE"
      - "DUPLEX_FLIP_SHORT_EDGE"
      - "DUPLEX_SIMPLEX"
      - "FIT_WINDOW"
      - "HIDE_MENUBAR"
      - "HIDE_TOOLBAR"
      - "HIDE_WINDOW_UI"
      - "NON_FULLSCREEN_PAGE_MODE_USE_NONE"
      - "NON_FULLSCREEN_PAGE_MODE_USE_OC"
      - "NON_FULLSCREEN_PAGE_MODE_USE_OUTLINES"
      - "NON_FULLSCREEN_PAGE_MODE_USE_THUMBS"
      - "PAGE_LAYOUT_ONE_COLUMN"
      - "PAGE_LAYOUT_SINGLE_PAGE"
      - "PAGE_LAYOUT_TWO_COLUMN_LEFT"
      - "PAGE_LAYOUT_TWO_COLUMN_RIGHT"
      - "PAGE_LAYOUT_TWO_PAGE_LEFT"
      - "PAGE_LAYOUT_TWO_PAGE_RIGHT"
      - "PAGE_MODE_FULLSCREEN"
      - "PAGE_MODE_USE_ATTACHMENTS"
      - "PAGE_MODE_USE_NONE"
      - "PAGE_MODE_USE_OC"
      - "PAGE_MODE_USE_OUTLINES"
      - "PAGE_MODE_USE_THUMBS"
      - "PICKTRAYBYPDFSIZE_FALSE"
      - "PICKTRAYBYPDFSIZE_TRUE"
      - "PRINTSCALING_APPDEFAULT"
      - "PRINTSCALING_NONE"
      type: "string"
    Xmp:
      properties:
        content:
          description: "<p>XMP, as an XML string, to be embedded into the PDF document.</p>"
          type: "string"
        priority:
          $ref: "#/components/schemas/XmpPriority"
          description: "<p>Priority of this XMP over XMP generated automatically for\
            \ the conformance requirements of certain output formats.</p>"
        uri:
          description: "<p>URI to XMP to be embedded into the PDF document, if <code>content</code>\
            \ is not set or <code><span class='null'>null</span></code>.</p>"
          format: "url"
          type: "string"
    XmpPriority:
      enum:
      - "HIGH"
      - "LOW"
      - "NONE"
      type: "string"


  securitySchemes:
    apiKeyQueryAuth:
      type: apiKey
      in: query
      name: apiKey
      description: >
        The API key to authenticate the request (only necessary if the server is appropriately configured).
security:
  - apiKeyQueryAuth: []