User Manual

Production Jobs and Imposing

Updated on

1. Create a Production Job

Production Jobs allows importing and management of print data, technical and qualitative verification of PDF-based files, imposing and final transfer of the data to the printer. Basically, the Workflow is used as a RIP and controls the printer for output.

In earlier versions of the Workflow (before 1.7.6) the Create a Production Job Function used to be POST /api/v1/productionJobs. One of the reasons for this change is that with /api/v1/productionJobs/validate we have also implemented a validation function into the Workflow (for integration development purposes) and standardised the naming system. With GET /api/v1/productionJobs/{id} it is then also possible to retrieve information about the Production Job created.

POST /api/v1/productionJobs/create

1.1. Parameters

Type Name Description Schema
Body productionJobApi required productionJobApi ProductionJobApi
Body ReferencedColorPolicyApi required ReferencedColorPolicyApi ReferencedColorPolicyApi
Body MotifApiCreate optional MotifApiCreate MotifApiCreate
Body ReferencedSubstrateShapeApi optional ReferencedSubstrateShapeApi ReferencedSubstrateShapeApi
Body FileLinkApi optional FileLinkApi FileLinkApi

1.2. Responses

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

1.3. Consumes 

application/json

1.4. Produces 

*/*

1.5. Tags

Production Job Controller Api

1.6. Example HTTP request

Request path

/api/v1/productionJobs/create

Request body

{
  "externalId": "EXT-123",
  "name": "Create Production Job",
  "comment": "Comment",
  "shippingDate": "2019-12-10",
  "productionDate": "2019-08-19T13:37:00Z",
  "colorPolicyReference": {
    "id": 3
  },
  "substrateShapeReference": {
    "id": 3
  },
  "motifs": [
    {
      "externalId": "EXT-123",
      "name": "Label 123",
      "checkinTemplateGuid": "47e8e6c4-2ebc-412f-b427-e6393e66b67e",
      "comment": "string",
      "widthMm": 210,
      "heightMm": 297,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "INSIDE",
      "orientationTypeKey": "TOP",
      "colorPolicyReference": {
        "id": 3
      },
      "pdfFileLink": {
        "externalId": "EXT-123",
        "uri": "https://domain.at:443/path/to/file.pdf"
      },
      "additionalFilesList": [
        {
          "externalId": "EXT-123",
          "uri": "https://domain.at:443/path/to/file.pdf"
        }
      ]
    }
  ]
}

1.7. Example HTTP response

Response 201

{
  "id": 26,
  "externalId": "EXT-123",
  "name": "Create Production Job",
  "comment": "Comment",
  "shippingDate": "2019-12-10",
  "productionDate": "2019-08-19T13:37:00Z",
  "colorPolicyReference": {
    "id": 3
  },
  "substrateShapeReference": {
    "id": 3
  },
  "motifs": [
    {
      "id": 72,
      "externalId": "EXT-123",
      "name": "Label 123",
      "comment": "string",
      "widthMm": 210,
      "heightMm": 297,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "INSIDE",
      "orientationTypeKey": "TOP",
      "colorPolicyReference": {},
      "additionalFilesList": []
    }
  ]
}
2. Create a Production Job using an Output Template

Creating a Production Job with certain Output Setting using an Output Template

When creating a Production job either an Output Setting (outputTemplateReference) or a Color Policy (colorPolicyReference) is required

POST /api/v1/productionJobs/create

2.1. Parameters

Type Name Description Schema
Body productionJobApi required productionJobApi ProductionJobApi
Body ReferencedColorPolicyApi required ReferencedColorPolicyApi ReferencedColorPolicyApi
Body MotifApiCreate optional MotifApiCreate MotifApiCreate
Body ReferencedSubstrateShapeApi optional ReferencedSubstrateShapeApi ReferencedSubstrateShapeApi
Body FileLinkApi optional FileLinkApi FileLinkApi

2.2. Responses

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

2.3. Consumes 

application/json

2.4. Produces 

*/*

2.5. Tags

Production Job Controller Api

2.6. Example HTTP request

Request path

/api/v1/productionJobs/create

Request body

