Available from CRM.COM R10.0.0
This method completes a job of any fulfillment scope, which is already in progress
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 that will be completed. The allowed job identifier fields are the following:
| ||||||||||||
status_identifier (optional) | Job Status Identifier | The status that will be set on completing the job. If not specified the the default status for completing jobs of that type will be used. The allowed job status identifiers are the following:
| ||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. This information is applicable only if the job type fulfillment scope is set to New Subscription. The allowed user identifier fields are the following:
| ||||||||||||
performed_on (optional) | Date | The date that the action was actually performed. This information is applicable only if the job type fulfillment scope is set to New Subscription. | ||||||||||||
scheduled_date (optional) | Date | The date on which the subscription action will be scheduled to be performed. Required only if Subscription Action Rules prevent the immediate execution of the subscription action through which the job is delivered. Applicable only for jobs with fulfillment scopes:
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: POST
Request:
Body:
{
"token":"1687311238",
"job_identifier":{"number":"JOB000755"},
"performed_by_user_identifier":{"username":"MPAdministrator"}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"log_information": {
"updated_date": "2016-07-20T12:51:38",
"created_date": "2016-07-19T14:30:57",
"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": "COMPLETED",
"id": "JobStatus4",
"name": "Closed",
"description": "Completed",
"alternative_code": "CL"
},
"life_cycle_state": "COMPLETED",
"number": "JOB000755",
"type": {
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"fulfillment_scope": "ACTIVATE_SUBSCRIPTION",
"billing_method": null,
"id": "A27C03160F22451DB67A090495E69E45",
"name": "Activate Subscription",
"billing_directive": "BILLABLE",
"description": null,
"alternative_code": "AS"
},
"id": "14FBD0ADE2A04C0B888665DB03FFBC74",
"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": "Activate Subscription S61007 for Anton Mara",
"rating_state": "PENDING"
}
}
HTTP Method: POST
Request:
Body:
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ",
"job_identifier":{"number":"J00001015"},
"scheduled_date":"2018-04-05T12:51:38"
}
Response:
{
"data":
{
"number": "J00001015",
"log_information":
{
"created_by_unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-07-05T11:08:54",
"updated_date": "2017-07-05T12:55:54",
"updated_by_user":
{
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user":
{
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
}
},
"description": null,
"rating_state": "PENDING",
"id": "5D107A15B6F645CA976CCA2D6817851E",
"life_cycle_state": "COMPLETED",
"expiration_date": null,
"scheduled_date": "2018-04-05T12:51:38",
"type":
{
"billing_method": null,
"alternative_code": "SCS",
"name": "Schedule Cancel Service",
"fulfillment_scope": "CANCEL_SUBSCRIPTION_SERVICES",
"description": null,
"fulfillment_method": "BASED_ON_DELIVERED_ITEMS",
"id": "E90AF577A4424697BDE230167C03BBB2",
"billing_directive": "BILLABLE"
},
"assigned_to":
{
"unit":
{
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"user":
{
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
}
},
"status":
{
"alternative_code": "3",
"name": "Closed",
"description": null,
"id": "B5BE4505EE41A8829AAA7790F9BACE49",
"life_cycle_state": "COMPLETED"
}
},
"status":
{
"code": "OK",
"description": "",
"message": ""
}
}