User Manual

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

2.14 Splitting Documents

Updated on

1. Splitting Articles

Compatibility: from Durst Workflow v1.8.2

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

An Article  with x number of Pages is split into single Articles. To fetch the IDs of the new Articles use the Subscription Services or fetch the IDs from the workflows Response. 

POST /api/v1/articles/{id}/splitPages

1.1. Parameters

Type
 Name
 Description
 Schema
Path id required
 The Articles unique ID integer (int32)

1.2. Responses

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

1.3. Consumes 

application/json

1.4. Produces 

*/*

1.5. Tags

Article Controller Api

1.6. Example HTTP request

Request path

POST /api/v1/articles/{id}/splitPages

1.7. Example HTTP response

The Response includes the ID for the internal process (workflow).

Response 201

{
  "id": 4454,
  "name": "motif-split-pages",
  "status": "RUNNING",
  "progress": 0,
  "currentStep": "splitPages",
  "startTimestamp": "2021-01-26T13:57:39.281528+01:00"
}

1.8. Example HTTP request

By using GET /api/v1/workflows/{id} with the ID the result of the splitting process can be fetched listing the internal IDs of the split Articles.
Tipp: Wait for the workflow status to be set to SUCCESS ("status": "SUCCESS") before fetching the IDs. Depending on number of pages and complexity the process can take a while.

Request path

GET /api/v1/workflows/{id}

1.9. Example HTTP response

Response 201

{
  "id": 4458,
  "name": "motif-split-pages",
  "status": "SUCCESS",
  "progress": 100,
  "currentStep": "updateWorkflowStatus",
  "stateMessage": "Render To Buffer Page 1",
  "startTimestamp": "2021-01-26T14:07:24.047796+01:00",
  "endTimestamp": "2021-01-26T14:08:15.081474+01:00",
  "splitPagesMotifMap": {
    "1": {
      "id": 8085,
      "name": "Article Multipage Page_0001",
      "status": "CHECK_REQUIRED",
      "widthMm": 66,
      "heightMm": 136,
      "pages": 1,
      "customerReference": {},
      "substrateReference": {
        "id": 3
      },
      "colorPolicyReference": {
        "id": 3
      },
      "articleCollectionReferenceList": [],
      "articleProcessingStepList": []
    },
    "2": {
      "id": 8086,
      "name": "Article Multipage Page_0002",
      "status": "CHECK_REQUIRED",
      "widthMm": 66,
      "heightMm": 136,
      "pages": 1,
      "customerReference": {},
      "substrateReference": {
        "id": 3
      },
      "colorPolicyReference": {
        "id": 3
      },
      "articleCollectionReferenceList": [],
      "articleProcessingStepList": []
    },
    "3": {
      "id": 8087,
      "name": "Article Multipage Page_0003",
      "status": "CHECK_REQUIRED",
      "widthMm": 66,
      "heightMm": 136,
      "pages": 1,
      "customerReference": {},
      "substrateReference": {
        "id": 3
      },
      "colorPolicyReference": {
        "id": 3
      },
      "articleCollectionReferenceList": [],
      "articleProcessingStepList": []
    },
    "4": {
      "id": 8088,
      "name": "Article Multipage Page_0004",
      "status": "CHECK_REQUIRED",
      "widthMm": 66,
      "heightMm": 136,
      "pages": 1,
      "customerReference": {},
      "substrateReference": {
        "id": 3
      },
      "colorPolicyReference": {
        "id": 3
      },
      "articleCollectionReferenceList": [],
      "articleProcessingStepList": []
    }
  },
  "executionTime": 51
}
2. Splitting a Print Item within a Print Order

Compatibility: from Durst Workflow v1.8.2

Available in  
Durst Workflow Print Label +
Durst Workflow Print +

A Print Item with x number of Pages is split into single Print Items. To fetch the IDs of the new Print Items use the Subscription Service or fetch the IDs from the workflows Response.

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

2.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)

2.2. Responses

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

2.3. Consumes 

application/json

2.4. Produces 

*/*

2.5. Tags

