User ManualAutomation Durst Workflow Rest API DocumentationPrint Orders, Print Order Items and Print Items

Print Orders, Print Order Items and Print Items

1. Get all Print Orders

Compatibility: from Durst Workflow v1.7.7

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

Get all Print Orders. Depending on the number of Print Orders performing this Request can take a while. The size of the output JSON can be big.

GET /api/v1/printOrders

1.1. Responses

HTTP Code Description Schema
200 OK PrintOrderApi, PrintOrderItemApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

1.2. Consumes

application/json

1.3. Produces

*/*

1.4. Tags

Print Order Controller Api

1.5. Example HTTP request

Request path

/api/v1/printOrders

1.6. Example HTTP response

Response 200

[
  {
    "id": 5,
    "externalId": "EXT-123",
    "name": "Label 123",
    "status": "CREATED",
    "comment": "Comment",
    "orderNumber": "123",
    "customerReference": {
      "id": 6
    },
    "invoiceAddressReference": {
      "id": 5
    },
    "printOrderItems": [
      {
        "id": 6,
        "externalId": "EXT-123",
        "name": "PrintOrderItem1",
        "status": "CREATED",
        "comment": "Comment",
        "deliveryDate": "2019-12-01",
        "substrateCategoryReference": {
          "id": 2
        },
        "substrateReference": {
          "id": 2
        },
        "deliveryAddressReference": {
          "id": 5
        },
        "deliveryContactReference": {},
        "motifs": [
          {
            "id": 36,
            "externalId": "EXT-123",
            "name": "PrintItem1",
            "status": "CHECKED_IN",
            "comment": "string",
            "widthMm": 210,
            "heightMm": 297,
            "pages": 1,
            "numberCopies": 67,
            "windingTypeKey": "INSIDE",
            "orientationTypeKey": "TOP",
            "colorPolicyReference": {
              "id": 3
            },
            "additionalFilesList": []
          }
        ]
      }
    ]
  },
  {
    "id": 6,
    "externalId": "EXT-123",
    "name": "Label 123",
    "status": "CREATED",
    "comment": "Comment",
    "orderNumber": "123",
    "customerReference": {
      "id": 6
    },
    "invoiceAddressReference": {
      "id": 5
    },
    "printOrderItems": [
      {
        "id": 6,
        "externalId": "EXT-123",
        "name": "PrintOrderItem2",
        "status": "CREATED",
        "comment": "Comment",
        "deliveryDate": "2019-12-02",
        "substrateCategoryReference": {
          "id": 2
        },
        "substrateReference": {
          "id": 2
        },
        "deliveryAddressReference": {
          "id": 5
        },
        "deliveryContactReference": {},
        "motifs": [
          {
            "id": 36,
            "externalId": "EXT-123",
            "name": "PrintItem2",
            "status": "CHECKED_IN",
            "comment": "string",
            "widthMm": 210,
            "heightMm": 297,
            "pages": 1,
            "numberCopies": 67,
            "windingTypeKey": "INSIDE",
            "orientationTypeKey": "TOP",
            "colorPolicyReference": {
              "id": 3
            },
            "additionalFilesList": []
          }
        ]
      }
    ]
  }
]
2. Create a Print Order

Compatibility: from Durst Workflow v1.7.5

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

Our integrated Order processing allows you to manage Orders including Print Data as well as all relevant Customer and production information such as delivery date, delivery address etc.

POST /api/v1/printOrders/create

2.1. Parameters

Type
Name
Description
Schema
Body
printOrderApiCreate required
Attributes for Print Order PrintOrderApiCreate
Body
ReferencedCustomerApi required
Link to a Customer ReferencedCustomerApi
Body
ReferencedAddressApi optional
Link to an Address ReferencedAddressApi
Body
PrintOrderItemApiCreate optional
Create a Print Order Item PrintOrderItemApiCreate
Body
MotifApiCreate optional
Create a Print Item
MotifApiCreate
Body
ReferencedSubstrateCategoryApi required
Link to a Substrate Category
ReferencedSubstrateCategoryApi
Body
ReferencedSubstrateApi optional
Link to a Substrate
ReferencedSubstrateApi
Body
FileLinkApi optional
Path to the File FileLinkApi
Body
ReferencedColorPolicyApi optional
Link to a Color Policy
ReferencedColorPolicyApi

2.2. Responses

HTTP Code Description Schema
201 Created PrintOrderApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

2.3. Consumes

application/json

2.4. Produces

*/*

2.5. Tags

Print Order Controller Api

2.6. Example HTTP request

Request path

/api/v1/printOrders/create

Request body

{
  "externalId": "EXT-123",
  "name": "Label 123",
  "comment": "Comment",
  "orderNumber": "123",
  "customerReference": {
    "id": 6
  },
  "invoiceAddressReference": {
    "id": 5
  },
  "printOrderItems": [
    {
      "externalId": "EXT-123",
      "name": "PrintOrderItem1",
      "comment": "Comment",
      "deliveryDate": "2019-12-01",
      "substrateCategoryReference": {
        "id": 2
      },
      "substrateReference": {
        "id": 2
      },
      "deliveryAddressReference": {
        "id": 5
      },
      "deliveryContactReference": {
        "id": 7
      },
      "motifs": [
        {
          "externalId": "EXT-123",
          "name": "PrintOrderItem1",
          "comment": "string",
          "widthMm": 210,
          "heightMm": 297,
          "pages": 1,
          "numberCopies": 67,
          "windingTypeKey": "INSIDE",
          "orientationTypeKey": "TOP",
          "colorPolicyReference": {
            "id": 3
          },
          "pdfFileLink": {
            "externalId": "EXT-123",
            "uri": "https://domain.at:443/path/to/file.pdf"
          }
        }
      ]
    }
  ]
}

