This method returns information related with jobs of all fulfillment scopes that are completed.
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 | ||||||||||||
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-07-13T17:04:22",
"created_date": "2016-07-13T16:46:02",
"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": "COMPLETED",
"id": "JobStatus4",
"name": "Closed",
"description": "Completed",
"alternative_code": "CL"
},
"life_cycle_state": "COMPLETED",
"number": "JOB000720",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "GENERIC_PURPOSE",
"billing_method": null,
"id": "JOBTYPE2",
"name": "Not Billable Job",
"billing_directive": "NOT_BILLABLE",
"description": null,
"alternative_code": "NBJ"
},
"id": "BAA12CF1C16A451F984CF92DBC0D9777",
"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-07-15T19:19:53",
"created_date": "2016-07-15T19:15:49",
"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": "COMPLETED",
"id": "JobStatus4",
"name": "Closed",
"description": "Completed",
"alternative_code": "CL"
},
"life_cycle_state": "COMPLETED",
"number": "JOB000735",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "DEACTIVATE_SUBSCRIPTION",
"billing_method": null,
"id": "40F231681B984DA28EDBDA8B698E229E",
"name": "Deactivate Subscription",
"billing_directive": "BILLABLE",
"description": null,
"alternative_code": "DS"
},
"id": "DD237C07A1FD4CCA91B609FD7DD6B0CF",
"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-07-15T19:30:50",
"created_date": "2016-07-15T19:28:24",
"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": "COMPLETED",
"id": "JobStatus4",
"name": "Closed",
"description": "Completed",
"alternative_code": "CL"
},
"life_cycle_state": "COMPLETED",
"number": "JOB000736",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "CANCEL_SUBSCRIPTION",
"billing_method": null,
"id": "CB698F72C9B9432F949CA5BCBA68828F",
"name": "Cancel Subscription",
"billing_directive": "BILLABLE",
"description": null,
"alternative_code": "CS"
},
"id": "4059D3582E304F45B451712CFD7FEA4A",
"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"
}
]
}