| Tip |
|---|
Available from CRM.COM R9.0.0 |
| Table of Contents | ||
|---|---|---|
|
...
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 returned as a result. The allowed approval request Identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| authorised_user_identifier (semi-optional) | User Identifier | The identifier of the authorised user related with the approval requests that should be returned as a result. The allowed user identifier fields are the following:
| ||||||
approval_definition_identifier (semi-optional) | Approval Definition Identifier | The identifier of the approval definition related with the approval requests that should be returned as a result. The allowed approval definition identifier fields are the following:
| ||||||
workflow_rule_identifier (semi-optional) | Workflow Rule Identifier | The identifier of the workflow rule that triggered the approval requests that should be returned as a result. The allowed workflow rule identifier fields are the following:
| ||||||
entity (semi-optional) | String | The name of the entity related with the approval requests that should be returned as a result. The supported entities are the following:
| ||||||
entity_id (semi-optional) | String | The ID of the entity related with the approval requests that should be returned as a result | ||||||
responded_by_user_identifier (optional) | User Identifier | The identifier of the responded by user related with the approval requests that should be returned as a result. The allowed user identifier fields are the following:
| ||||||
unified_code (optional) | String | The unified code of the approval requests that should be returned as a result | ||||||
life_cycle_state (optional) | String | The life cycle state of the approval requests that should be returned as a result. The supported options are PENDING, ACCEPTED, REJECTED or CANCELLED | ||||||
created_date (optional) | Date | The created date of the approval requests that should be returned as a result. | ||||||
response_date (optional) | Date | The response date of the approval requests that should be returned as a result. | ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
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
| ||||||
fields_set | 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 |
...
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 |
...
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 |
...
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 cancelled. 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 cancelled 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 |
...
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 deleted. The allowed approval request Identifier fields are the following:
Note that only rejected, approved or cancelled approval requests are allowed to be specified | |||||||
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 |
...