2.7. Example HTTP response

Response 201

{
    "id": 5,
    "externalId": "EXT-123",
    "name": "Label 123",
    "status": "CREATED",
    "comment": "Comment",
    "orderNumber": "123",
    "customerReference": {
        "id": 6
    },
    "invoiceAddressReference": {
        "id": 5
    },
    "printOrderItems": [
        {
            "id": 6,
            "externalId": "EXT-123",
            "name": "PrintOrderItem1",
            "comment": "Comment",
            "deliveryDate": "2019-12-01",
            "substrateCategoryReference": {
                "id": 2
            },
            "substrateReference": {
                "id": 2
            },
            "deliveryAddressReference": {
                "id": 5
            },
            "deliveryContactReference": {},
            "motifs": [
                {
                    "id": 36,
                    "externalId": "EXT-123",
                    "name": "PrintOrderItem1",
                    "comment": "string",
                    "widthMm": 210,
                    "heightMm": 297,
                    "pages": 1,
                    "numberCopies": 67,
                    "windingTypeKey": "INSIDE",
                    "orientationTypeKey": "TOP",
                    "colorPolicyReference": {
                        "id": 3
                    },
                    "additionalFilesList": []
                }
            ]
        }
    ]
}
3. Get active User-defined Fields for Print Orders

Compatibility: from Durst Workflow v1.7.6

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

Get active User-defined Fields for a Print Order. User-defined Fields can only be created by a system administrator. The system administrator must decide which fields or which field types should be added to which areas.

POST /api/v1/printOrders/customFields

3.1. Responses

HTTP Code Description Schema
200 OK PrintOrderApi, CustomFieldApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

3.2. Consumes

application/json

3.3. Produces

*/*

3.4. Tags

Print Order Controller Api

3.5. Example HTTP request

Request path

/api/v1/printOrders/customFields

3.6. Example HTTP response

Response 200

[
    {
        "id": 3,
        "key": "package",
        "entityType": "print_order",
        "label": "Package Type",
        "valueTypeKey": "STRING",
        "status": "ACTIVE",
        "mandatory": false
    }
]
4. Validate a Print Order

Compatibility: from Durst Workflow v1.7.5

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

This function enables you to check whether all parameters are correct without transferring the data directly into the system. Of course, this validation is also done automatically when creating Print Orders. An alternative possibility is to check everything in advance during the development of an API integration.

POST /api/v1/printOrders/validate

4.1. Parameters

Type
Name
Description
Schema
Body
printOrderApiCreate required
Attributes for Print Order PrintOrderApiCreate
Body
ReferencedCustomerApi required
Link to a Customer ReferencedCustomerApi
Body
ReferencedAddressApi optional
Link to an Address ReferencedAddressApi
Body
PrintOrderItemApiCreate optional
Create a Print Order Item PrintOrderItemApiCreate
Body
MotifApiCreate optional
Create a Print Item
MotifApiCreate
Body
ReferencedSubstrateCategoryApi optional
Link to a Substrate Category
ReferencedSubstrateCategoryApi
Body
ReferencedSubstrateApi optional
Link to a Substrate
ReferencedSubstrateApi
Body
FileLinkApi optional
Path to the File FileLinkApi
Body
ReferencedColorPolicyApi optional
Link to a Color Policy
ReferencedColorPolicyApi

4.2. Responses

HTTP Code Description Schema
201 Created PrintOrderApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

4.3. Consumes

application/json

4.4. Produces

*/*

4.5. Tags

Print Order Controller Api

4.6. Example HTTP request

Request path

/api/v1/printOrders/validate

Request body

{
  "externalId": "EXT-123",
  "name": "Label 123",
  "comment": "Comment",
  "orderNumber": "123",
  "customerReference": {
    "id": 6
  },
  "invoiceAddressReference": {
    "id": 5
  },
  "printOrderItems": [
    {
      "externalId": "EXT-123",
      "name": "PrintOrderItem1",
      "comment": "Comment",
      "deliveryDate": "2019-12-01",
      "substrateCategoryReference": {
        "id": 2
      },
      "substrateReference": {
        "id": 2
      },
      "deliveryAddressReference": {
        "id": 5
      },
      "deliveryContactReference": {
        "id": 7
      },
      "motifs": [
        {
          "externalId": "EXT-123",
          "name": "PrintOrderItem1",
          "comment": "string",
          "widthMm": 210,
          "heightMm": 297,
          "pages": 1,
          "numberCopies": 67,
          "windingTypeKey": "INSIDE",
          "orientationTypeKey": "TOP",
          "colorPolicyReference": {
            "id": 3
          },
          "pdfFileLink": {
            "externalId": "EXT-123",
            "uri": "https://domain.at:443/path/to/file.pdf"
          }
        }
      ]
    }
  ]
}

4.7. Example HTTP response

Response 200

{
    "ok": true,
    "validationFailures": []
}
5. Delete a Print Order

Compatibility: from Durst Workflow v1.7.7

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

Delete a existing Print Order by its ID. Deleted Print Orders can not be restored. By deleting Print Orders all referenced Print Order Items and Print Items (Motifs) are being deleted.

DEL /api/v1/printOrders/{id}

5.1. Parameters

Type
Name
Description
Schema
Path id required
ID of the Print Order integer (int32)

5.2. Responses

HTTP Code Description Schema
200 OK No Content
204 No Content No Content
401 Unauthorized
No Content
403 Not Found No Content

5.3. Consumes

application/json

5.4. Produces

