REST API Reference

Exposes methods for authenticated access (login & password) to the PReS Connect REST API. Uses a combination of basic and token based authorisation.

Exposes methods for the manual creation, monitoring & cancellation of new Print context based content creation operations within the workflow, including a method for accessing the result of a successful operation. Also exposes methods for generating preview PDFs of print output for single data records.

Exposes methods specific to the Content Item entity type including property value accessor methods and an associated data record lookup method.

Exposes methods specific to the Content Set entity type including property value accessor methods, methods to access all content sets and delete specific content sets, and a method to access the content item IDs contained within a specific content set.

Exposes methods specific to the Data Record entity type including accessor methods for data records and the value & property values for a specific data record. Also exposes a method for adding new records to an existing data record or data set.

Exposes methods specific to the Data Set entity type including property value accessor methods, methods to access all data sets and delete specific data sets, and a method to access the data record IDs contained within a specific data set.

Exposes methods for the manual creation, monitoring & cancellation of data mapping operations within the workflow, including a method for accessing the result of a successful operation. Also exposes methods for basic data mapping pass-throughs specific to PDF VT data files.

Exposes methods specific to the Document entity type including metadata property value accessor methods.

Exposes methods specific to the Document Set entity type including metadata property value accessor methods, and a method to access the document IDs contained within a specific document set.

Exposes methods for the manual creation, monitoring & cancellation of new Email context based content creation operations within the workflow, including a method for accessing the result of a successful operation.

Exposes a method for the selection of data (of a specific entity type) using various search criteria.

Exposes methods specific to file store operations in PReS Connect including the upload of data files, data mapping configurations, design templates, job creation presets & output creation presets. Also exposes methods for the download and deletion of existing managed files in the file store.

Exposes methods for the manual creation of new Web context based content. Also exposes an additional method to access the resources withing the Web context of a design template.

Exposes methods for the manual creation, monitoring & cancellation of job creation operations within the workflow, including a method for accessing the result of a successful operation.

Exposes methods specific to the Job entity type including property and metadata property value accessor methods, a method to access the content items contained within a specific job, and a method to access the job segment IDs contained within a specific job.

Exposes methods specific to the Job Segment entity type including metadata property value accessor methods, and a method to access the document set IDs contained within a specific job segment.

Exposes methods specific to the Job Set entity type including property and metadata property value accessor methods, methods to access all jobs sets and delete specific data sets, and a method to access the job IDs contained within a specific job set.

Exposes methods for the manual creation, monitoring & cancellation of output creation operations within the workflow, including methods for accessing the result of a successful operation.