REST API Reference

This service exposes methods concerned with server security and authentication with the PlanetPress Connect REST API.

It includes methods to facilitate the following functions:

• Authentication with the server (username & password / token based authorization)

This service exposes methods specific to the management of the content creation process for the Print context within the workflow.

It includes methods to facilitate the following functions:

• Creation, monitoring and cancellation of content creation operations for print using either a data set, data records or JSON as input

• Getting a list of all the active operations on the server

• Getting the result of a content creation operation for print

• Creation of single record preview PDFs using either a data file, data record or JSON as input

This service exposes methods specific to the access and management of content item entities internal to the server.

It includes methods to facilitate the following functions:

• Getting the data record ID associated with a content item

• Getting and updating of content item properties

This service exposes methods specific to the access and management of content set entities internal to the server.

It includes methods to facilitate the following functions:

• Getting all the content set IDs within the server

• Getting the content item IDs contained within a content set

• Getting the page details for a content set

• Getting and updating of content set properties

• Deletion of content sets from the server

This service exposes methods specific to the access and management of data record entities internal to the server.

It includes methods to facilitate the following functions:

• Addition of new data records to a data set

• Addition of new nested data records to a data record

• Getting and updating of data record values

• Getting and updating of data record properties

This service exposes methods specific to the access and management of data set entities internal to the server.

It includes methods to facilitate the following functions:

• Getting all the data set IDs within the server

• Getting the data record IDs contained within a data set

• Getting and updating of data set properties

• Deletion of data sets from the server

This service exposes methods specific to the management of the data mapping process within the workflow.

It includes methods to facilitate the following functions:

• Creation, monitoring, cancellation and validation of data mapping operations using a data file as input

• Creation, monitoring and cancellation of data mapping operations using a PDF/VT file as input

• Getting a list of all the active operations on the server

• Getting the result of a data mapping operation

This service exposes methods specific to the access and management of document entities internal to the server.

It includes methods to facilitate the following functions:

• Getting and updating of document metadata properties

This service exposes methods specific to the access and management of document set entities internal to the server.

It includes methods to facilitate the following functions:

• Getting the document IDs contained within a document set

• Getting and updating of document set metadata properties

This service exposes methods specific to the management of the content creation process for the Email context within the workflow.

It includes methods to facilitate the following functions:

• Creation, monitoring and cancellation of content creation operations for email using data records or JSON as input

• Getting a list of all the active operations on the server

• Getting the result of a content creation operation for email

This service exposes methods specific to the querying and selection of data entities internal to the server.

It includes methods to facilitate the following functions:

• Finding of data entities in the server using specific search criteria

This service exposes methods specific to the management of input and output files via the file store on the PlanetPress Connect server.

It includes methods to facilitate the following functions:

• Uploading of data files and data mapping configurations to the file store

• Uploading of design templates to the file store

• Uploading of job creation and output creation presets to the file store

• Download of managed files from the file store

• Deletion of managed files from the file store

This service exposes methods specific to the management of the content creation process for the Web context within the workflow.

It includes methods to facilitate the following functions:

• Creation of HTML output for a specific data record or JSON input

• Creation of HTML output from a design template only (no input data)

• Getting specific resources contained within a design template

This service exposes methods specific to the management of the job creation process within the workflow.

It includes methods to facilitate the following functions:

• Creation, monitoring and cancellation of job creation operations using either content sets or content items as input

• Getting a list of all the active operations on the server

• Getting the result of a job creation operation

This service exposes methods specific to the access and management of job entities internal to the server.

It includes methods to facilitate the following functions:

• Getting the data record and content item IDs associated with a job

• Getting the job segment IDs contained within a job

• Getting and updating of job properties

• Getting and updating of job metadata properties

This service exposes methods specific to the access and management of job segment entities internal to the server.

It includes methods to facilitate the following functions:

• Getting the document set IDs contained within a job segment

• Getting and updating of job segment metadata properties

This service exposes methods specific to the access and management of job set entities internal to the server.

It includes methods to facilitate the following functions:

• Getting all the job set IDs within the server

• Getting the job IDs contained within a job set

• Getting and updating of job set properties

• Getting and updating of job set metadata properties

• Deletion of job sets from the server

This service exposes methods specific to the management of the output creation process within the workflow.

It includes methods to facilitate the following functions:

• Creation, monitoring and cancellation of output creation operations using either a job set or jobs as input

• Getting a list of all the active operations on the server

• Getting the result of an output creation operation

• Running of +PReS Enhance workflow configurations via the Weaver engine