*/*

5.5. Tags

Print Order Controller Api

5.6. Example HTTP request

Request path

/api/v1/printOrders/{id}
6. Get Print Order by ID

Compatibility: from Durst Workflow v1.7.5

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

Get a specific Print Order and its stored information by ID.

GET /api/v1/printOrders/{id}

6.1. Parameters

Type
Name
Description
Schema
Path
id required
ID of the Print Order integer (int32)

6.2. Responses

HTTP Code Description Schema
200 OK PrintOrderApi, PrintOrderItemApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

6.3. Consumes

application/json

6.4. Produces

*/*

6.5. Tags

Print Order Controller Api

6.6. Example HTTP request

Request path

/api/v1/printOrders/{id}

6.7. Example HTTP response

Response 200

{
  "id": 5,
  "externalId": "EXT-123",
  "name": "Label 123",
  "status": "CREATED",
  "comment": "Comment",
  "orderNumber": "123",
  "customerReference": {
    "id": 6
  },
  "invoiceAddressReference": {
    "id": 5
  },
  "printOrderItems": [
    {
      "id": 6,
      "externalId": "EXT-123",
      "name": "PrintOrderItem1",
      "status": "CREATED",
      "comment": "Comment",
      "deliveryDate": "2019-12-01",
      "substrateCategoryReference": {
        "id": 2
      },
      "substrateReference": {
        "id": 2
      },
      "deliveryAddressReference": {
        "id": 5
      },
      "deliveryContactReference": {},
      "motifs": [
        {
          "id": 36,
          "externalId": "EXT-123",
          "name": "PrintOrderItem1",
          "status": "CHECKED_IN",
          "comment": "string",
          "widthMm": 210,
          "heightMm": 297,
          "pages": 1,
          "numberCopies": 67,
          "windingTypeKey": "INSIDE",
          "orientationTypeKey": "TOP",
          "colorPolicyReference": {
            "id": 3
          },
          "additionalFilesList": []
        }
      ]
    }
  ]
}
7. Update a Print Order

Compatibility: from Durst Workflow v1.7.7

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

Update an existing Print Order. These updates relate to the first level of the Print Order. Name and Comment of the Print Order, Customer Reference, Invoice Adress Reference, External ID and Order Number. To Update Print Order Items and Print Items please check out the corresponding chapters.

PUT /api/v1/printOrders/{id}

7.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Body
printOrderApiCreate required
Attributes for Print Order PrintOrderApiCreate
Body
ReferencedCustomerApi required
Link to a Customer ReferencedCustomerApi
Body
ReferencedAddressApi optional
Link to an Address ReferencedAddressApi
Body
PrintOrderItemApiCreate optional
Create a Print Order Item PrintOrderItemApiCreate
Body
MotifApiCreate optional
Create a Print Item
MotifApiCreate
Body
ReferencedSubstrateCategoryApi required
Link to a Substrate Category
ReferencedSubstrateCategoryApi
Body
ReferencedSubstrateApi optional
Link to a Substrate
ReferencedSubstrateApi
Body
FileLinkApi optional
Path to the File FileLinkApi
Body
ReferencedColorPolicyApi optional
Link to a Color Policy
ReferencedColorPolicyApi

7.2. Responses

HTTP Code Description Schema
201 Created PrintOrderApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

7.3. Consumes

application/json

7.4. Produces

*/*

7.5. Tags

Print Order Controller Api

7.6. Example HTTP request

Request path

/api/v1/printOrders/{id}

Request body

{
  "externalId": "EXT-123_UPDATE",
  "name": "Updated Name",
  "comment": "Updated Information of Order",
  "orderNumber": "123",
  "customerReference": {
    "id": 2
  },
  "invoiceAddressReference": {
    "id": 5
  }
}

7.7. Example HTTP response

Response 201

{
  "id": 117,
  "externalId": "EXT-123_UPDATE",
  "status": "CREATED",
  "name": "Updated Name",
  "comment": "Updated Information of Order",
  "orderNumber": "123",
  "customerReference": {
    "id": 2
  },
  "invoiceAddressReference": {
    "id": 5
  },
  "printOrderItems": [
    {
      "id": 175,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Label 123",
      "comment": "This is a comment on the order",
      "deliveryDate": "2019-09-10",
      "substrateCategoryReference": {
        "id": 2
      },
      "substrateReference": {
        "id": 3
      },
      "deliveryAddressReference": {
        "id": 65
      },
      "deliveryContactReference": {
        "id": 43
      },
      "motifs": [
        {
          "id": 3880,
          "externalId": "EXT-123",
          "status": "CHECKED_IN",
          "name": "Floralux",
          "comment": "Comment on Print Item 1",
          "widthMm": 215.9,
          "heightMm": 149.2,
          "pages": 1,
          "numberCopies": 75,
          "windingTypeKey": "INSIDE",
          "colorPolicyReference": {
            "id": 9
          },
          "mytextmotif": "Nothing to declare"
        },
        {
          "id": 3881,
          "externalId": "EXT-123",
          "status": "CHECKED_IN",
          "name": "Beans",
          "comment": "Comment on Print Item 2",
          "widthMm": 225,
          "heightMm": 60,
          "pages": 1,
          "numberCopies": 100,
          "windingTypeKey": "OUTSIDE",
          "orientationTypeKey": "BOTTOM",
          "colorPolicyReference": {
            "id": 9
          },
          "mytextmotif": "Nothing to declare"
        }
      ]
    }
  ],
  "customfield": 42,
  "customfield2": false
}
8. Create a Production Job from an existing Print Order

Compatibility: from Durst Workflow v1.7.5

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

This function allows you to create a Production Job from an existing Print Order. This step is mandatory when using the Send to Printer function.

POST /api/v1/printOrders/{id}/createProductionJobs

8.1. Parameters

Type
Name
Description
Schema
Path
id required
ID of the Print Order  integer (int32)

8.2. Responses

HTTP Code Description Schema
201 Created ProductionJobApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

8.3. Consumes

application/json

8.4. Produces

*/*

