diff --git a/src/pages/apis/index.md b/src/pages/apis/index.md index 1e5df79d7..362f75456 100644 --- a/src/pages/apis/index.md +++ b/src/pages/apis/index.md @@ -1,5 +1,5 @@ --- title: Adobe PDF Services Open API spec description: The OpenAPI spec for Adobe PDF Services API endpoints, parameters, and responses. -openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/main/src/pages/resources/openapi.json +openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/get-set-form/src/pages/resources/openapi.json --- diff --git a/src/pages/resources/openapi.json b/src/pages/resources/openapi.json index 25d241c24..25df9f368 100644 --- a/src/pages/resources/openapi.json +++ b/src/pages/resources/openapi.json @@ -97,6 +97,14 @@ { "name": "PDF Watermark", "description": "PDF Watermark API will add a watermark in PDF document." + }, + { + "name": "Export PDF Form Data", + "description": "The Export PDF Form Data API will retrieve the data from a PDF form and return it as a JSON file." + }, + { + "name": "Import PDF Form Data", + "description": "The Import PDF Form Data API will take the form data provided as a JSON, insert it into the PDF form, and generate the resulting PDF." } ], "x-tagGroups": [ @@ -138,7 +146,9 @@ "name": "PDF operations Beta", "tags": [ "PDF Accessibility Checker", - "PDF Watermark" + "PDF Watermark", + "Export PDF Form Data", + "Import PDF Form Data" ] } ], @@ -8125,216 +8135,972 @@ } } } - } - }, - "components": { - "schemas": { - "Token": { - "description": "Params for generating the Access Token.", - "type": "object", - "properties": { - "client_id": { - "description": "Contains the client id obtained upon client registration.", - "type": "string" + }, + "/operation/getformdata": { + "post": { + "tags": [ + "Export PDF Form Data" + ], + "summary": "Export PDF Form Data Operation", + "description": "The Export PDF Form Data API will retrieve the data from a PDF form and return it as a JSON file where field names of form will be the keys and value will be the data of the form.", + "operationId": "pdfoperations.getformdata", + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "Bearer + Token (Learn more about getting the access token)", + "required": true, + "schema": { + "type": "string" + } }, - "client_secret": { - "description": "Contains the client secret obtained upon client registration.", - "type": "string" + { + "name": "x-api-key", + "in": "header", + "description": "The clientId from the generated credentials", + "required": true, + "schema": { + "type": "string" + } } - }, - "example": { - "client_id": "", - "client_secret": "" - }, - "required": [ - "client_id", - "client_secret" ], - "additionalProperties": false - }, - "TokenResponse": { - "description": "Response of generate Access Token Operation.", - "type": "object", - "properties": { - "access_token": { - "description": "The token which can be used in performing the PDF Service Operation.", - "type": "string" - }, - "token_type": { - "description": "The type of the token issued.", - "type": "string" + "requestBody": { + "description": "Input Params for Export PDF Form Data Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/GetFormDataInternal" + }, + { + "$ref": "#/components/schemas/GetFormDataExternal" + } + ] + } + } }, - "expires_in": { - "description": "The lifetime in seconds of the access token.", - "type": "integer" - } + "required": true }, - "example": { - "access_token": "*******", - "token_type": "Bearer", - "expires_in": "86399" - } - }, - "documentLanguage": { - "description": "Specifies the default language for the input non-PDF document. In absence of font info within file’s content, an appropriate font is chosen on its basis. \n\n Note : ja-JP Locale is currently not supported in EU region. ", - "type": "string", - "default": "en-US", - "enum": [ - "ca-ES", - "cs-CZ", - "da-DK", - "de-DE", - "en-AE", - "en-GB", - "en-IL", - "en-US", - "es-ES", - "es-MX", - "eu-ES", - "fi-FI", - "fr-CA", - "fr-FR", - "fr-MA", - "hr-HR", - "ht-HU", - "it-IT", - "ja-JP", - "ko-KR", - "nb-NO", - "nl-NL", - "pl-PL", - "pt-BR", - "pt-PT", - "ro-RO", - "ru-RU", - "sk-SK", - "sl-SI", - "sv-SE", - "tr-TR", - "uk-UA", - "zh-CN", - "zh-TW", - "lt-LT", - "el-GR", - "zh-HK", - "hu-HU", - "et-EE", - "lv-LV", - "bg-BG", - "mt-MT", - "sr-SR", - "ca-CA", - "mk-MK", - "de-CH", - "no-NO", - "iw-IL" - ] - }, - "ocrLang": { - "description": "Specifies the input language to be used for OCR.", - "type": "string", - "default": "en-US", - "enum": [ - "da-DK", - "lt-LT", - "sl-SI", - "el-GR", - "ru-RU", - "en-US", - "zh-HK", - "hu-HU", - "et-EE", - "pt-BR", - "uk-UA", - "nb-NO", - "pl-PL", - "lv-LV", - "fi-FI", - "ja-JP", - "es-ES", - "bg-BG", - "en-GB", - "cs-CZ", - "mt-MT", - "de-DE", - "hr-HR", - "sk-SK", - "sr-SR", - "ca-CA", - "mk-MK", - "ko-KR", - "de-CH", - "nl-NL", - "zh-CN", - "sv-SE", - "it-IT", - "no-NO", - "tr-TR", - "fr-FR", - "ro-RO", - "iw-IL" - ] - }, - "exportOCRLang": { - "title": "ocrLang", - "type": "string", - "description": "Language to be used for ocr operation", - "enum": [ - "en-GB", - "en-US", - "nl-NL", - "fr-FR", - "de-DE", - "it-IT", - "es-ES", - "sv-SE", - "da-DK", - "fi-FI", - "nb-NO", - "pt-BR", - "pt-PT", - "ca-CA", - "nn-NO", - "de-CH", - "ja-JP", - "bg-BG", - "hr-HR", - "cs-CZ", - "et-EE", - "el-GR", - "hu-HU", - "lv-LV", - "lt-LT", - "pl-PL", - "ro-RO", - "ru-RU", - "zh-CN", - "sl-SI", - "zh-Hant", - "tr-TR", - "ko-KR", - "sk-SK", - "eu-ES", - "gl-ES", - "mk-MK", - "mt-MT", - "sr-SR", - "uk-UA", - "iw-IL" - ] - }, - "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" + "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" + } }, - "message": { - "description": "An English language string that contains more information about the error. \n\n
codemessage
BAD_REQUESTBad Request.
", - "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/getformdata/{jobID}/status": { + "get": { + "tags": [ + "Export PDF Form Data" + ], + "summary": "Poll the Export PDF Form Data job for completion", + "operationId": "pdfoperations.getformdata.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/GetFormDataJobStatus" + } + } + } + }, + "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" + } + } + } + } + } + } + }, + "/operation/setformdata": { + "post": { + "tags": [ + "Import PDF Form Data" + ], + "summary": "Import PDF Form Data Operation", + "description": "The Import PDF Form Data API will take the form data provided as a JSON, insert it into the PDF form, and generate the resulting PDF where field names of form will be the keys and value will be the data of the form in the input JSON.", + "operationId": "pdfoperations.setformdata", + "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": "Input Params for Import PDF Form Data Operation.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/SetFormDataInternal" + }, + { + "$ref": "#/components/schemas/SetFormDataExternal" + } + ] + } + } + }, + "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/setformdata/{jobID}/status": { + "get": { + "tags": [ + "Import PDF Form Data" + ], + "summary": "Poll the Import PDF Form Data job for completion", + "operationId": "pdfoperations.setformdata.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/SetFormDataJobStatus" + } + } + } + }, + "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": { + "Token": { + "description": "Params for generating the Access Token.", + "type": "object", + "properties": { + "client_id": { + "description": "Contains the client id obtained upon client registration.", + "type": "string" + }, + "client_secret": { + "description": "Contains the client secret obtained upon client registration.", + "type": "string" + } + }, + "example": { + "client_id": "", + "client_secret": "" + }, + "required": [ + "client_id", + "client_secret" + ], + "additionalProperties": false + }, + "TokenResponse": { + "description": "Response of generate Access Token Operation.", + "type": "object", + "properties": { + "access_token": { + "description": "The token which can be used in performing the PDF Service Operation.", + "type": "string" + }, + "token_type": { + "description": "The type of the token issued.", + "type": "string" + }, + "expires_in": { + "description": "The lifetime in seconds of the access token.", + "type": "integer" + } + }, + "example": { + "access_token": "*******", + "token_type": "Bearer", + "expires_in": "86399" + } + }, + "documentLanguage": { + "description": "Specifies the default language for the input non-PDF document. In absence of font info within file’s content, an appropriate font is chosen on its basis. \n\n Note : ja-JP Locale is currently not supported in EU region. ", + "type": "string", + "default": "en-US", + "enum": [ + "ca-ES", + "cs-CZ", + "da-DK", + "de-DE", + "en-AE", + "en-GB", + "en-IL", + "en-US", + "es-ES", + "es-MX", + "eu-ES", + "fi-FI", + "fr-CA", + "fr-FR", + "fr-MA", + "hr-HR", + "ht-HU", + "it-IT", + "ja-JP", + "ko-KR", + "nb-NO", + "nl-NL", + "pl-PL", + "pt-BR", + "pt-PT", + "ro-RO", + "ru-RU", + "sk-SK", + "sl-SI", + "sv-SE", + "tr-TR", + "uk-UA", + "zh-CN", + "zh-TW", + "lt-LT", + "el-GR", + "zh-HK", + "hu-HU", + "et-EE", + "lv-LV", + "bg-BG", + "mt-MT", + "sr-SR", + "ca-CA", + "mk-MK", + "de-CH", + "no-NO", + "iw-IL" + ] + }, + "ocrLang": { + "description": "Specifies the input language to be used for OCR.", + "type": "string", + "default": "en-US", + "enum": [ + "da-DK", + "lt-LT", + "sl-SI", + "el-GR", + "ru-RU", + "en-US", + "zh-HK", + "hu-HU", + "et-EE", + "pt-BR", + "uk-UA", + "nb-NO", + "pl-PL", + "lv-LV", + "fi-FI", + "ja-JP", + "es-ES", + "bg-BG", + "en-GB", + "cs-CZ", + "mt-MT", + "de-DE", + "hr-HR", + "sk-SK", + "sr-SR", + "ca-CA", + "mk-MK", + "ko-KR", + "de-CH", + "nl-NL", + "zh-CN", + "sv-SE", + "it-IT", + "no-NO", + "tr-TR", + "fr-FR", + "ro-RO", + "iw-IL" + ] + }, + "exportOCRLang": { + "title": "ocrLang", + "type": "string", + "description": "Language to be used for ocr operation", + "enum": [ + "en-GB", + "en-US", + "nl-NL", + "fr-FR", + "de-DE", + "it-IT", + "es-ES", + "sv-SE", + "da-DK", + "fi-FI", + "nb-NO", + "pt-BR", + "pt-PT", + "ca-CA", + "nn-NO", + "de-CH", + "ja-JP", + "bg-BG", + "hr-HR", + "cs-CZ", + "et-EE", + "el-GR", + "hu-HU", + "lv-LV", + "lt-LT", + "pl-PL", + "ro-RO", + "ru-RU", + "zh-CN", + "sl-SI", + "zh-Hant", + "tr-TR", + "ko-KR", + "sk-SK", + "eu-ES", + "gl-ES", + "mk-MK", + "mt-MT", + "sr-SR", + "uk-UA", + "iw-IL" + ] + }, + "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
codemessage
BAD_REQUESTBad Request.
", + "type": "string" } } } @@ -11788,6 +12554,215 @@ } } }, + "GetFormDataInternal": { + "title": "Internal", + "description": "Parameter for Export PDF Form Data operation.", + "type": "object", + "required": [ + "assetID" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "GetFormDataExternal": { + "title": "External", + "description": "Params for Export PDF Form Data Operation using external storage.", + "type": "object", + "required": [ + "input" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "SetFormDataInternal": { + "title": "Internal", + "description": "Parameter for Import PDF Form Data operation.", + "type": "object", + "required": [ + "assetID", + "jsonFormFieldsData" + ], + "properties": { + "assetID": { + "description": "A file assetID. For more details click here .", + "type": "string" + }, + "jsonFormFieldsData": { + "description": "JSON Form data of PDF.", + "type": "object" + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718", + "jsonFormFieldsData": { + "dob": "10/10/1989", + "billTo": { + "zip": "12401", + "address": { + "line": { + "1": "132", + "2": "My Street" + } + }, + "city": "Kingston", + "state": "New York" + }, + "name": { + "middle": "", + "last": "Smith", + "first": "John" + }, + "age": "34" + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, + "SetFormDataExternal": { + "title": "External", + "description": "Params for Import PDF Form Data Operation using external storage.", + "type": "object", + "required": [ + "input", + "params" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/ExternalStorageInput" + }, + "output": { + "$ref": "#/components/schemas/ExternalStorageOutput" + }, + "params": { + "description": "Params for Import PDF Form Data Operation processing", + "type": "object", + "required": ["jsonFormFieldsData"], + "properties": { + "jsonFormFieldsData": { + "description": "JSON Form data of PDF.", + "type": "object" + } + } + }, + "notifiers": { + "$ref": "#/components/schemas/notifiers" + } + }, + "example": { + "input": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2", + "storage": "S3" + }, + "output": { + "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71", + "storage": "S3" + }, + "params": { + "jsonFormFieldsData": { + "dob": "10/10/1989", + "billTo": { + "zip": "12401", + "address": { + "line": { + "1": "132", + "2": "My Street" + } + }, + "city": "Kingston", + "state": "New York" + }, + "name": { + "middle": "", + "last": "Smith", + "first": "John" + }, + "age": "34" + } + }, + "notifiers": [ + { + "type": "CALLBACK", + "data": { + "url": "https://dummy.callback.org/", + "headers": { + "x-api-key": "dummykey", + "access-token": "dummytoken" + } + } + } + ] + }, + "additionalProperties": false + }, "GetUploadPresignedUrlAsset": { "type": "object", "properties": { @@ -13406,6 +14381,32 @@ } ] }, + "GetFormDataJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, + "SetFormDataJobStatus": { + "oneOf": [ + { + "$ref": "#/components/schemas/inprogress" + }, + { + "$ref": "#/components/schemas/done" + }, + { + "$ref": "#/components/schemas/failed" + } + ] + }, "ElectronicSealPDFDone": { "title": "done", "oneOf": [