...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Tip |
---|
Available from CRM.COM R9.0.0 Deprecated from CRM.COM R18.0.0 |
Excerpt |
---|
This method returns information related with to approval requests having specific attributes. Multiple approval requests are returned by each call. |
Resource URL
Parameters
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 |
to 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 |
to 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 |
to the approval requests that should be returned as a result | ||||||||
responded_by_user_identifier (optional) | User Identifier | The identifier of the responded by the 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 |
Restrictions
- It is mandatory to specify at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.
...
Expand | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
HTTP Method: GET Request: Response:
|
...