Retrieve a Print-History Job Record |
Returns a job record as determined by a Job ID.
|
For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/printhistory/jobs/{jobId}
|
The bartendercloud.com domain that is referenced in the URI and in the code examples that follow must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Responses
200 Success
Response Schema: application/json
Array
JobId | string or null |
JobName | string or null |
PaperName | string or null |
UniqueResourceGuid | string or null |
PrinterId | string or null |
UserId | string or null |
CreatedTime | string <date-time> |
JobStatus | string or null |
PrinterConfirmed | boolean |
JobResources | array of strings or null |
JobValues | object or null |
ReprintValues | object (BarTender.Services.Printing.Common.ReprintValues) |
400 Bad Request
Response Schema: application/json
One of
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
One of
Errors | object or null |
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
401 Unauthorized
Response Schema: application/json
One of
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
One of
Errors | object or null |
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
403 Forbidden
Response Schema: application/json
One of
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
One of
Errors | object or null |
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
404 Not Found
Response Schema: application/json
One of
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
One of
Errors | object or null |
type | string or null |
title | string or null |
status | integer or null <int32> |
detail | string or null |
instance | string or null |
property name* additional property |
any |
500 Server Error
Path Parameters
jobId required |
string Identifies the print job. Note: This parameter's value must be URL encoded. |
Example
You can use any one of several methods to send the command to the server, as shown in the following code samples.
|
In each of the following samples, you must replace "____PASTE_YOUR_ACCESS_TOKEN_HERE____" with your access token. For more information about your access token, refer to Authentication. |
- cURL
curl.exe
--request GET \
--url "https://bartendercloud.com/api/printhistory/jobs/{jobId}"
--header "Content-Type: application/json"
--header "Authorization: Bearer ____PASTE_YOUR_ACCESS_TOKEN_HERE____"
Add JavaScript example
Add C# example
Add PHP example
Add Perl example
Add Python example