{
  "externalId": "EXT-123",
  "name": "Create Production Job",
  "comment": "Comment",
  "shippingDate": "2019-12-10",
  "productionDate": "2019-08-19T13:37:00Z",
  "outputTemplateReference": {
    "id": 5
  },
  "motifs": [
    {
      "externalId": "EXT-123",
      "name": "Label 123",
      "comment": "string",
      "pages": 1,
      "numberCopies": 100,
      "pdfFileLink": {
        "externalId": "EXT-123",
        "uri": "https://domain.at:443/path/to/file.pdf"
      }
    }
  ]
}

2.7. Example HTTP response

Response 201

{
  "id": 341,
  "externalId": "EXT-123",
  "status": "OUTPUT_CONFIG_ASSIGNED",
  "name": "Create Production Job",
  "comment": "Comment",
  "shippingDate": "2019-12-10",
  "productionDate": "2019-08-19T13:37:00Z",
  "motifs": [
    {
      "id": 3879,
      "externalId": "EXT-123",
      "status": "CREATED",
      "name": "Label 123",
      "comment": "string",
      "pages": 1,
      "numberCopies": 100,
      "colorPolicyReference": {
        "id": 2
      }
    }
  ],
  "colorPolicyReference": {
    "id": 2
  },
  "substrateShapeReference": {
    "id": 4
  }
}
3. Validate a Production Job

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

POST /api/v1/productionJobs/validate

3.1. Parameters

Type Name Description Schema
Body productionJobApi required productionJobApi ProductionJobApi
Body ReferencedColorPolicyApi required ReferencedColorPolicyApi ReferencedColorPolicyApi
Body MotifApiCreate optional MotifApiCreate MotifApiCreate
Body ReferencedSubstrateShapeApi optional ReferencedSubstrateShapeApi ReferencedSubstrateShapeApi
Body FileLinkApi optional FileLinkApi FileLinkApi

3.2. Responses

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

3.3. Consumes 

application/json

3.4. Produces 

*/*

3.5. Tags

Production Job Controller Api

3.6. Example HTTP request

Request path

/api/v1/productionJobs/validate

Request body

{
  "externalId": "EXT-123",
  "name": "Create Production Job",
  "comment": "Comment",
  "shippingDate": "2019-12-10",
  "productionDate": "2019-08-19T13:37:00Z",
  "colorPolicyReference": {
    "id": 3
  },
  "substrateShapeReference": {
    "id": 3
  },
  "motifs": [
    {
      "externalId": "EXT-123",
      "name": "Label 123",
      "status": "CREATED",
      "comment": "string",
      "widthMm": 210,
      "heightMm": 297,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "INSIDE",
      "orientationTypeKey": "TOP",
      "colorPolicyReference": {
        "id": 3
      },
      "pdfFileLink": {
        "externalId": "EXT-123",
        "id": 0,
        "uri": "https://domain.at:443/path/to/file.pdf"
      },
      "additionalFilesList": [
        {
          "externalId": "EXT-123",
          "id": 0,
          "uri": "https://domain.at:443/path/to/file.pdf"
        }
      ]
    }
  ]
}

3.7. Example HTTP response

Response 201

{
    "ok": true,
    "validationFailures": []
}
4. Get a Production Job

Get a response of all stored data of a specific Production Job by ID, including Color Policy, Substrates and a list of included Motifs / Print Items.

GET /api/v1/productionJobs/{id}

4.1. Parameters

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

4.2. Responses

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

4.3. Consumes 

application/json

4.4. Produces 

*/*

4.5. Tags

Production Job Controller Api

4.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}

4.7. Example HTTP response

Response 200

{
  "id": 26,
  "externalId": "EXT-123",
  "name": "Create Production Job",
  "comment": "Comment",
  "shippingDate": "2019-12-10",
  "productionDate": "2019-08-19T13:37:00Z",
  "colorPolicyReference": {
    "id": 3
  },
  "substrateShapeReference": {
    "id": 3
  },
  "motifs": [
    {
      "id": 72,
      "externalId": "EXT-123",
      "name": "Label 123",
      "status": "CHECKED_IN",
      "comment": "string",
      "widthMm": 210,
      "heightMm": 297,
      "pages": 1,
      "numberCopies": 100,
      "windingTypeKey": "INSIDE",
      "orientationTypeKey": "TOP",
      "colorPolicyReference": {},
      "additionalFilesList": []
    }
  ]
}
5. Create an empty Production Job

With the Workflow 1.7.8 a new function was introduced to add existing articles to a Production Job. So it is possible now, to create am empty Production Job without creating Print Items and then add existing Articles.

