openapi: 3.2.0
info:
title: PDF Services Combine PDF API
description: "
"
version: ''
servers:
- url: https://pdf-services-ue1.adobe.io
- url: https://pdf-services-ew1.adobe.io
tags:
- name: Combine PDF
description: Combine multiple PDF Files into a single PDF File
paths:
/operation/combinepdf:
post:
tags:
- Combine PDF
summary: Combine multiple PDF Files into a single PDF File
description: Combines multiple PDF files(upto 20 files) into a single PDF file. Allows specifying which pages of the source files to combine. By default all the pages of source files are considered if explicit PageRanges are not specified.
operationId: pdfoperations.combinepdf
parameters:
- name: Authorization
in: header
description: Bearer + Token (Learn more about getting the access token)
required: true
schema:
type: string
- name: x-api-key
in: header
description: The clientId from the generated credentials
required: true
schema:
type: string
requestBody:
description: Params for Combine PDF Operation. Refer to the External Section below for using external storage with Combine PDF operation.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/CombinePDFInternal'
- $ref: '#/components/schemas/CombinePDFExternal'
required: true
responses:
'201':
description: Request creation for the operation and status uri generated, which can be found in the 'location' header.
headers:
location:
description: Job status URI for polling the results
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
'400':
description: Bad Request. The request was invalid or cannot be otherwise served.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/400'
'404':
description: Resource Not Found.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/404'
'401':
description: Unauthorized.
headers:
content-type:
description: The content type of the error JSON response.
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/401'
'429':
description: Caller doesn't have sufficient quota for this operation.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/429'
'500':
description: Internal Server Error. The server has encountered an error and is unable to process your request at this time.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/500'
x-codegen-request-body-name: body
/operation/combinepdf/{jobID}/status:
get:
tags:
- Combine PDF
summary: Poll the combine pdf job for completion
operationId: pdfoperations.combinepdf.jobstatus
parameters:
- name: jobID
in: path
description: Job ID of the request
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer + Token (Learn more about getting the access token)
required: true
schema:
type: string
- name: x-api-key
in: header
description: The clientId from the generated credentials
required: true
schema:
type: string
responses:
'200':
description: A response with job information.
headers:
content-type:
description: The content type of the status call response.
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/CombinePDFJobStatus'
'400':
description: Bad Request. The request was invalid or cannot be otherwise served.
headers:
content-type:
description: The content type of the status call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Status400'
'404':
description: Resource Not Found.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Satus404'
'401':
description: Unauthorized.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-server:
description: The name and version of the server.
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Satus401'
'429':
description: Caller doesn't have sufficient quota for this operation.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Satus429'
'500':
description: Internal Server Error. The server has encountered an error and is unable to process your request at this time.
headers:
content-type:
description: The content type of the POST API call response
schema:
type: string
x-request-id:
description: A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Satus500'
components:
schemas:
done:
title: done
oneOf:
- $ref: '#/components/schemas/internal'
- $ref: '#/components/schemas/externalstatus'
CombinePDFInternal:
title: Internal
description: Params for Combine PDF Operation
type: object
properties:
assets:
description: The array of assets with the required PageRanges to include in the output PDF document.
type: array
items:
properties:
assetID:
description: A file assetID. For more details click here .
type: string
pageRanges:
$ref: '#/components/schemas/CombinePageRanges'
required:
- assetID
notifiers:
$ref: '#/components/schemas/notifiers'
example:
assets:
- assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718
pageRanges:
- start: 1
end: 2
- assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87d3-087832fca718
pageRanges:
- start: 1
end: 2
notifiers:
- type: CALLBACK
data:
url: https://dummy.callback.org/
headers:
x-api-key: dummykey
access-token: dummytoken
required:
- assets
additionalProperties: false
Satus404:
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| NOT_FOUND | Job not found. |
"
type: string
example:
error:
code: NOT_FOUND
message: Job not found.
'400':
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| BAD_REQUEST | Bad Request. |
"
type: string
example:
error:
code: BAD_REQUEST
message: Bad Request.
'500':
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| INTERNAL_SERVER_ERROR | There was an error processing your request. |
| UNKNOWN | Unknown error. |
"
type: string
example:
error:
code: INTERNAL_SERVER_ERROR
message: There was an error processing your request.
external:
title: External with an output URI in the request
description: Response in case of 'done' status using signed urls
type: object
properties:
status:
description: Job Status
type: string
enum:
- done
example:
status: done
CombinePageRanges:
title: pageRanges
description: Parameters to allow specifying which pages to be included for the PDF document. If pageRanges is not provided, all pages are considered by default. An array of ranges to allow specifying which pages to include from the source PDF document.
type: array
items:
anyOf:
- title: start
description: Start page index of this page range.
type: number
- title: end
description: End page index of this page range.
type: number
externaldonewithoutoutput:
title: External without an output URI in the request
description: Response in case of 'done' status
type: object
properties:
status:
description: Job Status
type: string
enum:
- done
asset:
$ref: '#/components/schemas/responseAsset'
example:
status: done
asset:
metadata:
type: application/pdf
size: 200791
downloadUri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56
assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718
CombinePDFJobStatus:
oneOf:
- $ref: '#/components/schemas/inprogress'
- $ref: '#/components/schemas/done'
- $ref: '#/components/schemas/failed'
'404':
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| NOT_FOUND | Asset not found. |
"
type: string
example:
error:
code: NOT_FOUND
message: Asset not found.
failed:
description: Response in case of 'failed' status
type: object
properties:
status:
description: Job Status
type: string
enum:
- failed
error:
type: object
properties:
status:
description: Http status code returned by the service
type: integer
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| status | code | message |
|---|
| 400 | CORRUPT_DOCUMENT | For $(format) mime-type The input file appears to be corrupted and cannot be processed. |
| 400 | PASSWORD_PROTECTED | Source file is protected and cannot be processed. |
| 500 | INTERNAL_SERVER_ERROR | There was an error processing your request. |
"
type: string
example:
status: failed
error:
status: 500
code: INTERNAL_SERVER_ERROR
message: There was an error processing your request
externalstatus:
title: External
oneOf:
- $ref: '#/components/schemas/externaldonewithoutoutput'
- $ref: '#/components/schemas/external'
ExternalStorageOutput:
title: Output
description: Params representing output object
type: object
properties:
uri:
description: Output file Upload Signed URI.
type: string
storage:
description: Specifies the type of the external storage
type: string
enum:
- S3
- SHAREPOINT
- DROPBOX
- BLOB
'429':
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| TOO_MANY_REQUESTS | Too Many Requests. |
| INSUFFICIENT_QUOTA | Either Quota for this operation is not available or Free trial quota is exhausted. Please visit (www.adobe.com/go/pdftoolsapi_home) to start using free trial quota or (www.adobe.com/go/pdftoolsapi_err_quota) to upgrade to paid credentials. |
"
type: string
example:
error:
code: TOO_MANY_REQUESTS
message: Too Many Requests.
Status400:
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| INVALID_JOB_ID | Invalid job id present in path param. |
"
type: string
example:
error:
code: INVALID_JOB_ID
message: Invalid job id present in path param.
inprogress:
description: Response in case of 'in progress' status
type: object
properties:
status:
description: Job Status
type: string
enum:
- in progress
example:
status: in progress
responseAsset:
title: asset
description: Details of output asset document. For more details click here .
type: object
properties:
metadata:
type: object
description: metadata details of output asset.
properties:
size:
description: The size of the Resource in bytes. This value helps in making range requests.
type: integer
type:
description: The media type of the Resource.
type: string
assetID:
description: An asset ID identifying an asset that is globally unique and never reused.
type: string
required: false
downloadUri:
description: The URL used to download the Resource directly to the cloud provider.
type: string
example:
status: done
asset:
metadata:
type: application/pdf
size: 200791
downloadUri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56
assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718
Satus429:
properties:
error_code:
description: 'The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific. '
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| 429001 | Service usage limit reached |
| 429002 | Developer key usage limit reached |
| 429050 | Too many requests |
"
type: string
example:
error_code: '429050'
message: Too many requests
notifiers:
description: Specifies the notifiers to be invoked on the completion of job. To know more about notifiers, please see the documentation.
type: array
items:
properties:
type:
description: Specifies the notifier type. Currently supported value is "CALLBACK" only.
type: string
data:
description: Specifies the data needed to invoke the notifier.
type: object
required:
- type
- data
Satus401:
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| UNAUTHORIZED | Not authorised to perform the operation. |
"
type: string
example:
error:
code: UNAUTHORIZED
message: Not authorised to perform the operation.
'401':
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| UNAUTHORIZED | Not authorised to perform the operation. |
"
type: string
example:
error:
code: UNAUTHORIZED
message: Not authorised to perform the operation.
internal:
title: Internal
description: Response in case of 'done' status
type: object
properties:
status:
description: Job Status
type: string
enum:
- done
asset:
$ref: '#/components/schemas/responseAsset'
example:
status: done
asset:
metadata:
type: application/pdf
size: 200791
downloadUri: https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=REDACTED_AWS_ACCESS_KEY_ID%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56
assetID: urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718
CombinePDFExternal:
title: External
description: Params for Combine PDF Operation
type: object
properties:
inputs:
description: The array of inputs with the required PageRanges to include in the output PDF document.
type: array
items:
properties:
input:
description: Params representing input object for combine pdf operation
type: object
properties:
uri:
description: Input file Download Signed URI.
type: string
storage:
description: Specifies the type of the external storage
type: string
enum:
- S3
- SHAREPOINT
required:
- uri
pageRanges:
$ref: '#/components/schemas/CombinePageRanges'
required:
- inputs
output:
$ref: '#/components/schemas/ExternalStorageOutput'
notifiers:
$ref: '#/components/schemas/notifiers'
example:
inputs:
- input:
uri: https://dcalpine2.sharepoint.com/sites/Docgen/_layouts/15/download.aspx?UniqueId=353087f7-b1ea-4d84-91d7-0821b23e04ea&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDI5MDkiLCJleHAiOiIxNjgwNjA2NTA5IiwiZW5kcG9pbnR1cmwiOiIwU1NJNDAxdjZhUll6YUIyV2lod005VnIxOVJHNStvSUxFN280dk0yUlMwPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMTMzIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJPVEUxTlRZMFkyRXROREZpT1MwME1HSTBMVGczWVdRdFlqaGpaREprWkdNeVlXVTUiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE2OSJ9.aStWTExNZ045T3h3OGV4MHdyYURmLzZqOW9McGRhSmtZWStHOE1wM0ZaYz0&ApiVersion=2.0
storage: SHAREPOINT
pageRanges:
- start: 1
end: 2
- input:
uri: https://dcalpine2.sharepoint.com/sites/Docgen/_layouts/15/download.aspx?UniqueId=353087f7-b1ea-4d84-91d7-0821b23e04ea&Translate=false&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDI5MDkiLCJleHAiOiIxNjgwNjA2NTA5IiwiZW5kcG9pbnR1cmwiOiIwU1NJNDAxdjZhUll6YUIyV2lod005VnIxOVJHNStvSUxFN280dk0yUlMwPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMTMzIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJPVEUxTlRZMFkyRXROREZpT1MwME1HSTBMVGczWVdRdFlqaGpaREprWkdNeVlXVTUiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE2OSJ9.aStWTExNZ045T3h3OGV4MHdyYURmLzZqOW9McGRhSmtZWStHOE1wM0ZaYz0&ApiVersion=2.0
storage: SHAREPOINT
pageRanges:
- start: 1
end: 2
output:
uri: https://dcalpine2.sharepoint.com/sites/Docgen/_api/v2.0/drives/b!MA1899sXSkupaKT9m2CP3JIqXDMQyoBCth9h9Rn6bQRjzBEBFxsbQpN23hY-rzQT/items/01TAIM7P3ZQQ4DP4NZHFDI6FBJPIGFRCY3/uploadSession?guid='2c79b9aa-f9dc-42c8-8919-da5a9b554b81'&overwrite=True&rename=False&dc=0&tempauth=eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJhdWQiOiIwMDAwMDAwMy0wMDAwLTBmZjEtY2UwMC0wMDAwMDAwMDAwMDAvZGNhbHBpbmUyLnNoYXJlcG9pbnQuY29tQGIxYzY2OGZhLTU3YzQtNDBjYy1iZTgyLTg4OWJiYzkxNmM1NiIsImlzcyI6IjAwMDAwMDAzLTAwMDAtMGZmMS1jZTAwLTAwMDAwMDAwMDAwMCIsIm5iZiI6IjE2ODA2MDAyOTMiLCJleHAiOiIxNjgwNjg2NjkzIiwiZW5kcG9pbnR1cmwiOiJXVWNNVHhndVdyMHR4YzhlYWxlRzMrYUV1aXg5anoxanZuRmRpMENjNHFRPSIsImVuZHBvaW50dXJsTGVuZ3RoIjoiMjYxIiwiaXNsb29wYmFjayI6IlRydWUiLCJjaWQiOiJaREZsTURjek5tRXRaREJtWkMwMFlXUXlMV0V5WTJNdE1HRTRPV1prTTJJNU5XTmwiLCJ2ZXIiOiJoYXNoZWRwcm9vZnRva2VuIiwic2l0ZWlkIjoiWmpjM1l6QmtNekF0TVRka1lpMDBZalJoTFdFNU5qZ3RZVFJtWkRsaU5qQTRabVJqIiwiYXBwX2Rpc3BsYXluYW1lIjoiU2hhcmVwb2ludC1QT0MiLCJuYW1laWQiOiIyYmVmMjRkNy04OTRlLTQ4MzQtYWQxOC00OGZkNDRiNzk0ZTNAYjFjNjY4ZmEtNTdjNC00MGNjLWJlODItODg5YmJjOTE2YzU2Iiwicm9sZXMiOiJhbGxzaXRlcy5yZWFkIGFsbHNpdGVzLndyaXRlIGFsbGZpbGVzLndyaXRlIGFsbGZpbGVzLnJlYWQiLCJ0dCI6IjEiLCJ1c2VQZXJzaXN0ZW50Q29va2llIjpudWxsLCJpcGFkZHIiOiIyMC4xOTAuMTQ1LjE3MCJ9.a1hxR1J1emlFSE9jSTU0SnFTcFN6TGlsRHNhWTFRaDNkT2hwT3ZPYm8waz0
storage: SHAREPOINT
notifiers:
- type: CALLBACK
data:
url: https://dummy.callback.org/
headers:
x-api-key: dummykey
access-token: dummytoken
required:
- inputs
additionalProperties: false
Satus500:
properties:
error:
type: object
properties:
code:
description: The string containing the code field. code is the Mnemonic returned by service in case of any failure. The below list is extendable and going forward the error codes can become more specific.
type: string
message:
description: "An English language string that contains more information about the error. \n\n| code | message |
|---|
| INTERNAL_SERVER_ERROR | There was an error processing your request. |
| UNKNOWN | Unknown error. |
"
type: string
example:
error:
code: INTERNAL_SERVER_ERROR
message: There was an error processing your request.
x-tagGroups:
- name: Authentication
tags:
- Generate Token
- name: Files
tags:
- Assets
- name: PDF Operations
tags:
- Combine PDF
- Compress PDF
- Create PDF
- Document Generation
- Export PDF
- Export PDF Form Data
- Extract PDF
- Html to PDF
- Import PDF Form Data
- Linearize PDF
- OCR
- Page Manipulation
- PDF Accessibility Auto-Tag
- PDF Accessibility Checker
- PDF Electronic Seal
- PDF Properties
- PDF To Images
- PDF To Markdown
- PDF Watermark
- Protect PDF
- Remove Protection
- Split PDF