Available from CRM.COM R9.0.0
This method is used to approve pending approval requests. A single approval request can be approved through this method
Resource URL
Parameters
Name | Type | Description | ||||||||||
token | String | The token retrieved from the login method | ||||||||||
| approval_request_identifier (mandatory) | Approval Request Identifier | The identifier of the approval request that should be approved. The allowed approval request Identifier fields are the following:
Note that only pending approval requests are allowed to be specified | ||||||||||
response (mandatory) | String | The response to the approval request as provided by the user that approved the approval request | ||||||||||
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 approval request |
number | String | The number of the retrieved approval request |
| unified_code | String | The unified code of the retrieved approval request |
| life_cycle_state | String | The life cycle state of the retrieved approval request which can be PENDING, APPROVED, REJECTED or CANCELLED |
| entity | String | The name of the entity related with the approval request. The supported entities are the following:
|
| entity_id | String | The ID of the entity related to the approval request |
| subject | String | The subject of the retrieved approval request |
| response | String | The response of the retrieved approval request |
| response_date | Date | The date that a response was provided for the retrieved approval request |
| responded_by | User Object | The user that responded to the retrieved approval request |
| approval_definition | Approval Definition Object | The approval definition that was used to create the approval request |
| workflow_rule | Workflow Rule Object | The workflow rule that triggered the approval request |
| authorised_users_set | Set of Users Objects | The users that are authorised to approve, reject or cancel the approval request |
| log_information | Log Information Object | The log information of the retrieved approval request |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"438BA44BD33B44EEBC77746030A92629",
"approval_request_identifier":{"number":"40"},
"response":"Test from API"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"authorised_users_set":
[
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": "crm.com.tst@gmail.com"
},
{
"person_name": "Eleni Michailidou",
"username": "emichailidou",
"id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
"email": "crm.com.tst@gmail.com"
}
],
"response": "Test from API",
"responded_by":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"entity": "ACTIVITIES",
"number": "40",
"subject": "Approval for Activities by Manager and Assigned to User",
"response_date": "2016-01-19T11:01:00",
"approval_definition":
{
"life_cycle_state": "EFFECTIVE",
"id": "D159E061650D40E689CADDF17ABB424A",
"name": "Installation Approval WT",
"alternative_code": "IAW"
},
"log_information":
{
"updated_date": "2016-01-19T11:01:00",
"created_date": "2016-01-22T12:19:47",
"created_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit":
{
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "crm.com.tst@gmail.com"
},
"updated_by_user":
{
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"life_cycle_state": "APPROVED",
"entity_id": "05B26D3F1B494780B9108B8876AD2A5A",
"unified_code": "31",
"id": "E7FA4634AF0D435E8DF926E53BD2A0B3",
"workflow_rule":
{
"life_cycle_state": "EFFECTIVE",
"id": "F935C2C73CB948DCBD5101DFFF79FC6E",
"name": "Installations Activities - Approvals WT",
"alternative_code": "IA-AW"
}
}
}