Get a job's status history
Retrieve a paged collection of changes to job status (required scope jobs:read)
Path Parameters
Possible values: >= 1
The unique identifer of the job
Query Parameters
Possible values: [createdAt]
The field to sort items in the page by
Possible values: [ascending, descending]
The direction to apply the sort
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
- 404
- 500
Success
Schema
- Array [
- new: A job that is newly created in BigChange All Jobs start with a New status, regardless of schedule detail
- scheduled: Job has been scheduled. Scheduled status is when the Vehicle, Driver, and Planned Date Time are all allocated
- unscheduled: Job has been unscheduled. Unscheduled status happens when any combination of the Vehicle, Driver, and Planned Date Time are all removed from a Scheduled job
- sent: The scheduled job has been delivered to the driver's mobile device (tablet/phone). The driver must be logged into BigChange for jobs to be sent
- read: Job Detail has been read by the Driver on their mobile terminal
- accepted: Driver accepted the job
- refused: Driver refused the job
- onTheWay: Driver indicated they are on route to the Job Address
- started: Driver has indicated they have started the work detailed in the Job
- suspended: Driver paused work – ie taking a break
- completedOk: Job Completed with no issues
- completedWithIssues: Job Completed with issues
- cancelled: Job was Cancelled
- lateStart: Internal Status used by BigChange Alert Management - should not be visible from the the API
- lateFinish: Internal Status used by BigChange Alert Management - should not be visible from the the API
- rescheduled: Internal Status used by BigChange Alert Management - should not be visible from the the API
- ]
items object[]
The items returned for the requested page
The unique identifier of the job status change
Possible values: [new, scheduled, unscheduled, sent, read, accepted, refused, onTheWay, started, suspended, completedOk, completedWithIssues, cancelled, lateStart, lateFinish, rescheduled]
Describes each possible status of a Job
Possible values:
The UTC timestamp of when this job status history entry was created (when the job status changed)
The name of the user who triggered the change in status
Textual context about the status change that was made
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,
"status": "new",
"createdAt": "2022-11-29T16:50:16.0000000+00:00",
"actionedBy": "Bob Brown",
"comment": "Appliance successfully tested"
}
],
"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"
}
Not Found
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"
}