8.5. Tags

Print Order Controller Api

8.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/createProductionJobs

8.7. Example HTTP response

Response 201

[
    {
        "id": 14,
        "name": "Label 123_PrintOrderItem1",
        "comment": "Comment",
        "colorPolicyReference": {
            "id": 3
        },
        "substrateShapeReference": {
            "id": 3
        },
        "motifs": [
            {
                "id": 36,
                "externalId": "EXT-123",
                "name": "PrintOrderItem1",
                "status": "CHECKED_IN",
                "comment": "string",
                "widthMm": 210,
                "heightMm": 297,
                "pages": 1,
                "numberCopies": 67,
                "windingTypeKey": "INSIDE",
                "orientationTypeKey": "TOP",
                "colorPolicyReference": {
                    "id": 3
                },
                "additionalFilesList": []
            }
        ]
    }
]
9. Fetch Thumbnail or PDF Preview of a Print Order

Compatibility: from Durst Workflow v1.7.6

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

Fetch a Thumbnail or PDF Preview of a Print Order. The first image in the Order is used for this preview. For a full preview with multiple items contained in a Print Order it has to be converted to a Production Job and it must be Imposed. Available Download Formats are Direct Download or Base64 encrypted.

GET /api/v1/printOrders/{id}/files/{fileTypeKey}/{downloadFormat}

9.1. Responses

HTTP Code Description Schema
200 OK Download of the File
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

9.2. Parameters

Type
Name
Description
Schema
Path
id required
The ID of the Print Order integer (int32)
Path
downloadFormat required
Download Format of the files
enum (direct, base64)
Path
fileTypeKey required
File Type
enum (thumbnail, pdf)

9.3. Consumes

application/json

9.4. Produces

*/*

9.5. Tags

Print Order Controller Api

9.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/files/{fileTypeKey}/{downloadFormat}
10. Get Print Order Item by ID

Compatibility: from Durst Workflow v1.7.6

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

Get stored information for a specific Print Order Item (an Item already linked to a Print Order). Not to be confused with Print Item (motif).

Deprecated! Will be removed with Durst Workflow 1.7.9. Please use the GET /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId} Request instead.

GET /api/v1/printOrderItems/{id}

10.1. Parameters

Type
Name
Description
Schema
Path
id required
ID of the Print Order Item integer (int32)

10.2. Responses

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

10.3. Consumes

application/json

10.4. Produces

*/*

10.5. Tags

Print Order Print Order Item Controller

10.6. Example HTTP request

Request path

/api/v1/printOrderItems/{id}

10.7. Example HTTP response

Response 200

{
    "id": 6,
    "externalId": "EXT-123",
    "name": "PrintOrderItem1",
    "status": "IN_PRODUCTION",
    "comment": "Comment",
    "deliveryDate": "2019-12-01",
    "substrateCategoryReference": {
        "id": 2
    },
    "substrateReference": {
        "id": 2
    },
    "deliveryAddressReference": {
        "id": 5
    },
    "deliveryContactReference": {},
    "motifs": [
        {
            "id": 36,
            "externalId": "EXT-123",
            "name": "PrintOrderItem1",
            "status": "CHECKED_IN",
            "comment": "string",
            "widthMm": 210,
            "heightMm": 297,
            "pages": 1,
            "numberCopies": 67,
            "windingTypeKey": "INSIDE",
            "orientationTypeKey": "TOP",
            "colorPolicyReference": {
                "id": 3
            },
            "additionalFilesList": []
        }
    ]
}
11. Get all Print Order Item of a Print Order by ID

Compatibility: from Durst Workflow v1.7.7

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

Get stored information for all Print Order Items (an Item already linked to a Print Order) of a Print Order.

GET /api/v1/printOrders/{id}/printOrderItems

11.1. Parameters

Type
Name
Description
Schema
Path
id required
ID of the Print Order integer (int32)

11.2. Responses

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

11.3. Consumes

application/json

11.4. Produces

*/*

11.5. Tags

Print Order Item Controller

11.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems

11.7. Example HTTP response

Response 200

[
  {
    "id": 175,
    "externalId": "EXT-123",
    "status": "CREATED",
    "name": "Print Order Item 1",
    "comment": "This is a comment on the order item",
    "deliveryDate": "2019-09-10",
    "substrateCategoryReference": {
      "id": 2
    },
    "substrateReference": {
      "id": 3
    },
    "deliveryAddressReference": {
      "id": 65
    },
    "deliveryContactReference": {
      "id": 43
    },
    "motifs": [
      {
        "id": 3880,
        "externalId": "EXT-123",
        "status": "CHECKED_IN",
        "name": "Print Item 1",
        "comment": "Comment on Print Item 1",
        "widthMm": 215.9,
        "heightMm": 149.2,
        "pages": 1,
        "numberCopies": 75,
        "windingTypeKey": "INSIDE",
        "colorPolicyReference": {
          "id": 9
        },
        "customfield": "This is a custom Text for Print Item 1"
      },
      {
        "id": 3881,
        "externalId": "EXT-123",
        "status": "CHECKED_IN",
        "name": "Print Item 2",
        "comment": "Comment on Print Item 2",
        "widthMm": 225,
        "heightMm": 60,
        "pages": 1,
        "numberCopies": 100,
        "windingTypeKey": "OUTSIDE",
        "orientationTypeKey": "BOTTOM",
        "colorPolicyReference": {
          "id": 9
        },
        "customfield": "This is a custom Text for Print Item 1"
      }
    ]
  }
]
12. Create a Print Order Item within an existing Print Order

Compatibility: from Durst Workflow v1.7.7

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

Create a Print Order Item within an existing Print Order

POST /api/v1/printOrders/{id}/printOrderItems/create

12.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Body
PrintOrderItemApiCreate required
PrintOrderItemApiCreate
PrintOrderItemApiCreate
Body
ReferencedAddressApi optional
ReferencedAddressApi
ReferencedAddressApi
Body
ReferencedCustomerApi optional
ReferencedCustomerApi
ReferencedCustomerApi
Body
MotifApi optional
MotifApi
MotifApi
Body
ReferencedSubstrateCategoryApi required
ReferencedSubstrateCategoryApi
ReferencedSubstrateCategoryApi
Body
ReferencedSubstrateApi optional
ReferencedSubstrateApi
ReferencedSubstrateApi
Body
FileLinkApi optional
FileLinkApi
FileLinkApi
Body
ReferencedColorPolicyApi optional ReferencedColorPolicyApi
ReferencedColorPolicyApi

12.2. Responses

HTTP Code Description Schema
201 Created PrintOrderItemApi, MotifApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

12.3. Consumes

application/json

12.4. Produces

*/*