POST /api/v1/productionJobs/create

5.1. Parameters

Type Name Description Schema
Body productionJobApi required productionJobApi ProductionJobApi
Body ReferencedColorPolicyApi required ReferencedColorPolicyApi ReferencedColorPolicyApi
Body MotifApiCreate optional MotifApiCreate MotifApiCreate
Body ReferencedSubstrateShapeApi optional ReferencedSubstrateShapeApi ReferencedSubstrateShapeApi
Body FileLinkApi optional FileLinkApi FileLinkApi

5.2. Responses

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

5.3. Consumes 

application/json

5.4. Produces 

*/*

5.5. Tags

Production Job Controller Api

5.6. Example HTTP request

Request path

/api/v1/productionJobs/create

Request body

{
  "name": "Production Job without Print Item",
  "shippingDate": "2020-07-07",
  "productionDate": "2007-07-07T00:37:00Z",
  "colorPolicyReference": {
    "id": 13
  }
}

5.7. Example HTTP response

Response 201

{
  "id": 3389,
  "status": "OUTPUT_CONFIG_ASSIGNED",
  "name": "Production Job without Print Item",
  "shippingDate": "2020-07-07",
  "productionDate": "2007-07-07T00:37:00Z",
  "motifs": [],
  "colorPolicyReference": {
    "id": 1
  },
  "substrateShapeReference": {
    "id": 1
  }
}
6. Create an empty Production Job using an Output Template

With the Workflow 1.7.8 a new function was introduced to add existing articles to a Production Job. So it is possible now, to create am empty Production Job without creating Print Items and then add existing Articles. Creating an empty Production Job with certain Output Setting using an Output Template

POST /api/v1/productionJobs/create

6.1. Parameters

Type Name Description Schema
Body productionJobApi required productionJobApi ProductionJobApi
Body ReferencedColorPolicyApi required ReferencedColorPolicyApi ReferencedColorPolicyApi
Body MotifApiCreate optional MotifApiCreate MotifApiCreate
Body ReferencedSubstrateShapeApi optional ReferencedSubstrateShapeApi ReferencedSubstrateShapeApi
Body FileLinkApi optional FileLinkApi FileLinkApi

6.2. Responses

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

6.3. Consumes 

application/json

6.4. Produces 

*/*

6.5. Tags

Production Job Controller Api

6.6. Example HTTP request

Request path

/api/v1/productionJobs/create

Request body

{
  "name": "Production Job without Print Item",
  "shippingDate": "2020-07-07",
  "productionDate": "2007-07-07T00:37:00Z",
  "outputTemplateReference": {
    "id": 3
  }
}

6.7. Example HTTP response

Response 201

{
  "id": 1341,
  "status": "OUTPUT_CONFIG_ASSIGNED",
  "name": "Production Job without Print Item",
  "shippingDate": "2020-07-07",
  "productionDate": "2007-07-07T00:37:00Z",
  "motifs": [],
  "colorPolicyReference": {
    "id": 15
  },
  "substrateShapeReference": {
    "id": 9
  }
}
7. List all linked Print Items of a Production Job

List all linked Print Items of a Production Job

GET /api/v1/productionJobs/{id}/motifs

7.1. Parameters

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

7.2. Responses

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

7.3. Consumes 

application/json

7.4. Produces 

*/*

7.5. Tags

Production Job Motif Controller

7.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/motifs

7.7. Example HTTP response

Response 200

[
  {
    "id": 12026,
    "status": "CHECKED_IN",
    "name": "New Print Item",
    "widthMm": 307.722,
    "heightMm": 170.406,
    "pages": 1,
    "numberCopies": 43,
    "colorPolicyReference": {
      "id": 5
    }
  }
]
8. Get a Print Item of a Production Job

List all linked Print Items of a Production Job

GET /api/v1/productionJobs/{id}/motifs/{id}

8.1. Parameters

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

8.2. Responses

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

8.3. Consumes 

application/json

8.4. Produces 

*/*

8.5. Tags

Production Job Motif Controller

8.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/motifs/{id}

8.7. Example HTTP response

Response 200

{
  "id": 12026,
  "status": "CHECKED_IN",
  "name": "New Print Item",
  "widthMm": 307.722,
  "heightMm": 170.406,
  "pages": 1,
  "numberCopies": 43,
  "colorPolicyReference": {
    "id": 5
  }
}
9. Update a Print Item of a Production Job

