GET jobs/all_scopes/get_cancelled
- Former user (Deleted)
- p_demou (Deactivated)
Available from CRM.COM R10.0.0
This method returns information related with jobs of all fulfillment scopes that are cancelled
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
type_identifier | Job type identifier | The identifier of the type of the retrieved job. The allowed job type identifier fields are the following:
| ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | ||||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 From R14.5.0, the results are retrieved sorted by their created date, descending | ||||||||||||
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: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"log_information": {
"updated_date": "2016-06-13T11:32:17",
"created_date": "2016-06-13T11:27:19",
"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": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"status": {
"life_cycle_state": "CANCELLED",
"id": "A1E10920D28A4496BCA2811A94783BDF",
"name": "Cancelled",
"description": null,
"alternative_code": "C"
},
"life_cycle_state": "CANCELLED",
"number": "JOB000604",
"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": "567FC12D97E6495A9D10629B2B81623D",
"description": null,
"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"
}
},
"rating_state": "PENDING"
},
{
"log_information": {
"updated_date": "2016-06-15T17:54:16",
"created_date": "2016-06-15T15:12:28",
"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": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"status": {
"life_cycle_state": "CANCELLED",
"id": "A1E10920D28A4496BCA2811A94783BDF",
"name": "Cancelled",
"description": null,
"alternative_code": "C"
},
"life_cycle_state": "CANCELLED",
"number": "JOB000611",
"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": "CA4C240394A846BE87177ED3BDAA80B9",
"description": null,
"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"
}
},
"rating_state": "PENDING"
}
]
}