Misc

1. Set User-defined Fields for Articles, Print Orders and Print Order Items

Compatibility: from Durst Workflow v1.7.6

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print +

User-defined Fields can only be created by a system administrator within the Durst Workflow. The system administrator must decide which fields or which field types should be added to which areas. To get a list of available User-defined Fields please take a look at the chapters on how to get active User-defined Fields for Articles and Print Orders and Print Order Items and Production Jobs.

1.1. Tags

Article Controller Api
Print Order Controller Api
Motif Controller Api
Production Job Controller Api

To set the corresponding User-defined Fields you just have to put the parameters within the Request either for Creating an Article, Print Order Item (Motif) or Print order.

1.2. Example HTTP request

Request path

POST /api/v1/articles/create

Request Body

{
    "externalId": "EXT-123",
    "name": "Label 123",
    "comment": "string",
    "infodv": "This is a Text",
    "checkbox1":true,
    "date": "2019-09-09",
    "checkbox2":false,
    "datetime": "2019-08-30T19:49:20.587Z",
    "dropdown": "Option2",
    "numericfield": "1.23456789",
    "widthMm": 210,
    "heightMm": 297,
    "pages": 1,
    "customerReference": {
        "id": 6
    },
    "substrateReference": {
        "id": 2
    },
    "pdfFileLink": {
        "externalId": "EXT-123",
        "uri": "https://domain.at:443/path/to/file.pdf"
    }
}

In this example the User-defined Field infodv for an Article is filled with a string. 

To prevent a Bad Request, it's necessary to provide data corresponding to the Field Type defined in the Durst Workflow. The Field Types that are available are: Boolean Expression, Numeric, Text: Single Line (String), Text: Multiple Lines (String), Selection Field (String), Date, Date & Time.

2. Workflows

Compatibility: from Durst Workflow v1.7.6

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print /  Durst Workflow Print +

Some responses within Body provide a Workflow ID. It's usually used for functions that need some time for the whole process, like Ink Cost Calculation and Applying Fixups. By using the Workflow ID it's possible to monitor the Workflows' process steps.

Compatibility: from Durst Workflow v1.8.2

Available in
Durst Workflow Print Label / Durst Workflow Print Label +
Durst Workflow Print /  Durst Workflow Print +

The Subscription Controller now allows a subscription to internal processes. This includes, for example, the Split Pages and the Apply Fixup function. Every process that is started is transmitted to a defined endpoint after it has been executed (status SUCCESS or ERROR). In the case of splitPages, the transmitted data also includes the IDs of the new Articles and Motifs. The topic field has  been updated for this purpose.

WORFKLOW/* - Subscription to all processes triggered by motif-split-pages, motif-apply-profile, calculate-ink-usage
WORKFLOW/motif-split-pages - Subscription to processes triggered by motif-split-pages
WORKFLOW/133 - Subscription to a defined workflow

GET /api/v1/workflows/{id} 

2.1. Parameters

Type Name Description Schema
Path id required The id of the Workflow integer (int32)

2.2. Responses

HTTP Code Description Schema
200 OK WorkflowApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

2.3. Consumes

application/json

2.4. Produces

*/*

2.5. Tags

Article Controller Api
Print Order Controller Api
Motif Controller Api
Fixup Controller Api
Workflow Controller Api

2.6. Example HTTP request

Request path

/api/v1/workflows/{id} 

2.7. Example HTTP response

Response 200

{
  "id": 7621,
  "name": "production-job-calculate-ink-usage",
  "progress": 100,
  "status": "SUCCESS",
  "currentStep": "updateWorkflowStatusTask",
  "stateMessage": "Painting (Black - 71%)",
  "startTimestamp": "2019-09-26T15:17:09.783",
  "endTimestamp": "2019-09-26T15:17:18.566",
  "executionTime": 9
}