Get a Printers Jobs

Get a Printers Jobs

Compatibility: from Durst Analytics v1.4.0

Get the job list of a specific printer in a specific time range

POST /api/v1/printers/{id}/jobs

1. Parameters

1.1. Request

Type
Name
Description
Schema
Header  x-auth-token required
The Token to be used in the HTTP Header as x-auth-token for all Requests
string
Query id required The ID of the Printer integer
Body startDate required Start date as ISO 8601 date string
Example: "2020-09-21T12:00:00.000Z"
string (date-time)
Body endDate required End date as ISO 8601 date string
Example: "2020-09-25T18:00:00.000Z"
string (date-time)

1.2. Response

Type
Name
Description
Schema
Body
endTime required Ent Time of the Job as ISO 8601 date string
Example: "2020-09-25T18:00:00.000Z"
string (date-time)
Body
id required
The ID of the Printer integer (int64)
Body
numberOfPrints required
The number of Prints integer (int64)
Body
numberOfPrintsDone required
The number of Prints printed for this Job integer (int64)
Body
startTime required Start Time of the Job as ISO 8601 date string
Example: "2020-09-25T18:00:00.000Z"
string (date-time)
Body
state required State of the Job  string
Body
title required Title of the Job string

2. Responses

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

3. Produces

*/*

4. Example HTTP Request

Request path

/api/v1/printers/{id}/jobs

Request Body

{
  "startDate": "2020-09-22T12:00:00.000Z",
  "endDate": "2020-09-22T13:59:59.000Z"
}

5. Example HTTP Response

Response 200

[
  {
    "id": 1225210,
    "title": "19015_THIS_IS_A_JOB_NAME_2122_p1 [Id=12298]",
    "state": "Done",
    "numberOfPrints": 1,
    "numberOfPrintsDone": 1,
    "startTime": "2020-09-22T12:01:59.22Z",
    "endTime": "2020-09-22T12:02:12.05Z"
  },
  {
    "id": 1225211,
    "title": "19016_THIS_IS_A_JOB_NAME_2123_p1 [Id=12299]",
    "state": "Done",
    "numberOfPrints": 1,
    "numberOfPrintsDone": 1,
    "startTime": "2020-09-22T12:05:59.12Z",
    "endTime": "2020-09-22T12:06:12.25Z"
  },
  {
    "id": 1225212,
    "title": "19016_THIS_IS_A_JOB_NAME_2124_p1 [Id=12300]",
    "state": "Done",
    "numberOfPrints": 1,
    "numberOfPrintsDone": 1,
    "startTime": "2020-09-22T13:11:42.22Z",
    "endTime": "2020-09-22T13:12:11.06Z"
  }
]