| 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. | ||||||
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 |
...
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST approval_requests/approve
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST approval_requests/reject
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST approval_requests/cancel
This method is used to cancel pending approval requests. A single approval request can be cancelled 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 cancelled. The allowed approval request Identifier fields are the following:
Note that only pending approval requests are allowed to be specified |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST approval_requests/delete
This method is used to delete rejected, approved or cancelled approval requests. A single approval request can be deleted 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 deleted. The allowed approval request Identifier fields are the following:
Note that only rejected, approved or cancelled approval requests are allowed to be specified |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|