The status of a motif within a Production Job 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 depend on whether the original Motif is an Article (Article from Article List was assigned to a Production Job) or a Motif from a Print Order or Production Job. This can be determined from the new motifType attribute. The possible statuses for Articles are CREATED, CHECKED_IN, CHECK_REQUIRED, FINAL_ARTWORK, WAITING_FOR_APPROVAL, APPROVED and LOCKED as well as CREATED, CHECKED_IN, CHECK_REQUIRED, READY_FOR_PRINT, WAITING_FOR_APPROVAL, APPROVED, IMPOSED, SENT_TO_PRINTER, PRINTED and QUANTITY_REACHED for Motifs. These statuses are also synchronised with the underlying original document.

PATCH /api/v1/productionJobs/{id}/motifs/{id}

9.1. Parameters

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

9.2. Responses

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

9.3. Consumes 

application/json

9.4. Produces 

*/*

9.5. Tags

Production Job Motif Controller

9.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/motifs/{id}

Request Body

{
  "status": "WAITING_FOR_APPROVAL"
}

9.7. Example HTTP response

Response 200

{
  "externalId": "EXT-123",
  "name": "Print Item 1",
  "comment": "Comment",
  "widthMm": 210,
  "heightMm": 297,
  "pages": 1,
  "numberCopies": 23,
  "windingTypeKey": "INSIDE",
  "orientationTypeKey": "TOP",
  "colorPolicyReference": {
    "id": 1
  },
  "id": 11100,
  "status": "WAITING_FOR_APPROVAL",
  "motifType": "motif"
}
10. Create a Print Item and assign it to a Production Job

Add a Print Item to an existing Production Job

POST /api/v1/productionJobs/{id}/motifs/create

10.1. Parameters

Type Name Description Schema
Path id required The ID of a Production Job integer (int32)
Body motifApiCreate required MotifApiCreate MotifApiCreate

10.2. Responses

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

10.3. Consumes 

application/json

10.4. Produces 

*/*

10.5. Tags

Production Job Motif Controller

10.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/motifs/create

Request body

{
  "name": "New Print Item",
  "numberCopies": "43",
  "checkinTemplateGuid": "47e8e6c4-2ebc-412f-b427-e6393e66b67e",
  "pdfFileLink": {
    "externalId": "EXT-123",
    "uri": "https://domain.at/path/to/file.pdf"
  }
}

10.7. Example HTTP response

Response 201

{
  "id": 12026,
  "status": "CREATED",
  "name": "New Print Item",
  "colorPolicyReference": {
    "id": 5
  }
}
11. Fetch Output Templates

List all available Output Templates. 
Output Templates are created and managed in the Workflow and can be used for creating a Production Job using the Rest-API.

GET /api/v1/outputTemplates

11.1. Parameters

Type Name Description Schema
Body OutputTemplateApi required OutputTemplateApi OutputTemplateApi

11.2. Responses

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

11.3. Produces 

*/*

11.4. Tags

Output Template Controller Api

11.5. Example HTTP request

Request path

/api/v1/outputTemplates

11.6. Example HTTP response

Response 200

[
  {
    "id": 1,
    "name": "Test Output Template"
  },
  {
    "id": 2,
    "name": "TAU 330 RSC Output"
  },
  {
    "id": 3,
    "name": "TAU 330 RSC Output Extreme Save"
  },
  {
    "id": 4,
    "name": "Rhotex with Simulation"
  }
]
12. Fetch Output Template details

Fetch a specific Output Template.
Output Templates are created and managed in the Workflow and can be used for creating a Production Job using the Rest-API. 

GET /api/v1/outputTemplates/{id}

12.1. Parameters

Type Name Description Schema
Body OutputTemplateApi required OutputTemplateApi OutputTemplateApi
Path id required The ID of the Impose Template integer (int32)

12.2. Responses

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

12.3. Produces 

*/*

12.4. Tags

Output Template Controller Api

12.5. Example HTTP request

Request path

/api/v1/outputTemplates/{id}

12.6. Example HTTP response

Response 200

{
  "id": 3,
  "name": "TAU 330 RSC Output Extreme Save"
}
13. Fetch Impose Templates

Impose Templates are created and stored in the Workflow and can be used to impose print data for a Production Job via the API. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/templates

13.1. Parameters

