Get a list of job types
Retrieve a paged collection of job types (required scope jobs:read)
Query Parameters
Possible values: [name]
The field to sort items in the page by
Possible values: [ascending, descending]
The direction to apply the sort
Only return job types where id matches the value(s) provided
Possible values: >= 1 and <= 2147483
The page number being requested (minimum: 1, maximum: 2147483)
Possible values: >= 1 and <= 1000
The page size being requested (minimum: 1, maximum: 1000)
Header Parameters
The customer identifier
- 200
- 400
- 403
- 500
Success
Schema
- Array [
- ]
items object[]
The items returned for the requested page
The unique identifier of the job type
The name of the job type
The default textual description for jobs of this type
The default planned duration for jobs of this type, specified in minutes
The unique identifier of default category for jobs of this type
A flag determining if a type is archived - new jobs cannot be created against archived job types
A flag determining if an order number is required for jobs of this type
The result options for when a job is completed successfully
The result options for when a job is completed with issues. If null then jobs of this type will not be allowed to have the status of completedWithIssues
The page number of the response where 1 is the first page
The number of items requested for the current page
The number of items returned in the current page
{
"items": [
{
"id": 5514123,
"name": "Combi boiler installation",
"description": "New boiler install - please remove and retain the old boiler",
"plannedDuration": 90,
"categoryId": 5514123,
"isArchived": false,
"isOrderNumberRequired": true,
"positiveResults": [
"string"
],
"negativeResults": [
"string"
]
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}
Bad Request
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Forbidden
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Server Error
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}