Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

JobGroups

Create a job group

Create a new job group (required scope jobs:write)

post/v1/jobGroups

Headers

Customer-Idinteger required

The customer identifier

Request body

referencestring nullable

The internal reference of a job group - should usually be unique. If not provided and auto-referencing is setup, auto-reference value will be used

contactIdinteger

The unique identifier of the contact the job group is for

personIdstring uuid nullable

The unique uuid identifier of the person who will serve as primary point of contact for the job

titlestring nullable

The title of the job group

isShownOnDeviceboolean

Indicates whether the job group is shown on the device. If true, it will be shown

areJobsLinkedboolean

Indicates whether the jobs in the group are linked

orderNumberstring nullable

The order number associated with the job group

plannedStartOption'onSetDate' | 'dateOfFirstJob' required

Represents the options for setting the planned start date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfFirstJob</b>: The date of the first job in the job group</li></ul>

plannedStartAtstring date-time nullable

The UTC timestamp for when the job group should be started. Should be set if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.PlannedStartOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedStartOptions.OnSetDate

plannedEndOption'onSetDate' | 'dateOfLastJob' required

Represents the options for setting the planned end date of a job group<p>Possible values:</p><ul><li><b>onSetDate</b>: On a specific date</li><li><b>dateOfLastJob</b>: The date of the last job in the job group</li></ul>

plannedEndAtstring date-time nullable

The UTC timestamp for when the job group should be ended. Should be set if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.PlannedEndOption is BigChange.BO.RestApi.Application.JobGroups.Enumerations.JobGroupPlannedEndOptions.OnSetDate

categoryIdinteger nullable

The unique identifier of the category that the job group is assigned to

linkedJobsResourceIdinteger nullable

The unique identifier of the resource who will be actioning the job group. Should return an error if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.AreJobsLinked is false

linkedJobsStartAtstring date-time nullable

The UTC timestamp for when the job group is started. Should return an error if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.AreJobsLinked is false

linkedJobsVehicleIdinteger nullable

The unique identifier of the vehicle associated with the job group. Should return an error if the BigChange.BO.RestApi.Application.JobGroups.Models.CreateJobGroupModel.AreJobsLinked is false

ownerIdinteger nullable

The unique identifier of the user who owns the job group

Example request

{
  "reference": "ABC/12345",
  "contactId": 12345678,
  "personId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "My Group Job",
  "areJobsLinked": true,
  "orderNumber": "ORD123456",
  "plannedStartOption": "onSetDate",
  "plannedStartAt": "2025-01-01T09:00:00.0000000+00:00",
  "plannedEndOption": "onSetDate",
  "plannedEndAt": "2025-01-01T09:00:00.0000000+00:00",
  "categoryId": 123456,
  "linkedJobsResourceId": 1234567,
  "linkedJobsStartAt": "2025-01-01T09:00:00.0000000+00:00",
  "linkedJobsVehicleId": 123456,
  "ownerId": 12345
}

Response

Created

idinteger

Identifier of the newly created record