12.5. Tags

Print Order Item Controller

12.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/create

Request body

{
  "externalId": "EXT-123",
  "name": "New Print Order Item",
  "comment": "This is a comment on the ne Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 64
  },
  "deliveryContactReference": {
    "id": 42
  },
  "motifs": [
    {
      "externalId": "EXT-123",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "pdfFileLink": {
        "uri": "smb://127.0.0.1/data/file1.pdf"
      },
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      },
      "additionalFilesList": []
    },
    {
      "externalId": "EXT-123",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "pdfFileLink": {
        "uri": "smb://127.0.0.1/data/file2.pdf"      },
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      },
      "additionalFilesList": [
        {
        "uri": "smb://127.0.0.1/data/filedata.csv"        }
      ]
    }
  ]
}

12.7. Example HTTP response

Response 201

{
  "id": 193,
  "externalId": "EXT-123",
  "status": "CREATED",
  "name": "New Print Order Item",
  "comment": "This is a comment on the ne Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 64
  },
  "deliveryContactReference": {
    "id": 42
  },
  "motifs": [
    {
      "id": 4343,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      }
    },
    {
      "id": 4344,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      }
    }
  ]
}
13. Validate a Print Order Item

Compatibility: from Durst Workflow v1.7.7

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

Validate a Print Order Item before creating it for an existing Print Order. Validation Errors are shown in the Response Body.

POST /api/v1/printOrders/{id}/printOrderItems/validate

13.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Body
PrintOrderItemApiCreate required
PrintOrderItemApiCreate
PrintOrderItemApiCreate
Body
ReferencedAddressApi optional
ReferencedAddressApi
ReferencedAddressApi
Body
ReferencedCustomerApi optional
ReferencedCustomerApi
ReferencedCustomerApi
Body
MotifApi optional
MotifApi
MotifApi
Body
ReferencedSubstrateCategoryApi required
ReferencedSubstrateCategoryApi
ReferencedSubstrateCategoryApi
Body
ReferencedSubstrateApi optional
ReferencedSubstrateApi
ReferencedSubstrateApi
Body
FileLinkApi optional
FileLinkApi
FileLinkApi
Body
ReferencedColorPolicyApi optional ReferencedColorPolicyApi
ReferencedColorPolicyApi

13.2. Responses

HTTP Code Description Schema
201 Created PrintOrderItemApi, MotifApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

13.3. Consumes

application/json

13.4. Produces

*/*

13.5. Tags

Print Order Item Controller

13.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/validate

Request body

{
  "externalId": "EXT-123",
  "name": "New Print Order Item",
  "comment": "This is a comment on the ne Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 64
  },
  "deliveryContactReference": {
    "id": 42
  },
  "motifs": [
    {
      "externalId": "EXT-123",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "pdfFileLink": {
        "uri": "smb://127.0.0.1/data/file1.pdf"
      },
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      },
      "additionalFilesList": []
    },
    {
      "externalId": "EXT-123",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "pdfFileLink": {
        "uri": "smb://127.0.0.1/data/file2.pdf"      },
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      },
      "additionalFilesList": [
        {
        "uri": "smb://127.0.0.1/data/filedata.csv"        }
      ]
    }
  ]
}

13.7. Example HTTP response

Response 201

{
  "ok": true,
  "validationFailures": []
}
14. Delete a Print Order Item from an existing Print Order

Compatibility: from Durst Workflow v1.7.7

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

Delete a Print Order Item from an existing Print Order. Deleted Print Order Items including their Print Items can not be restored.

DEL /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}

14.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order
Integer (int32)
Path printOrderItemId required ID of the Print Order Item
Integer (int32)

14.2. Responses

HTTP Code Description Schema
200 Ok No Content
204 No Content No Content
401 Unauthorized
No Content
403 Forbidden
No Content

14.3. Consumes

application/json

14.4. Produces

*/*

14.5. Tags

Print Order Item Controller

14.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}
15. Get a Print Order Item of a Print Order by ID

Compatibility: from Durst Workflow v1.7.7

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

Get stored information of a single Order Item (an Item already linked to a Print Order) of a Print Order.

GET /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}

15.1. Parameters

Type
Name
Description
Schema
Path
id required
The ID of the Print Order Integer (int32)
Path
printOrderItemId required
The ID of the Print Order Item
Integer (int32)

15.2. Responses

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

15.3. Consumes

application/json

15.4. Produces