Type Name Description Schema
Body ImposeRequestOptionsApi required ImposeRequestOptionsApi ImposeRequestOptionsApi
Body ReferencedImposeTemplateApi required ReferencedImposeTemplateApi ReferencedImposeTemplateApi

13.2. Responses

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

13.3. Produces 

*/*

13.4. Tags

Impose Template Controller Api

13.5. Example HTTP request

Request path

/api/v1/impose/templates

13.6. Example HTTP response

Response 200

[
  {
    "id": 1,
    "name": "Default Template",
    "type": "STEP_AND_REPEAT",
    "defaultTemplate": true
  },
  {
    "id": 2,
    "name": "Default Template Nesting",
    "type": "NESTING",
    "defaultTemplate": true
  },
  {
    "id": 3,
    "name": "Default Tiling",
    "type": "TILING",
    "defaultTemplate": true
  }
]
14. Fetch Impose Template details

Impose Templates are created and stored in the Workflow and can be used to impose print data for a Production Job via the API. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/templates/{id}

14.1. Parameters

Type Name Description Schema
Body ImposeRequestOptionsApi required ImposeRequestOptionsApi ImposeRequestOptionsApi
Body ReferencedImposeTemplateApi required ReferencedImposeTemplateApi ReferencedImposeTemplateApi
Path id required The ID of the Impose Template integer (int32)

14.2. Responses

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

14.3. Produces 

*/*

14.4. Tags

Impose Template Controller Api

14.5. Example HTTP request

Request path

/api/v1/impose/templates/{id}

14.6. Example HTTP response

Response 200

{
  "id": 22,
  "name": "My Impose Template",
  "type": "STEP_AND_REPEAT",
  "defaultTemplate": false
}
15. Fetch Sheet Templates

Sheet Templates are created and stored in the Workflow in the Impose Editor and can be used to impose print data for a Production Job via the API with a certain Sheet definition. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/sheetTemplates

15.1. Parameters

Type Name Description Schema
Body ImposeSheetTemplateApi required ImposeSheetTemplateApi ImposeSheetTemplateAPI

15.2. Responses

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

15.3. Produces 

*/*

15.4. Tags

Impose Template Controller Api

15.5. Example HTTP request

Request path

/api/v1/impose/sheetTemplates

15.6. Example HTTP response

Response 200

[
  {
    "id": 1,
    "name": "Default"
  },
  {
    "id": 11,
    "name": "All color bars Template"
  },
  {
    "id": 21,
    "name": "SmartMarks Sheet Template"
  }
]
16. Fetch Sheet Template details

Sheet Templates are created and stored in the Workflow in the Impose Editor and can be used to impose print data for a Production Job via the API with a certain Sheet definition. The IDs of the available Templates are listed in the Workflow under User Settings..

GET /api/v1/impose/sheetTemplates/{id}

16.1. Parameters

Type Name Description Schema
Body ImposeSheetTemplateApi required ImposeSheetTemplateApi ImposeSheetTemplateApi
Path id required The ID of the Sheet Template integer (int32)

16.2. Responses

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

16.3. Produces 

*/*

16.4. Tags

Impose Template Controller Api

16.5. Example HTTP request

Request path

/api/v1/impose/sheetTemplates/{id}

16.6. Example HTTP response

Response 200

{
  "id": 21,
  "name": "SmartMarks Sheet Template"
}
17. Fetch Plate Templates

Plate Templates are created and stored in the Workflow inside Impose editor and can be used to impose print data for a Production Job via the API with additional Plate settings. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/plateTemplates

17.1. Parameters

Type Name Description Schema
Body ImposePlateTemplateApi required ImposePlateTemplateApi ImposePlateTemplateApi

17.2. Responses

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

17.3. Produces 

*/*

17.4. Tags

Impose Template Controller Api

17.5. Example HTTP request

Request path

/api/v1/impose/plateTemplates

17.6. Example HTTP response

Response 200

[
  {
    "id": 13,
    "name": "Offsetplatte Template",
    "comment": "Comment"
  },
  {
    "id": 26,
    "name": "Platte 600 x 600 | CMYKcm Channels | ColPol & PJ Name"
  }
]
18. Fetch Plate Template details

Plate Templates are created and stored in the Workflow inside Impose editor and can be used to impose print data for a Production Job via the API with additional Plate settings. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/plateTemplates/{id}

18.1. Parameters

Type Name Description Schema
Body ImposePlateTemplateApi required ImposePlateTemplateApi ImposePlateTemplateApi
Path id required The ID of the Plate Template integer (int32)

18.2. Responses

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

18.3. Produces 

*/*

