User Manual

Check-in Templates and Check-in

Updated on

Expand or collapse content 1. List all available Check-in Templates

List all available Check-In Templates configured in Workflow

GET /api/v2/fixup/preflight/custom/templates

1.1. Responses

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

1.2. Consumes 

application/json

1.3. Produces 

*/*

1.4. Tags

fixup-api-controller

1.5. Example HTTP request

Request path

api/v2/fixup/preflight/custom/templates

1.6. Example HTTP response

Response 200

[ { "guid": "37f8a718-cb87-41f9-beb1-a6016c855578", "profileAutomationKey": "AUTOMATION_WORKFLOW_CHECKS_AND_CORRECTIONS", "name": "Workflow Default Preflight + Lift Checkin", "description": "Workflow Default Preflight" }, { "guid": "4f59d767-2966-400f-9032-e65211f3c11d", "profileAutomationKey": "AUTOMATION_WORKFLOW_CHECKS_AND_CORRECTIONS", "name": "Workflow Default Preflight", "description": "Workflow Default Preflight" }, { "guid": "ea812171-d890-41ac-92a2-c3470201b57e", "profileAutomationKey": "AUTOMATION_WORKFLOW_CHECKS_AND_CORRECTIONS", "name": "Workflow Default Preflight Minimal", "description": "Workflow Default Preflight Minimal" } ]

1.7. Result

Type Name Description Schema
Body guid The guid of a Check-In Template string (uuid)
Body name Name of the Check-In Template string
Body profileAutomationKey Key of the underlying parent Check-In Profile (by default always the same) string
Body description Description of the Check-In Template string
Expand or collapse content 2. Use Check-In Template when creating Articles / Print Items

To use a specific Check-In Template from the results, add the property "checkinTemplateGuid" followed by the specific "guid" for request where Articles or Print Items are created.

2.1. Example (Article) 

POST /api/v1/articles/create

Request path

/api/v1/articles/create
{ "name": "Article with specific Check-In Template", "checkinTemplateGuid": "47e8e6c4-2ebc-412f-b427-e6393e66b67e", "pdfFileLink": { "uri": "http://127.0.0.1/folder/file.pdf" } }
Type Name Description Schema
Body name required The name of a Motif / Article string
Body  checkinTemplateGuid
 		 The guid of the Check-In Template string (uuid)
Body  pdfFileLink optional Defining Path to the file FileLinkApi
Previous Article Splitting Documents
Next Article Print Statistics

Connecting external Systems with the Workflow

REST API Documentation – Workflow 19
Hotfolder – Processing Job Tickets 2

Other Resources
Print Article