POST approval_requests/reject
Available from CRM.COM R9.0.0
Deprecated from CRM.COM R18.0.0
This method is used to reject pending approval requests. A single approval request can be rejected 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 rejected. 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 rejected 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