User Manual

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

2.16 Print Statistics

Updated on

1. Filter Options

Compatibility: from Durst Workflow v1.14.1

Available in
Durst Workflow Print Label +
Durst Workflow Print + 

List all filter options that can be used for the Job Statistics list. 

GET /api/v2/any-job-statistic/meta/filter-options

1.1. Responses

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

1.2. Consumes 

application/json

1.3. Produces 

*/*

1.4. Tags

any-job-statistic-api-controller

1.5. Example HTTP request

Request path

GET /api/v2/any-job-statistic/meta/filter-options

1.6. Example HTTP response

The response contains filter properties that can be used as filter and search terms

Response 200

{
  "orderBy": [],
  "searchTerms": [
    {
      "property": "productionJobId",
      "filterType": "INTEGER"
    },
    {
      "property": "operator",
      "filterType": "TEXT"
    },
    {
      "property": "jobState",
      "filterType": "TEXT"
    }
  ],
  "filterTerms": [
    {
      "property": "productionJobId",
      "filterType": "INTEGER"
    },
    {
      "property": "operator",
      "filterType": "TEXT"
    },
    {
      "property": "jobState",
      "filterType": "TEXT"
    }
  ]
}
2. List all available Job Statistics

Compatibility: from Durst Workflow v1.4.1

Available in
Durst Workflow Print Label +
Durst Workflow Print + 

List all Job statistics based on search and filter options.

POST /api/v2/any-job-statistic/list

2.1. Parameters

Type
 Name
 Description
 Schema
Body filterTerms FilterTerms string
Path colorPolicyId required
 ID of a Color Policy integer (int32)

2.2. Responses

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

2.3. Consumes 

application/json

2.4. Produces 

*/*

2.5. Tags

any-job-statistic-api-controller

2.6. Example HTTP request

Request path

POST /api/v2/any-job-statistic/list

Request body

{
  "page": 0,
  "filterTerms": [
    {
      "operator": "EQUAL",
      "property": "jobState",
      "value": "done"
    }
  ],
  "searchTerms": [
    {
      "operator": "BETWEEN",
      "property": "production_job_id",
      "value": [
        900,
        1100
      ]
    }
  ]
}

This Request lists all Production Jobs with the JobState "done" and Production Job ID (the Job ID in Workflow) between 900 and 1100

2.7. Example HTTP response

Response 200

{
  "meta": {
    "totalCount": 9,
    "count": 9,
    "page": 0,
    "limit": 16383,
    "fetchTimeMs": 24
  },
  "entities": [
    {
      "id": 110,
      "jobTitle": "JobnameA",
      "jobId": 5237,
      "jobState": "Done",
      "numberOfPrints": 1,
      "numberOfPrintsDone": 1,
      "length": 1219.2,
      "inkConsumptions": [],
      "startTime": "2022-10-18T15:06:43Z",
      "endTime": "2022-10-18T15:08:45Z",
      "printingTimeSeconds": 122,
      "operator": "[][]",
      "productionJobId": 1045
    },
    {
      "id": 111,
      "jobTitle": "JobnameB",
      "jobId": 5240,
      "jobState": "Done",
      "numberOfPrints": 1,
      "numberOfPrintsDone": 1,
      "length": 609.6,
      "inkConsumptions": [],
      "startTime": "2022-10-18T15:26:30Z",
      "endTime": "2022-10-18T15:28:12Z",
      "printingTimeSeconds": 102,
      "operator": "[][]",
      "productionJobId": 1043
    },
    {
      "id": 121,
      "jobTitle": "JobnameC",
      "jobId": 5256,
      "jobState": "Done",
      "numberOfPrints": 15,
      "numberOfPrintsDone": 15,
      "length": 2082.8,
      "inkConsumptions": [],
      "startTime": "2022-10-18T18:19:23Z",
      "endTime": "2022-10-18T19:10:09Z",
      "printingTimeSeconds": 3046,
      "operator": "[][]",
      "productionJobId": 1012
    },
    {
      "id": 122,
      "jobTitle": "JobnameD",
      "jobId": 5256,
      "jobState": "Done",
      "numberOfPrints": 15,
      "numberOfPrintsDone": 15,
      "length": 2082.8,
      "inkConsumptions": [],
      "startTime": "2022-10-18T18:19:23Z",
      "endTime": "2022-10-18T19:10:09Z",
      "printingTimeSeconds": 3046,
      "operator": "[][]",
      "productionJobId": 1012
    }
  ]
}

2.8. Example HTTP request

Request path

GET /api/v2/any-job-statistic/list

Request body

{}

This Request lists all Production Jobs

3. Get Job Statistics by ID

Compatibility: from Durst Workflow v1.4.1

Available in
Durst Workflow Print Label +
Durst Workflow Print +

Fetch Job Statistics by its ID. Compare the Production Job ID to link the results to the actual Production Job in Workflow. The given ID is the ID for the Job Statistic which represents a Production Job. A single Production Job can be printed many times, resulting in different Job IDs for Statistics.

GET /api/v2/any-job-statistic/{id}

3.1. Parameters

Type
 Name
 Description
 Schema
Path
 id required
 The id of Job Statistic
 integer (int32)

3.2. Responses

HTTP Code Description Schema
200 OK FrontendEntityWrapper, AnyJobStatisticApi, MetaInformation
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

3.3. Consumes 

application/json

3.4. Produces 

*/*

3.5. Tags

motif-controller-api

3.6. Example HTTP request

Request path

GET api/v2/any-job-statistic/{id}

3.7. Example HTTP response

Response 200

{
  "id": 135,
  "jobTitle": "JobName",
  "jobId": 5082,
  "jobState": "Done",
  "numberOfPrints": 1,
  "numberOfPrintsDone": 1,
  "length": 2362.2,
  "inkConsumptions": [],
  "startTime": "2022-10-18T21:01:33Z",
  "endTime": "2022-10-18T21:05:18Z",
  "printingTimeSeconds": 225,
  "operator": "[][]",
  "productionJobId": 1016
}
Previous Article 2.15 Misc
Next Article 2.17 Definitions

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