Cancel a Job Group

Method to cancel all jobs in a JobGroup.

Query String Parameters

Name	Type	Description	Required
Action	String	JobGroupCancel	Required
JobGroupId	Int	Id of Job Group to be cancelled. See Note.	Required
JobGroupReference	String	Reference of Job Group to be cancelled. See Note.	Required
CancelReason	String(50)	Reason for cancelling jobs. Defaults to Cancelled by API user: {username}.	Optional
KeepRecord	Bool	Retain a copy of the job as 'cancelled'. Defaults to true.	Optional
ExcludeJobTypeIds	Int	Comma separated list of job type Ids to exclude.	Optional

note

Either the JobGroup Reference or JobGroup ID can be supplied. If both parameters are provided, the JobGroup ID will take precedence.

Response Codes

Code	Message	Information
2	$Invalid Parameter - excludeJobTypeIds: All Values must be numeric({queryString[excludeJobTypeIds]}
2	$Invalid Parameter - excludeJobTypeIds: ({string.Join(
2	Missing parameter - jobGroupId or jobGroupReference
2	Invalid Parameter - jobGroupId
2	Cannot find jobGroup

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=jobgroupcancel

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "AssetCheckId": "12345"
    }
  ]
}