Available from CRM.COM R9.0.0
GET approval_requests/show
This method returns information related with an approval request. A single approval request is returned by each call
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 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 |
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
GET approval_requests/list
This method returns information related with 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 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:
REWARDOFFERS entity is supported from CRM.COM R11.0.0 | ||||||||||||
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 |
Restrictions
- It is mandatory to specify at least one of the semi-optional parameters. Multiple of those parameters are 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
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 | ||||||||||
response (mandatory) | String | The response to the approval request as provided by the user that approved the approval request |
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
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 | ||||||||||
response (mandatory) | String | The response to the approval request as provided by the user that rejected the approval request |
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
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 | ||||||||||
response (mandatory) | String | The response to the approval request as provided by the user that cancelled the approval request |
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
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
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