*/*

15.5. Tags

Print Order Item Controller

15.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}

15.7. Example HTTP response

Response 200

{
  "id": 175,
  "externalId": "EXT-123",
  "status": "CREATED",
  "name": "Print Order Item 1",
  "comment": "This is a comment on the order item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 65
  },
  "deliveryContactReference": {
    "id": 43
  },
  "motifs": [
    {
      "id": 3880,
      "externalId": "EXT-123",
      "status": "CHECKED_IN",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      },
      "customfield": "This is a custom Text for Print Item 1"
    },
    {
      "id": 3881,
      "externalId": "EXT-123",
      "status": "CHECKED_IN",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      },
      "customfield": "This is a custom Text for Print Item 1"
    }
  ]
}
16. Update a Print Order Item within an existing Print Order

Compatibility: from Durst Workflow v1.7.7

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

Update a Print Order Item within an existing Print Order. These updates relate to Print Order Items. Name and Comment of the Print Order Item, Substrate Category and Substrate Reference, Delivery Adress Reference, External ID and Delivery Date. To Update Print Order Items and Print Items please check out the corresponding chapter

POST /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}

16.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Path printOrderItemId required ID of the Print Order Item integer (int32)
Body
printOrderItemApi required
printOrderItemApi
PrintOrderItemApi
Body
ReferencedAddressApi optional
ReferencedAddressApi
ReferencedAddressApi
Body
ReferencedCustomerApi optional
ReferencedCustomerApi
ReferencedCustomerApi
Body
ReferencedSubstrateCategoryApi  required
ReferencedSubstrateCategoryApi
ReferencedSubstrateCategoryApi
Body
ReferencedSubstrateApi optional
ReferencedSubstrateApi
ReferencedSubstrateApi

16.2. Responses

HTTP Code Description Schema
201 Created PrintOrderItemApi, MotifApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

16.3. Consumes

application/json

16.4. Produces

*/*

16.5. Tags

Print Order Item Controller

16.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}

Request body

{
  "externalId": "EXT-123 UPDATE",
  "status": "CREATED",
  "name": "Print Order Item Updated Name",
  "comment": "This is a comment on the Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 4
  },
  "deliveryContactReference": {
    "id": 43
  }
}

16.7. Example HTTP response

Response 201

{
  "id": 193,
  "externalId": "EXT-123 UPDATE",
  "status": "CREATED",
  "name": "Print Order Item Updated Name",
  "comment": "This is a comment on the Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 4
  },
  "deliveryContactReference": {
    "id": 43
  },
  "motifs": [
    {
      "id": 4343,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      }
    },
    {
      "id": 4344,
      "externalId": "EXT-123",
      "status": "CHECKED_IN",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      }
    }
  ]
}
17. Get all Print Items of a Print Order Item

Compatibility: from Durst Workflow v1.7.7

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

Get stored information for all Print Items (an Item already linked to a Print Order Item) of a Print Order Item depending on a Print Order.

GET /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs

17.1. Parameters

Type
Name
Description
Schema
Path
id required
The ID of the Print Order integer (int32)
Path
printOrderItemId required
The ID of the Print Order Item
integer (int32)

17.2. Responses

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

17.3. Consumes

application/json

17.4. Produces

*/*

17.5. Tags

Print Order Motif Controller Api

17.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs

17.7. Example HTTP response

Response 200

[
  {
    "id": 4344,
    "externalId": "EXT-123",
    "status": "CHECKED_IN",
    "name": "Print Item 2",
    "comment": "Comment on Print Item 2",
    "widthMm": 225,
    "heightMm": 60,
    "pages": 1,
    "numberCopies": 100,
    "windingTypeKey": "OUTSIDE",
    "orientationTypeKey": "BOTTOM",
    "colorPolicyReference": {
      "id": 9
    }
  }
]
18. Create Print Item and assign it to the Print Order Item of the Print Order

Compatibility: from Durst Workflow v1.7.7

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

Create a Print Item within an existing Print Order.

POST /api/v1/printOrders/{id}/printOrderItems/create

18.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Path
printOrderItemId required
ID of the Print Order Item
integer (int32)
Body
MotifApiCreate required
MotifApiCreate
MotifApiCreate
Body
FileLinkApi required
FileLinkApi
FileLinkApi
Body
ReferencedColorPolicyApi optional
ReferencedColorPolicyApi
ReferencedColorPolicyApi

18.2. Responses

HTTP Code Description Schema
201 Created PrintOrderItemApi, MotifApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

18.3. Consumes

application/json

18.4. Produces

*/*

18.5. Tags

Print Order Motif Controller Api

18.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/create

Request body

{
  "externalId": "EXT-123",
  "name": "New Print Order Item",
  "comment": "This is a comment on the ne Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 64
  },
  "deliveryContactReference": {
    "id": 42
  },
  "motifs": [
    {
      "externalId": "EXT-123",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "pdfFileLink": {
        "uri": "smb://127.0.0.1/data/file1.pdf"
      },
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      },
      "additionalFilesList": []
    },
    {
      "externalId": "EXT-123",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "pdfFileLink": {
        "uri": "smb://127.0.0.1/data/file2.pdf"      },
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      },
      "additionalFilesList": [
        {
        "uri": "smb://127.0.0.1/data/filedata.csv"        }
      ]
    }
  ]
}

18.7. Example HTTP response

Response 201

{
  "id": 193,
  "externalId": "EXT-123",
  "status": "CREATED",
  "name": "New Print Order Item",
  "comment": "This is a comment on the ne Print Order Item",
  "deliveryDate": "2019-09-10",
  "substrateCategoryReference": {
    "id": 2
  },
  "substrateReference": {
    "id": 3
  },
  "deliveryAddressReference": {
    "id": 64
  },
  "deliveryContactReference": {
    "id": 42
  },
  "motifs": [
    {
      "id": 4343,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 215.9,
      "heightMm": 149.2,
      "pages": 1,
      "numberCopies": 75,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 9
      }
    },
    {
      "id": 4344,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 225,
      "heightMm": 60,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "OUTSIDE",
      "orientationTypeKey": "BOTTOM",
      "colorPolicyReference": {
        "id": 9
      }
    }
  ]
}
19. Validate a Print Item

