redocly logoAPI docs by Redocly

Adobe Experience Manager Forms as a Cloud Service - Communications (1.0.0-oas3)

Adobe Experience Manager Forms as a Cloud Service - Communications APIs.

Find out more

Introduction

Communications APIs help you combine XFA-based XDP or PDF templates and Acrobat Forms (AcroForm) with XML data to generate print documents in various formats. It enables you to create applications that let you:

  • Generate documents by populating template files with XML data. For example, receipts, bills, and statements.
  • Generate forms in various formats, including non-interactive PDF print streams.
  • Generate print PDFs from XFA form PDFs.
  • Generate PDF, PostScript, PCL, and ZPL documents in bulk by merging multiple sets of data with source templates.

These APIs help generate documents in bulk. To setup you environment to use the APIs, see Use batch processing

Download the definition file

The API reference documentation is also available in the .yaml format. You can download the .yaml for batch APIs and upload it to postman to check functionality of the APIs.

Communications Services

Communications Services Capabilities

Batch Configuration

Configuration of a Batch Job

Create a batch configuration

Request Body schema: application/json
configName
required
string (ConfigName)
dataSourceConfigUri
required
string

This is the location of data source configuration containing details of cloud config (authentication info for cloud account), source (location for data files), and destinatin (location for output files generated and failure information details).

object

This inline data source object gets returned as part of BatchState

outputTypes
required
Array of strings (OutputType)
Items Enum: "PDF" "PRINT"

It contains details of the output formats requested for generation. PDF, representing PDF format; and PRINT representing all non-PDF formats e.g. PCL, PostScript etc.

template
required
string

The template defines appearance and behavior of the PDF document. The API supports templates of format - XDP and PDF document. You can specify a reference path of your Adobe Experience Manager Repository.

xci
string

The service uses an XCI configuration file to configure various properties of the PDF document. The XCI parameter has an effect only when the template is of type XDP or an XDP-based PDF document.

contentRoot
string

Root location within an Adobe Experience Manager repository to resolve template from.

object (PDFOutputOptions)

Various options for the API

Array of objects (PrintedOutputOptions)

It contains detailled configuration parameters which allow control over PRINT file generation.

Responses

Request samples

Content type
application/json
{
  • "configName": "string",
  • "dataSourceConfigUri": "string",
  • "dataSource": {
    },
  • "outputTypes": [
    ],
  • "template": "string",
  • "xci": "string",
  • "contentRoot": "string",
  • "pdfOutputOptions": {
    },
  • "printedOutputOptionsList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Get a batch config by config name

path Parameters
configName
required
string (ConfigName)

config name

Responses

Response samples

Content type
application/json
{
  • "configName": "string",
  • "dataSourceConfigUri": "string",
  • "dataSource": {
    },
  • "outputTypes": [
    ],
  • "template": "string",
  • "xci": "string",
  • "contentRoot": "string",
  • "pdfOutputOptions": {
    },
  • "printedOutputOptionsList": [
    ]
}

Update a batch config by config name

path Parameters
configName
required
string (ConfigName)

config name

Request Body schema: application/json
configName
required
string (ConfigName)
dataSourceConfigUri
required
string

This is the location of data source configuration containing details of cloud config (authentication info for cloud account), source (location for data files), and destinatin (location for output files generated and failure information details).

object

This inline data source object gets returned as part of BatchState

outputTypes
required
Array of strings (OutputType)
Items Enum: "PDF" "PRINT"

It contains details of the output formats requested for generation. PDF, representing PDF format; and PRINT representing all non-PDF formats e.g. PCL, PostScript etc.

template
required
string

The template defines appearance and behavior of the PDF document. The API supports templates of format - XDP and PDF document. You can specify a reference path of your Adobe Experience Manager Repository.

xci
string

The service uses an XCI configuration file to configure various properties of the PDF document. The XCI parameter has an effect only when the template is of type XDP or an XDP-based PDF document.

contentRoot
string

Root location within an Adobe Experience Manager repository to resolve template from.

object (PDFOutputOptions)

Various options for the API

Array of objects (PrintedOutputOptions)

It contains detailled configuration parameters which allow control over PRINT file generation.

Responses

Request samples

Content type
application/json
{
  • "configName": "string",
  • "dataSourceConfigUri": "string",
  • "dataSource": {
    },
  • "outputTypes": [
    ],
  • "template": "string",
  • "xci": "string",
  • "contentRoot": "string",
  • "pdfOutputOptions": {
    },
  • "printedOutputOptionsList": [
    ]
}

Response samples

Content type
application/json
{
  • "configName": "string",
  • "dataSourceConfigUri": "string",
  • "dataSource": {
    },
  • "outputTypes": [
    ],
  • "template": "string",
  • "xci": "string",
  • "contentRoot": "string",
  • "pdfOutputOptions": {
    },
  • "printedOutputOptionsList": [
    ]
}

Delete a batch config by config name

path Parameters
configName
required
string (ConfigName)

config name

Responses

Response samples

Content type
application/json
{
  • "configName": "string",
  • "dataSourceConfigUri": "string",
  • "dataSource": {
    },
  • "outputTypes": [
    ],
  • "template": "string",
  • "xci": "string",
  • "contentRoot": "string",
  • "pdfOutputOptions": {
    },
  • "printedOutputOptionsList": [
    ]
}

Get all batch configurations

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Batch Execution

Execution Instances of a Batch Job

Start the batch execution

path Parameters
configName
required
string (ConfigName)

config name

Request Body schema: application/json
object (BatchConfig)

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Get batch execution details for a specific batch execution

path Parameters
configName
required
string (ConfigName)

config name

executionId
required
string (ExecutionId)

execution identifier

Responses

Response samples

Content type
application/json
{
  • "configName": "string",
  • "executionId": "string",
  • "config": {
    },
  • "status": "PROCESSING",
  • "outputStatuses": [
    ],
  • "recordsCount": 0,
  • "startTime": 0,
  • "endTime": 0,
  • "errorInfo": {
    }
}

Get state of all batch instances being executed

path Parameters
configName
required
string (ConfigName)

config name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}