18.4. Tags

Impose Template Controller Api

18.5. Example HTTP request

Request path

/api/v1/impose/plateTemplates/{id}

18.6. Example HTTP response

Response 200

{
  "id": 13,
  "name": "Offsetplatte Template",
  "comment": "123"
}
19. Fetch Print Item Templates

Print Item (Motif) Templates are created and stored in the Workflow inside Impose editor and can be used to impose print data for a Production Job via the API with additional Plate settings. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/motifTemplates

19.1. Parameters

Type Name Description Schema
Body ImposeMotifTemplateApi required ImposeMotifTemplateApi ImposeMotifTemplateApi

19.2. Responses

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

19.3. Produces 

*/*

19.4. Tags

Impose Template Controller Api

19.5. Example HTTP request

Request path

/api/v1/impose/motifTemplates

19.6. Example HTTP response

Response 200

[
  {
    "id": 1,
    "name": "Default",
    "type": "DEFAULT"
  },
  {
    "id": 2,
    "name": "Default Double-Sided Output",
    "type": "DOUBLEPAGE"
  }
]
20. Fetch Print Item Template details

Print Item (Motif) Templates are created and stored in the Workflow inside Impose editor and can be used to impose print data for a Production Job via the API with additional Plate settings. The IDs of the available Templates are listed in the Workflow under User Settings.

GET /api/v1/impose/motifTemplates/{id}

20.1. Parameters

Type Name Description Schema
Body ImposeMotifTemplateApi required ImposeMotifTemplateApi ImposeMotifTemplateApi
Path id required The ID of the motifTemplate integer (int32)

20.2. Responses

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

20.3. Produces 

*/*

20.4. Tags

Impose Template Controller Api

20.5. Example HTTP request

Request path

/api/v1/impose/motifTemplates/{id}

20.6. Example HTTP response

Response 200

{
  "id": 2,
  "name": "Default Double-Sided Output",
  "type": "DOUBLEPAGE"
}
21. Impose a Production Job using an Impose Template

Apply an Impose Template to a Production Job.

Step and Repeat Templates can only be applied to a Production Job if all Print Items have the same size. 

POST /api/v1/productionJobs/{id}/impose

21.1. Parameters

Type Name Description Schema
Body ImposeRequestOptionsApi required ImposeRequestOptionsApi ImposeRequestOptionsApi
Body ReferencedImposeTemplateApi required ReferencedImposeTemplateApi ReferencedImposeTemplateApi
Path id required The ID of the Production Job integer (int32)

21.2. Responses

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

21.3. Consumes 

application/json

21.4. Produces 

*/*

21.5. Tags

Production Job Controller Api

21.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/impose

Request body

{
  "referencedImposeTemplateApi": {
    "id": 22
  }
}

21.6.1. Example HTTP response

Response 200

{
  "id": 1322,
  "status": "IMPOSED",
  "name": "Production",
  "shippingDate": "2021-12-10",
  "productionDate": "2021-08-19T13:37:00Z",
  "motifs": [
    {
      "name": "Print Item 1",
      "widthMm": 145,
      "heightMm": 170,
      "pages": 1,
      "numberCopies": 27,
      "colorPolicyReference": {
        "id": 4
      },
      "id": 28237,
      "status": "IMPOSED",
      "motifType": "motif",
      "dropdown": "Option2",
      "additionalinfo": "Lorem ipsum dolor sit amet"
    }
  ],
  "colorPolicyReference": {
    "id": 4
  },
  "substrateShapeReference": {
    "id": 8
  }
}
22. Impose a Production Job using Impose/Sheet/Plate/Motif Templates

Apply an Impose Template to a Production Job.

Plate, Sheet and Motif Templates are optional. If just the Impose Template is used their defaults are used for Imposition.

POST /api/v1/productionJobs/{id}/impose

22.1. Parameters

Type Name Description Schema
Body ImposeRequestOptionsApi required ImposeRequestOptionsApi ImposeRequestOptionsApi
Body ReferencedImposeTemplateApi required ReferencedImposeTemplateApi ReferencedImposeTemplateApi
Body ReferencedPlateTemplateApi optional    
Body ReferencedSheetTemplateApi optional    
Body ReferencedMotifTemplateApi optional    
Path id required The ID of the Production Job integer (int32)

22.2. Responses

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

22.3. Consumes 

application/json

22.4. Produces 

*/*