Compatibility: from Durst Workflow v1.7.7

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

Validate a Print  Item before creating it for an existing Print Order. Validation Errors are shown in the Response Body.

POST /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/validate

19.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Path
printOrderItemId required
ID of the Print Order Item
integer (int32)
Body
MotifApiCreate required
MotifApiCreate
MotifApiCreate
Body
FileLinkApi required
FileLinkApi
FileLinkApi
Body
ReferencedColorPolicyApi optional
ReferencedColorPolicyApi
ReferencedColorPolicyApi

19.2. Responses

HTTP Code Description Schema
201 Created PrintOrderItemApi, MotifApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

19.3. Consumes

application/json

19.4. Produces

*/*

19.5. Tags

Print Order Motif Controller Api

19.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/validate

Request body

{
  "name": "Label 123",
  "comment": "string",
  "externalId": "EXT-123",
  "heightMm": 297,
  "numberCopies": 100,
  "orientationTypeKey": "TOP",
  "pages": 1,
  "pdfFileLink": {
    "uri": "smb://127.0.0.1/data/file1.pdf"
  },
  "widthMm": 210,
  "windingTypeKey": "INSIDE",
  "colorPolicyReference": {
    "id": 9
  },
  "additionalFilesList": [
    {
      "uri": "smb://127.0.0.1/data/filedata.csv"
    }
  ]
}

19.7. Example HTTP response

Response 200

{
  "ok": true,
  "validationFailures": []
}

Response 200 with errors

{
  "ok": false,
  "validationFailures": [
    "Required attribute [MotifApiCreate.name] not set",
    "Entity [color_policy] with primary key: [955] not found."
  ]
}
20. Delete a Print Item from an existing Print Order

Compatibility: from Durst Workflow v1.7.7

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

Delete a Print Item from an existing Print Order. Deleted Print Items can not be restored.

DEL /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

20.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order
integer (int32)
Path printOrderItemId required ID of the Print Order Item
integer (int32)
Path
motifId required ID of the Motif integer (int32)

20.2. Responses

HTTP Code Description Schema
200 Ok No Content
204 No Content No Content
401 Unauthorized
No Content
403 Forbidden
No Content

20.3. Consumes

application/json

20.4. Produces

*/*

20.5. Tags

Print Order Motif Controller Api

20.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}
21. Get a Print Item of a Print Order by ID

Compatibility: from Durst Workflow v1.7.7

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

Get stored information of a single Print Item (an Item already linked to a Print Order) of a Print Order.

GET /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

21.1. Parameters

Type
Name
Description
Schema
Path
id required
The ID of the Print Order integer (int32)
Path
printOrderItemId required
The ID of the Print Order Item
integer (int32)
Path
motifID required The ID of the Motif integer (int32)

21.2. Responses

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

21.3. Consumes

application/json

21.4. Produces

*/*

21.5. Tags

Print Order Motif Controller Api

21.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

21.7. Example HTTP response

Response 200

{
  "id": 4435,
  "externalId": "EXT-123",
  "status": "CHECKED_IN",
  "name": "Print Item 1",
  "comment": "Comment on Print Item 1",
  "widthMm": 215.9,
  "heightMm": 149.2,
  "pages": 1,
  "numberCopies": 75,
  "windingTypeKey": "INSIDE",
  "colorPolicyReference": {
    "id": 9
  },
  "customfield": "Custom Field text"
}
22. Update a Print Items Status

Compatibility: from Durst Workflow v1.8.2

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

The status of a motif can now be updated by using a PATCH request. Use this function to set the status of a motif from an external system. The possible statuses are: CREATED, CHECKED_IN, CHECK_REQUIRED, READY_FOR_PRINT, WAITING_FOR_APPROVAL, APPROVED, IMPOSED, SENT_TO_PRINTER, PRINTED and QUANTITY_REACHED. This request is only for status changes. The PUT request below can be used to change other properties of the print item.

PATCH /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

22.1. Parameters

Type Name Description Schema
Path id required ID of the Print Order  integer (int32)
Path printOrderItemId required ID of the Print Order Item integer (int32)
Path motifId required ID of the Print Item integer (int32)
Body MotifApiCreate required MotifApiCreate (Status Only) MotifApiCreate

22.2. Responses

HTTP Code Description Schema
200 OK ReferencedColorPolicyApi, MotifApi
204 No Content No Content
400 Bad Request Error Code
403 Forbidden No Content
404 Not Found No Content

22.3. Consumes

application/json

22.4. Produces

*/*

22.5. Tags

Print Order Motif Controller API

22.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

Request body

{
  "status": "IMPOSED"
}

22.7. Example HTTP response

Response 200

{
  "id": 6991,
  "status": "IMPOSED",
  "name": "Item No. 554",
  "comment": "This is a comment",
  "widthMm": 210,
  "heightMm": 100,
  "pages": 1,
  "numberCopies": 100,
  "windingTypeKey": "INSIDE",
  "orientationTypeKey": "BOTTOM",
  "colorPolicyReference": {
    "id": 2
  }
}
23. Update a Print Item within an existing Print Order

Compatibility: from Durst Workflow v1.7.7

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

Update a Print Item / Motif within an existing Print Order. These updates relate to Print Items. Name and Comment of the Print Order Item,  External ID, Height, Width, Number of Copies, Orientation Type, Winding Type, Pages, and Color Policy. To Update Print Order Items and Print Items please check out the corresponding chapter

PUT /api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

23.1. Parameters

Type
Name
Description
Schema
Path id required ID of the Print Order  integer (int32)
Path
printOrderItemId required
ID of the Print Order Item
integer (int32)
Path
motifId required
ID of the Print Item
integer (int32)
Body
MotifApiCreate required
MotifApiCreate
MotifApiCreate
Body
FileLinkApi required
FileLinkApi
FileLinkApi
Body
ReferencedColorPolicyApi optional
ReferencedColorPolicyApi
ReferencedColorPolicyApi

