User Manual

User Manual  /  Automation  /  2. Rest API Documentation – Workflow

2.7 Substrates

Updated on

1. List all available Substrate Categories

Compatibility: from Durst Workflow v1.7.5

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

Get a list of all available Substrate Categories created in the Durst Workflow. The term Substrate Categories refers to categories of particular types of Substrates, (e.g. cardboard, foil, film, textiles, paper, etc.) Substrate Categories have no essential function in the Workflow, other than being used for grouping and organising as well as sometimes being pre-filtered in specific dialogs.

GET /api/v1/substrateCategories

1.1. Responses

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

1.2. Consumes 

application/json

1.3. Produces 

*/*

1.4. Tags

Substrate Category Controller Api

1.5. Example HTTP request

Request path

/api/v1/substrateCategories

1.6. Example HTTP response

Response 200

[
  {
    "id": 1,
    "name": "Paper",
    "defaultReferencedSubstrateApi": {
      "id": 1
    }
  },
  {
    "id": 2,
    "name": "Adhesive Material/Opaque/Film",
    "defaultReferencedSubstrateApi": {
      "id": 2
    }
  }
]
2. Create a Substrate Category

Compatibility: from Durst Workflow v1.7.7

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

Create a new Substrate Category

POST /api/v1/substrateCategories/create

2.1. Parameters

Type Name Description Schema
Body SubstrateCategoryApiCreate required
 SubstrateCategoryApiCreate
 SubstrateCategoryApiCreate

2.2. Responses

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

2.3. Consumes 

application/json

2.4. Produces 

*/*

2.5. Tags

Substrate Category Controller Api

2.6. Example HTTP request

Request path

/api/v1/substrateCategories/create

Request Body

{
  "name": "New Substrate",
  "comment": "This is a Comment"
}

2.7. Example HTTP response

Response 201

{
  "id": 26,
  "name": "New Substrate",
  "comment": "This is a Comment",
  "defaultReferencedSubstrateApi": {}
}
3. Validate the Creation of a Substrate Category

Compatibility: from Durst Workflow v1.7.7

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

Validate the Creation of a new Substrate Category

POST /api/v1/substrateCategories/validate

3.1. Parameters

Type Name Description Schema
Body SubstrateCategoryApiCreate required
 SubstrateCategoryApiCreate
 SubstrateCategoryApiCreate

3.2. Responses

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

3.3. Consumes 

application/json

3.4. Produces 

*/*

3.5. Tags

Substrate Category Controller Api

3.6. Example HTTP request

Request path

/api/v1/substrateCategories/validate

Request Body

{
  "name": "New Substrate",
  "comment": "This is a Comment"
}

3.7. Example HTTP response

Response 201

{
  "ok": true,
  "validationFailures": [
    "string"
  ]
}
4. Update a Substrate Category

Compatibility: from Durst Workflow v1.7.7

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

Create a new Substrate Category

POST /api/v1/substrateCategories/create

4.1. Parameters

Type Name Description Schema
Path Id required ID of the Substrate Category integer (int32)
Body SubstrateCategoryApiUpdate required
 SubstrateCategoryApiUpdate
 SubstrateCategoryApiUpdate
Body
 ReferencedSubstrateApi optional
 ReferencedSubstrateApi
 ReferencedSubstrateApi

4.2. Responses

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

4.3. Consumes 

application/json

4.4. Produces 

*/*

4.5. Tags

Substrate Category Controller Api

4.6. Example HTTP request

Request path

/api/v1/substrateCategories/create

Request Body

{
  "name": "New Substrate",
  "comment": "This is a Comment"
}

4.7. Example HTTP response

Response 201

{
  "id": 26,
  "name": "New Substrate",
  "comment": "This is a Comment",
  "defaultReferencedSubstrateApi": {}
}
5. Fetch Details of a Substrate Category

Compatibility: from Durst Workflow v1.7.7

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

List the details of a existing Substrate Category

GET /api/v1/substrateCategories/{id}

5.1. Parameters

Type Name Description Schema
Path Id required ID of the Substrate Category integer (int32)

5.2. Responses

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

5.3. Consumes 

application/json

5.4. Produces 