22.5. Tags

Production Job Controller Api

22.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/impose

Request body

{
  "referencedImposeTemplateApi": {
    "id": 12
  },
  "referencedImposePlateTemplateApi": {
    "id": 25
  },
  "referencedImposeSheetTemplateApi": {
    "id": 5
  },
  "referencedImposeMotifTemplateApi": {
    "id": 3
  }
}

22.6.1. Example HTTP response

Response 200

{
  "id": 1322,
  "status": "IMPOSED",
  "name": "Production",
  "shippingDate": "2021-12-10",
  "productionDate": "2021-08-19T13:37:00Z",
  "motifs": [
    {
      "name": "Print Item 1",
      "widthMm": 145,
      "heightMm": 170,
      "pages": 1,
      "numberCopies": 27,
      "colorPolicyReference": {
        "id": 4
      },
      "id": 28237,
      "status": "IMPOSED",
      "motifType": "motif",
      "dropdown": "Option2",
      "additionalinfo": "Lorem ipsum dolor sit amet"
    }
  ],
  "colorPolicyReference": {
    "id": 4
  },
  "substrateShapeReference": {
    "id": 8
  }
}
23. Fetch Thumbnail or PDF Preview of a Production Job.

Fetch a Thumbnail or PDF Preview of a Production Job. The Print Item that is checked in first is used for the preview unless the Production Job is Imposed. Available Download Formats are Direct Download or Base64 encrypted.

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

23.1. Parameters

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

23.2. Responses

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

23.3. Produces 

*/*

23.4. Tags

Production Job Controller Api

23.5. Example HTTP request

Request path

/api/v1/productionJobs/{id}/files/{fileTypeKey}/{downloadFormat}
24. Send to Printer

Send the Production Job to the Printer

GET /api/v1/productionJobs/{id}/sendToPrinter

24.1. Parameters

Type Name Description Schema
Path id required The ID of the Production Job integer (int32)

24.2. Responses

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

24.3. Consumes 

application/json

24.4. Produces 

*/*

24.5. Tags

Production Job Controller Api

24.6. Example HTTP request

Request path

/api/v1/productionJobs/{id}/sendToPrinter

24.6.1. Example HTTP response

Response 200

{
  "id": 1361,
  "externalId": "EXTNR123",
  "status": "OUTPUT_CONFIG_ASSIGNED",
  "name": "API Test Production Job 3 Items",
  "comment": "Further Information of Production Job",
  "shippingDate": "2019-12-10",
  "productionDate": "2020-01-21T13:37:00Z",
  "colorPolicyReference": {
    "id": 61
  },
  "substrateShapeReference": {
    "id": 12
  },
  "motifs": [
    {
      "id": 7044,
      "externalId": "EXT-123",
      "status": "READY_FOR_PRINT",
      "name": "Print Item 3",
      "comment": "Comment on Print Item 3",
      "widthMm": 66,
      "heightMm": 136,
      "pages": 2,
      "numberCopies": 81,
      "orientationTypeKey": "TOP",
      "colorPolicyReference": {
        "id": 61
      },
      "additionalFilesList": []
    },
    {
      "id": 7043,
      "externalId": "EXT-123",
      "status": "READY_FOR_PRINT",
      "name": "Print Item 2",
      "comment": "Comment on Print Item 2",
      "widthMm": 50,
      "heightMm": 130,
      "pages": 1,
      "numberCopies": 12,
      "colorPolicyReference": {
        "id": 61
      },
      "additionalFilesList": []
    },
    {
      "id": 7042,
      "externalId": "EXT-123",
      "status": "READY_FOR_PRINT",
      "name": "Print Item 1",
      "comment": "Comment on Print Item 1",
      "widthMm": 61.383,
      "heightMm": 145.034,
      "pages": 1,
      "numberCopies": 72,
      "windingTypeKey": "INSIDE",
      "orientationTypeKey": "TOP",
      "colorPolicyReference": {
        "id": 61
      },
      "additionalFilesList": []
    }
  ]
}
Previous Article Print Orders, Print Order Items and Print Items
Next Article Substrates

Connect Workflow with External Systems

Rest API Documentation – Workflow 21

Other Resources
Print Article