BIbigchange
JobTypes

Get a job type

Changed on

Retrieve the details of a single job type (required scope jobs:read)

get/v1/jobTypes/{jobTypeId}

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobTypes/{jobTypeId}
  • Auth
    HTTP bearer

Path parameters

jobTypeIdinteger required

The unique identifer of the job type

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the job type

namestring

The name of the job type

descriptionstring

The default textual description for jobs of this type

plannedDurationinteger

The default planned duration for jobs of this type, specified in minutes

categoryIdinteger nullable

The unique identifier of default category for jobs of this type

isArchivedboolean

A flag determining if a type is archived - new jobs cannot be created against archived job types

isOrderNumberRequiredboolean

A flag determining if an order number is required for jobs of this type

isTasksEnabledboolean

A flag determining if tasks are used for this job type

positiveResultsstring[] nullable

The result options for when a job is completed successfully

negativeResultsstring[] nullable

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

taskDefinitionIdsstring[]

The identifiers of the task definitions that are added by default to jobs of this type.<br/>Always present, and empty when the job type has none. Each identifier is a lower-case hexadecimal string, the same form<br/>the Tasks service uses. They are not checked against the Tasks service, so one may refer to a task definition that<br/>has since been deleted

Example response

{
  "id": 5514123,
  "name": "Combi boiler installation",
  "description": "New boiler install - please remove and retain the old boiler",
  "plannedDuration": 90,
  "categoryId": 5514123,
  "isOrderNumberRequired": true,
  "isTasksEnabled": true,
  "customFieldDefinitions": [
    {
      "id": 12345,
      "caption": "Favourite colour",
      "type": "boolean",
      "listOptions": [
        "Red",
        "Blue",
        "Green",
        "Purple"
      ],
      "isRequired": true,
      "isEditable": true,
      "default": "10"
    }
  ]
}

Changes