*/*

5.5. Tags

Substrate Category Controller Api

5.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}

5.7. Example HTTP response

Response 200

{
  "id": 26,
  "name": "New Substrate",
  "comment": "This is a Comment",
  "defaultReferencedSubstrateApi": {}
}
6. List all available Substrates of a category

Compatibility: from Durst Workflow v1.7.5

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

List all available Substrates of a specific category

GET /api/v1/substrateCategories/{id}/substrates

6.1. Parameters

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

6.2. Responses

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

6.3. Consumes 

application/json

6.4. Produces 

*/*

6.5. Tags

Substrate Controller Api

6.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates

6.7. Example HTTP response

Response 200

[
  {
    "id": 3,
    "name": "Gardamatt",
    "manufacturer": "Euro Papier",
    "referencedSubstrateCategoryApi": {
      "id": 1
    },
    "defaultReferencedSubstrateShapeApi": {
      "id": 23
    },
    "defaultReferencedColorPolicyApi": {
      "id": 11
    }
  },
  {
    "id": 8,
    "name": "Gardagloss Art",
    "manufacturer": "Euro Papier",
    "referencedSubstrateCategoryApi": {
      "id": 1
    },
    "defaultReferencedSubstrateShapeApi": {
      "id": 9
    },
    "defaultReferencedColorPolicyApi": {
      "id": 145
    }
  }
]
7. Create a Substrate

Compatibility: from Durst Workflow v1.7.7

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

Create a new Substrate Category

From 1.8.1 it is not possible to set a Color Policy (defaultReferencedColorPolicyApi) when creating a Substrate. A Substrate can be created using the Rest API, but Color Profile and linking a Color Policy to the Substrate has to be done in Workflow. It is still possible to set the Color Policy by using the PUT Request, but make sure that this Color Policy is created based on the Substrate. A wrong assigned Color Policy can lead to problems in the further process.

POST /api/v1/substrateCategories/{id}/substrates/create

7.1. Parameters

Type Name Description Schema
Path Id required The ID of the Substrate Category integer (int32)
Body SubstrateApiCreate required
 SubstrateApiCreate
 SubstrateApiCreate

7.2. Responses

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

7.3. Consumes 

application/json

7.4. Produces 

*/*

7.5. Tags

Substrate Controller Api

7.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/create

Request Body

{
  "name": "Substrate Name",
  "comment": "Comment",
  "externalId": "EXT-123",
  "manufacturer": "Manufacturer Name"
}

7.7. Example HTTP response

Response 201

{
  "id": 26,
  "externalId": "EXT-123",
  "name": "Substrate Name",
  "comment": "Comment",
  "manufacturer": "Manufacturer Name",
  "defaultReferencedSubstrateShapeApi": {},
  "defaultReferencedColorPolicyApi": {}
}
8. Validate the Creation of a Substrate

Compatibility: from Durst Workflow v1.7.7

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

Validate the Creation of a new Substrate 

POST /api/v1/substrateCategories/{id}/substrates/validate

8.1. Parameters

Type Name Description Schema
Path id required The ID of the Substrate Category integer (int32)
Body SubstrateApiCreate required
 SubstrateApiCreate
 SubstrateApiCreate
Body
 ReferencedColorPolicyApi required
 ReferencedColorPolicyApi
 ReferencedColorPolicyApi

8.2. Responses

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

8.3. Consumes 

application/json

8.4. Produces 

*/*

8.5. Tags

Substrate Controller Api

8.6. Example HTTP request

Request path

/api/v1/substrateCategories/validate

Request Body

{
  "name": "Substrate Name",
  "comment": "Comment",
  "externalId": "EXT-123",
  "manufacturer": "Manufacturer Name",
}

8.7. Example HTTP response

Response 201

{
  "ok": true,
  "validationFailures": []
}
9. Update a Substrate

Compatibility: from Durst Workflow v1.7.7

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

Update a Substrate 

PUT /api/v1/substrateCategories/{id}/substrates/{substrateId}

9.1. Parameters

Type Name Description Schema
Path Id required ID of the Substrate Category Integer (int32)
Path substrateId required
 ID of the Substrate
 Integer (int32)
Body SubstrateCategoryApiUpdate required
 SubstrateCategoryApiUpdate
 SubstrateCategoryApiUpdate
Body
 ReferencedSubstrateApi optional
 ReferencedSubstrateApi
 ReferencedSubstrateApi

9.2. Responses

HTTP Code Description Schema
200 OK substrateCategoryApi
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

9.3. Consumes 

application/json

9.4. Produces 

*/*

9.5. Tags

Substrate Controller Api

9.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/{substrateId}

Request Body

{
  "name": "Substrate XYZ Update",
  "comment": "This is a Comment",
  "externalId": "EXT-123",
  "manufacturer": "Acme",
  "defaultReferencedSubstrateShapeApi": {
    "id": 22
  },
  "defaultReferencedColorPolicyApi": {
    "id": 17
  }
}

9.7. Example HTTP response

Response 200

{
  "id": 26,
  "name": "Substrate XYZ Update",
  "comment": "This is a Comment",
  "externalId": "EXT-123",
  "manufacturer": "Acme",
  "defaultReferencedSubstrateShapeApi": {
    "id": 22
  },
  "defaultReferencedColorPolicyApi": {
    "id": 17
  }
}
10. Fetch Details of a Substrate

Compatibility: from Durst Workflow v1.7.7

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

List the details of a existing Substrate

GET /api/v1/substrateCategories/{id}/substrates/{substrateId}

10.1. Parameters

Type Name Description Schema
Path Id required ID of the Substrate Category integer (int32)
Path
 substrateId required
 ID of the Substrate
 integer (int32)

10.2. Responses

HTTP Code Description Schema
200 OK SubstrateApi, ReferencedSubstrateShapeApi, ReferencedColorPolicyApi
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

10.3. Consumes 

application/json

10.4. Produces 

*/*

10.5. Tags

Substrate Controller Api

10.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/{substrateId}

10.7. Example HTTP response

Response 200

{
  "id": 26,
  "name": "Substrate XYZ Update",
  "comment": "This is a Comment",
  "externalId": "EXT-123",
  "manufacturer": "Acme",
  "defaultReferencedSubstrateShapeApi": {
    "id": 22
  },
  "defaultReferencedColorPolicyApi": {
    "id": 17
  }
}
11. List all available Substrates Shapes of a Substrate

Compatibility: from Durst Workflow v1.7.7

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

List all available Substrate Shapes of a Substrate

GET /api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes

11.1. Parameters

Type
 Name
 Description
 Schema
Path
 id required
 The id of the Substrate Cateogry
 integer (int32)
Path
 substrateId required
 The id of the Substrate
 integer (int32)

11.2. Responses

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

11.3. Consumes 

application/json

11.4. Produces 

*/*

11.5. Tags

Substrate Shape Controller Api

11.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes

11.7. Example HTTP response

Response 200

[
  {
    "id": 67,
    "externalId": "Material ID123",
    "name": "Substrate Name 2",
    "widthMm": 2500.0,
    "heightMm": 3000.0,
    "grammage": 30.0,
    "printableSides": "BOTHSIDES",
    "thickness": 1.5,
    "distortionFactorX": 1.0,
    "distortionFactorY": 1.0
  },
  {
    "id": 68,
    "externalId": "Material ID234",
    "name": "Substrate Name 2",
    "widthMm": 330.0,
    "lengthRollM": 15.0,
    "grammage": 30.0,
    "printableSides": "FRONTSIDE",
    "thickness": 1.5,
    "distortionFactorX": 1.02,
    "distortionFactorY": 1.02,
    "rollSheet": "Roll Sheet"
  }
]
12. Create a Substrate Shape

Compatibility: from Durst Workflow v1.7.7

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

Create a new Substrate Shape

POST /api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/create

12.1. Parameters

Type Name Description Schema
Path Id required The ID of the Substrate Category integer (int32)
Path
 substrateId required
 The ID of the Substrate
 integer (int32)
Body substrateShapeApi required
 substrateShapeApi
 substrateShapeApi

12.2. Responses

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

12.3. Consumes 

application/json

12.4. Produces 

*/*

12.5. Tags

Substrate Shape Controller Api

12.6. Example HTTP request

Request path

POST /api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/create

Request Body

{
    "externalId": "Material ID123",
    "name": "Substrate Name",
    "widthMm": 330.0,
    "heightMm": 3000.0,
    "grammage": 30.0,
    "printableSides": "BOTHSIDES",
    "thickness": 1.5,
    "distortionFactorX": 1.0,
    "distortionFactorY": 1.0
}

12.7. Example HTTP response

Response 201

{
  "id": 69,
  "externalId": "Material ID123",
  "name": "Substrate Name",
  "widthMm": 330,
  "heightMm": 3000,
  "distortionFactorX": 1,
  "grammage": 30,
  "printableSides": "BOTHSIDES",
  "thickness": 1.5,
  "distortionFactorY": 1
}
13. Validate the Creation of a Substrate Shape

