BIbigchange
Jobs

Get a job's constraints

Changed on

Retrieve a paged collection of a job's constraints (required scope jobs:read)

get/v1/jobs/{jobId}/constraints

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobs/{jobId}/constraints
  • Auth
    HTTP bearer

Path parameters

jobIdinteger required

The unique identifier of the job

Query parameters

sortBy'createdAt'

Represents the fields that can be used to sort job constraint<p>Possible values:</p><ul><li><b>createdAt</b>: The date and time when the job constraint was created</li></ul>

Example:createdAt

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 5514123,
      "status": "new",
      "createdAt": "2022-11-29T16:50:16.0000000+00:00",
      "recordedAt": "2022-11-29T16:52:03.0000000+00:00",
      "actionedBy": "Bob Brown",
      "comment": "Appliance successfully tested"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes