Introduction

Durst Workflow {Rest:API} description / v1.0 Rev 14 (Durst Print Workflow v1.8.1) / 2020-11-25

1. History

Date Editor Summary
2019-02-14 Mitterbauer | Rev 1 Initial Documentation
2019-07-03 Kleinlercher | Rev 2 Content: Rearranging Chapters
Added: Get active User-defined Fields available for motifs / Articles / Print Orders; Validation of Articles / Print Orders / Production Jobs; Create a Production Job from a existing Print Order; List available Substrates / Substrate Categories
Replaced: Create Productions Job has been revised (new path and parameters) 
2019-07-17 Kleinlercher | Rev 3
Content: Rearranging Chapters
Added: Create Subscribers, Subscribe to a topic (Callback URLs)
2019-08-07 Kleinlercher | Rev 4
Content: Rearranging Chapters
Added: Ink calculation for Articles and Motifs (within Production Jobs and Print Order Items), Workflows, User-defined Fields
Revised: Subscriptions
2019-08-27
Kleinlercher | Rev 5
Content: Rearranging Chapters
Added: Compatibility Notes
2019-09-09
Kleinlercher | Rev 6
Added: Fixup Controller, Apply Fixup to Article(s)
2019-10-10
Kleinlercher | Rev 7
Content: Rearranging Chapters and Content
Final specification of API Functions of Durst Durst Workflow 1.7.6
2019-11-11
Kleinlercher | Rev 8
Content: Update of Description of Login and UserAccountApi
2019-11-28
Kleinlercher | Rev 9
Added: Availability Notes; Table to explain which requests are available in which workflow version 
2020-03-31 Kleinlercher | Rev 10
Added: Create Substrate Categories / Create Substrates / Create Substrate Shapes
Added: Create, Update and Delete Print Orders / Print Order Items / Print Items
Added: Fixup Parameter Examples
Revised: Definitions
Deprecated: cf_ Prefix not necessary anymore to fill out custom fields. Please change your custom field naming
Deprecated: Get Print Order Item by ID
Final specification of API Functions of Durst Durst Workflow 1.7.7
There may have been some changes of Fixup variables and parameters. These changes are independent of the API development, because the fixups kfpx/xml files are continuously improved and adapted by our experts. Please refer to our release notes and check the variables und parameters to adapt your API implementation before updating. Use GET fixups and GET fixups/{id} to fetch the fixups details.
2020-06-09 Kleinlercher | Rev 11
Added: List Fixup Chain(s)
Added: Apply Fixup Chain to Article or Print Item
Added: Create Article and bypass Fixup Chain to be applied
Added: Create Print (Order) Item or Production Job and bypass Fixup Chain to be applied on Print Item
Added: List Report(s)
Added: Generate and Download Report of an Article or Print Item (in Print Order)
Added: Link article to existing Production Job
Added: Create new Print Item/Motif for existing Production Job
Added: List all linked Print Items of a Production Job
Added: Get a Print Item of a Production Job
Changes: When creating Production Job a Print Item/Motif is no longer required = empty Production Job
Revised: Definitions
Final specification of API Functions of Durst Durst Workflow 1.7.8
There may have been some changes of Fixup variables and parameters. These changes are independent of the API development, because the fixups kfpx/xml files are continuously improved and adapted by our experts. Please refer to our release notes and check the variables und parameters to adapt your API implementation before updating. Use GET fixups and GET fixups/{id} to fetch the fixups details.
2020-08-03 Kleinlercher | Rev 12
Revised: Definitions
Final specification of API Functions of Durst Durst Workflow 1.7.9
There may have been some changes of Fixup variables and parameters. These changes are independent of the API development, because the fixups kfpx/xml files are continuously improved and adapted by our experts. Please refer to our release notes and check the variables und parameters to adapt your API implementation before updating. Use GET fixups and GET fixups/{id} to fetch the fixups details.
2020-10-01 Kleinlercher | Rev 13 Added: Fetch the Preflight Result of an Article
Added: Fetch the Preflight Result of a Print Item within a Print Order or Production Job
Added: Fetch Preflight PDF Report of an Article or Print Item
Improvement: The descriptions of each variable of Fixups are shown in the output to make their purpose easier to understand.
Revised: Definitions
Final specification of API Functions of Durst Durst Workflow 1.8
There may have been some changes of Fixup variables and parameters. These changes are independent of the API development, because the fixups kfpx/xml files are continuously improved and adapted by our experts. Please refer to our release notes and check the variables und parameters to adapt your API implementation before updating. Use GET fixups and GET fixups/{id} to fetch the fixups details.
2020-11-25 Kleinlercher | Rev 14
Added: Fetch Output Templates
Added: Create a Production Job using an Output Template
Added: Article Create - Default Color Policy based on the defined Substrate in Response
Improvement: defaultReferencedColorPolicyApi can not be set when creating a Substrate
Revised: Definitions
Final specification of API Functions of Durst Durst Workflow 1.8.1
Fixups were revised. Setting a unit is not needed anymore for most Fixups. The unit used internally is mm (Millimeter) and has to be recalculated if inch, pt or cm are used from an external system. 
There may have been some other changes of Fixup variables and parameters too. These changes are independent of the API development, because the fixups kfpx/xml files are continuously improved and adapted by our experts. Please refer to our release notes and check the variables und parameters to adapt your API implementation before updating. Use GET fixups and GET fixups/{id} to fetch the fixups details.

2. Introduction

The Durst Workflow API provides an interface to Durst Workflow functions such as creating Articles, Print Orders and Production Jobs. It also features retrieval of applied Substrates and Substrate Categories and associated Color Policies. Status information can be returned to connected ERP/MIS systems via callback URLs (subscriptions).

The API is a REST (Representational State Transfer) service. As application layer protocols HTTP and HTTPS are used. REST unifies the interface between systems to a manageable and standardized set of actions regarding the expected behavior, which are explained in detail in this document.

Even with intensive testing and careful research, we cannot guarantee the full correctness of the documentation. Since the interface is constantly being expanded, the scope of the documentation will also change constantly. Please always note the publication date and revision number as well as the compatibility note of the used function.

3. Overview

3.1. Version Information

Version: 1.0

3.2. URI scheme

Parameter Value
Host xxx.xxx.xxx.xxx:8081
BasePath /pms
Schemes HTTP

3.3. Availability of Requests

Durst Workflow is available in different versions. Depending on the range of functions, the availability for API requests also differs.