Print Order Motif Controller Api

2.6. Example HTTP request

Request path

POST /api/v1/articles/{id}/splitPages

2.7. Example HTTP response

The Response includes the ID for the internal process (workflow).

Response 201

{
  "id": 4454,
  "name": "motif-split-pages",
  "status": "RUNNING",
  "progress": 0,
  "currentStep": "splitPages",
  "startTimestamp": "2021-01-26T13:57:39.281528+01:00"
}

2.8. Example HTTP request

By using GET /api/v1/workflows/{id} with the ID the result of the splitting process can be fetched listing the internal IDs of the split Motifs.
Tipp: Wait for the workflow status to be set to SUCCES ("status": "SUCCESS") before fetching the IDs. Depending on number of pages and complexity the process can take a while.

Request path

GET /api/v1/workflows/{id}

2.9. Example HTTP response

Response 201

{
  "id": 5195,
  "name": "motif-split-pages",
  "status": "SUCCESS",
  "progress": 100,
  "currentStep": "updateWorkflowStatus",
  "stateMessage": "Render To Buffer Page 1",
  "startTimestamp": "2021-02-02T11:47:27.070029+01:00",
  "endTimestamp": "2021-02-02T11:50:04.336923+01:00",
  "splitPagesMotifMap": {
    "1": {
      "id": 11108,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0001",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    },
    "2": {
      "id": 11110,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0002",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    },
    "3": {
      "id": 11111,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0003",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    },
    "4": {
      "id": 11112,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0004",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    }
  },
  "executionTime": 157
}
3. Splitting a Print Item within a Production Job

Compatibility: from Durst Workflow v1.8.2

Available in  
Durst Workflow Print Label +
Durst Workflow Print +

A Print Item with x number of Pages is split into single Print Items. To fetch the IDs of the new Print Items use the Subscription Service or fetch the IDs from the workflows Response.

POST /api/v1/productionJobs/{id}/motifs/{motifId}/splitPages

3.1. Parameters

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

3.2. Responses

HTTP Code Description Schema
201 Created WorkflowApi
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 Motif Controller Api

3.6. Example HTTP request

Request path

POST /api/v1/productionJobs/{id}/motifs/{motifId}/splitPages

3.7. Example HTTP response

The Response includes the ID for the internal process (workflow).

Response 201

{
  "id": 4877,
  "name": "motif-split-pages",
  "status": "RUNNING",
  "progress": 0,
  "currentStep": "splitPages",
  "startTimestamp": "2021-01-26T13:57:39.281528+01:00"
}

3.8. Example HTTP request

By using GET /api/v1/workflows/{id} with the ID the result of the splitting process can be fetched listing the internal IDs of the split Motifs.
Tipp: Wait for the workflow status to be set to SUCCES ("status": "SUCCESS") before fetching the IDs. Depending on number of pages and complexity the process can take a while.

Request path

GET /api/v1/workflows/{id}

3.9. Example HTTP response

Response 201

{
  "id": 5195,
  "name": "motif-split-pages",
  "status": "SUCCESS",
  "progress": 100,
  "currentStep": "updateWorkflowStatus",
  "stateMessage": "Render To Buffer Page 1",
  "startTimestamp": "2021-02-02T11:47:27.070029+01:00",
  "endTimestamp": "2021-02-02T11:50:04.336923+01:00",
  "splitPagesMotifMap": {
    "1": {
      "id": 11108,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0001",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    },
    "2": {
      "id": 11110,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0002",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    },
    "3": {
      "id": 11111,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0003",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    },
    "4": {
      "id": 11112,
      "externalId": "EXT-123",
      "status": "CHECK_REQUIRED",
      "name": "Multipage Page_0004",
      "comment": "Many Pages",
      "widthMm": 140,
      "heightMm": 80,
      "pages": 1,
      "numberCopies": 125,
      "windingTypeKey": "INSIDE",
      "colorPolicyReference": {
        "id": 3
      }
    }
  },
  "executionTime": 157
}
Previous Article 2.13 Fetching Preflight Results
Next Article 2.15 Misc

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