Compatibility: from Durst Workflow v1.7.7

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

Validate the Creation of a new Substrate Shape

POST /api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/validate

13.1. Parameters

Type Name Description Schema
Path id required The ID of the Substrate Category integer (int32)
Body SubstrateApiCreate required
 SubstrateApiCreate
 SubstrateApiCreate
Body
 ReferencedColorPolicyApi required
 ReferencedColorPolicyApi
 ReferencedColorPolicyApi

13.2. Responses

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

13.3. Consumes 

application/json

13.4. Produces 

*/*

13.5. Tags

Substrate Shape Controller Api

13.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/validate

Request Body

{
    "externalId": "Material ID123",
    "name": "Substrate Name",
    "widthMm": 330.0,
    "heightMm": 3000.0,
    "grammage": 30.0,
    "printableSides": "BOTHSIDES",
    "thickness": 1.5,
    "distortionFactorX": 1.0,
    "distortionFactorY": 1.0
}

13.7. Example HTTP response

Response 201

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

Response 201 with Errors

{
  "ok": false,
  "validationFailures": [
    "Required attribute [SubstrateShapeApi_.name] not set",
    "Required attribute [SubstrateShapeApi_.widthMm] not set",
    "Value [BEIDE] for [SubstrateShapeApi_.printableSides] not allowed. Allowable values: [BOTHSIDES, FRONTSIDE, BACKSIDE]"
  ]
}
14. Update a Substrate Shape

Compatibility: from Durst Workflow v1.7.7

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

Update a Substrate  Shape

PUT /api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/{substrateShapeId}

14.1. Parameters

Type Name Description Schema
Path Id required ID of the Substrate Category Integer (int32)
Path substrateId required
 ID of the Substrate
 Integer (int32)
Path
 substrateShapeId required
 ID of the Substrate Shape
 Integer (int32)
Body SubstrateShapeApi required
 SubstrateShapeApi
 SubstrateShapeApi

14.2. Responses

HTTP Code Description Schema
200 OK SubstrateShapeApi
201 Created No Content
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

14.3. Consumes 

application/json

14.4. Produces 

*/*

14.5. Tags

Substrate Shape Controller Api

14.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/{substrateShapeId}

Request Body

{
  "name": "Substrate Name Updated",
  "externalId": "EXT-123",
  "widthMm": 330.0,
  "heightMm": 3000.0,
  "lengthRollM": 10.0,
  "grammage": 45.0,
  "printableSides": "BACKSIDE",
  "thickness": 0.5
}

14.7. Example HTTP response

Response 200

{
  "id": 69,
  "externalId": "EXT-123",
  "name": "Substrate Name Updated",
  "widthMm": 330,
  "heightMm": 3000,
  "lengthRollM": 10,
  "grammage": 45,
  "printableSides": "BACKSIDE",
  "thickness": 0.5
}
15. Fetch Details of a Substrate Shape

Compatibility: from Durst Workflow v1.7.7

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

List the details of an existing Substrate Shape

GET /api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/{substrateShapeId}

15.1. Parameters

Type Name Description Schema
Path Id required ID of the Substrate Category integer (int32)
Path
 substrateId required
 ID of the Substrate
 integer (int32)
Path
 substrateShapeId required
 ID of the Substrate Shape
 integer (int32)

15.2. Responses

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

15.3. Consumes 

application/json

15.4. Produces 

*/*

15.5. Tags

Substrate Shape Controller Api

15.6. Example HTTP request

Request path

/api/v1/substrateCategories/{id}/substrates/{substrateId}/substrateShapes/{substrateShapeId}

15.7. Example HTTP response

Response 200

{
  "id": 69,
  "externalId": "EXT-123",
  "name": "Substrate Name Updated",
  "widthMm": 330,
  "heightMm": 3000,
  "lengthRollM": 10,
  "grammage": 45,
  "printableSides": "BACKSIDE",
  "thickness": 0.5
}
Previous Article 2.6 Production Jobs and Imposing
Next Article 2.8 Subscriptions and Status Callback

Automation

1. Integration Possibilities 1
2. Rest API Documentation – Workflow 18
3. Rest API Documentation – Durst Analytics 10

Other Resources
Print Article
Still Need Help? Contact Us