POST jobs/all_scopes/cancel
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
- p_demou (Deactivated)
Available from CRM.COM R10.0.0
This method cancels a job of any fulfillment scope, which is not already completed or cancelled.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
job_identifier (mandatory) | Job Identifier | The identifier of the job to be cancelled. The allowed job identifier fields are the following:
| ||||||||||||
status_identifier (optional) | Job Status Identifier | The status that will be set on the job, after the cancellation. If not specified the the default status for cancelling jobs of that type will be used. The allowed job status identifiers are the following:
| ||||||||||||
cancellation_reason_identifier (optional) | Job Cancellation Reason Identifier | The reason for cancelling the job. If not specified, then the default cancellation reason of the job's type will be used. The allowed job cancellation reason identifiers are the following:
From CRM.COM R13.0.0 this identifier changes from mandatory to optional. | ||||||||||||
cancel_provided_items (optional) | Boolean | Indicates whether the job's cancellation will also trigger the cancellation of all provided job items or not. Defaults to "false" which means that any provided items should be removed manually. Available CRM.COM R13.0.0 | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved job |
number | String | The number of the retrieved job |
| description | String | The description of the retrieved job |
life_cycle_state | String | The life cycle state of the retrieved job which can be DRAFT, PENDING, IN PROGRESS, COMPLETED, CANCELLED |
| rating_state | String | The rating state of the job that can be PENDING or COMPLETED |
| expiration_date | Date | The date on which the job expires. Available form CRM.COM R13.0.0 |
| scheduled_date | Date | The date on which the job is scheduled to be performed. Applicable only for fulfillment scopes that deliver Subscription amendments:
Available form CRM.COM R13.0.0 |
| assigned_to | Assign Object | The assignment information of the retrieved job |
| type | Job type object | The type information of the retrieved job |
| status | Job Status object | The status information of the retrieved job |
Log Information Object | The log information related with the retrieved job |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"974270486",
"job_identifier":{"number":"JOB000691"},
"cancellation_reason_identifier":{"name":"Cancellation Reason 1"}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"log_information": {
"updated_date": "2016-07-20T11:22:48",
"created_date": "2016-07-04T17:19:06",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"status": {
"life_cycle_state": "CANCELLED",
"id": "A1E10920D28A4496BCA2811A94783BDF",
"name": "Cancelled",
"description": null,
"alternative_code": "C"
},
"life_cycle_state": "CANCELLED",
"number": "JOB000691",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "GENERIC_PURPOSE",
"billing_method": "BILL_ON_COMPLETION",
"id": "98523D8F88354CFAA8BF66E51DEA0A40",
"name": "Installation Job 2",
"billing_directive": "BILLABLE",
"description": "Job for installing Smartcard and Set Top Box on Subscriber's house if requested",
"alternative_code": "002"
},
"id": "D8A91ED0A4B248FEA2888F54613BDC2F",
"assigned_to": {
"unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"description": null,
"rating_state": "PENDING"
}
}