23.2. Responses

HTTP Code Description Schema
201 Created ReferencedColorPolicyApi, MotifApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

23.3. Consumes

application/json

23.4. Produces

*/*

23.5. Tags

print-order-controller-api

23.6. Example HTTP request

Request path

/api/v1/printOrders/{id}/printOrderItems/{printOrderItemId}/motifs/{motifId}

Request body

{
  "externalId": "EXT-123",
  "name": "Print Item Name Updated",
  "comment": "Comment on Print Item 1",
  "widthMm": 226.8,
  "heightMm": 149.2,
  "pages": 1,
  "numberCopies": 10,
  "windingTypeKey": "OUTSIDE",
  "colorPolicyReference": {
    "id": 9
  }
}

23.7. Example HTTP response

Response 200

{
  "id": 4435,
  "externalId": "EXT-123",
  "status": "CHECKED_IN",
  "name": "Print Item Name Updated",
  "comment": "Comment on Print Item 1",
  "widthMm": 226.8,
  "heightMm": 149.2,
  "pages": 1,
  "numberCopies": 10,
  "windingTypeKey": "OUTSIDE",
  "colorPolicyReference": {
    "id": 9
  }
}
24. Get Print Item (Motif) by ID

Compatibility: from Durst Workflow v1.7.6

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

Get Print Item and underlying parameters by ID.

GET /api/v1/motifs/{id}

24.1. Parameters

Type
Name
Description
Schema
Path
id required
ID of the Motif integer (int32)

24.2. Responses

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

24.3. Consumes

application/json

24.4. Produces

*/*

24.5. Tags

Motif Controller Api

24.6. Example HTTP request

Request path

/api/v1/motifs/{id}

24.7. Example HTTP response

Response 200

{
  "id": 3688,
  "externalId": "EXT-123",
  "status": "CHECKED_IN",
  "name": "Label 123",
  "comment": "string",
  "widthMm": 210,
  "heightMm": 297,
  "pages": 1,
  "numberCopies": 100,
  "colorPolicyReference": {
    "id": 50
  },
  "additionalFilesList": []
}
25. Apply Fixup(s) to Print Item(s) (Motif)

Compatibility: from Durst Workflow v1.7.6

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

Fixups can be either applied to Articles or Motifs within Print Orders and Production Jobs. For more information on how to fetch available Fixups see the Chapter (Fixups).

POST /api/v1/motifs/{id}/applyFixup

25.1. Parameters

Type
Name
Description
Schema
Path id required
The id of the Article
integer (int32)
Body
fixupRequestOptionsApi required
Options and Parameters of the Fixup to be applied
fixupRequestOptionsApi
Body
ReferencedFixupApi required
The Mixup to be used ReferencedFixupApi

25.2. Responses

HTTP Code Description Schema
201 Created WorkflowControllerApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

25.3. Consumes

application/json

25.4. Produces

*/*

25.5. Tags

Motif Controller Api

25.6. Example HTTP request

Request path

/api/v1/motifs/{id}/applyFixup

Request body

{
  "fixupApiParameter": {
    "VAR_NAME_Rotate": "90"
  },
  "fixupApiReference": {
    "automationKey": "ROTATE_PAGE"
  }
}

25.7. Example HTTP response

The response contains an workflow-controller output listin progress and current steps. Refer to this Chapter to learn about the Workflow Controller.

Response 201

{
  "id": 7516,
  "name": "motif-apply-profile",
  "progress": 0,
  "status": "RUNNING",
  "currentStep": "preFlight",
  "startTimestamp": "2019-09-25T15:59:44.204",
  "executionTime": 0
}
26. Fetch Thumbnail or PDF Preview of a Print Item (Motif)

Compatibility: from Durst Workflow v1.7.6

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

Fetch a Thumbnail or PDF Preview of a Print Item. Available Download Formats are Direct Download or Base64 encrypted.

GET /api/v1/motifs/{id}/files/{fileTypeKey}/{downloadFormat}

26.1. Responses

HTTP Code Description Schema
200 OK Download of the File
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

26.2. Parameters

Type
Name
Description
Schema
Path
id required
The id of the Print Item (Motif) integer (int32)
Path
downloadFormat required
Download Format of the files
enum (direct, base64)
Path
fileTypeKey required
File Type
enum (thumbnail, pdf)

26.3. Consumes

application/json

26.4. Produces

*/*

26.5. Tags

Motif Controller Api

26.6. Example HTTP request

Request path

/api/v1/motifs/{id}/files/{fileTypeKey}/{downloadFormat}
27. Get active User-defined Fields for Print Items (Motif)

Compatibility: from Durst Workflow v1.7.6

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

Get active User-defined Fields for a Motif within a Print Order. As for internal processes, the underlying file of a Print Order Item is called the Motif. User-defined Fields can only be created by a system administrator. The system administrator must decide which fields or which field types should be added to which areas.

GET /api/v1/motifs/customFields

27.1. Responses

HTTP Code Description Schema
200 OK MotifApi, CustomFieldApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

27.2. Consumes

application/json

27.3. Produces

*/*

27.4. Tags

Motif Controller Api

27.5. Example HTTP request

Request path

/api/v1/motifs/customFields

27.6. Example HTTP response

Response 200

[
  {
    "externalId": "EXT-123",
    "id": 0,
    "key": "custom_field_key",
    "entityType": "motif",
    "label": "Label 123",
    "comment": "comment",
    "valueTypeKey": "STRING",
    "status": "ACTIVE",
    "mandatory": false
  }
]