| Tip |
|---|
Available from CRM.COM R9.0.0 |
| Table of Contents | ||
|---|---|---|
|
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
...
(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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
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
...
approval_definition_identifier
(semi-optional)
...
workflow_rule_identifier
(semi-optional)
...
entity
(semi-optional)
...
The name of the entity related with the approval requests that should be returned as a result. The supported entities are the following:
- ACTIVITIES
...
entity_id
(semi-optional)
...
responded_by_user_identifier
(optional)
...
unified_code
(optional)
...
life_cycle_state
(optional)
...
created_date
(optional)
...
response_date
(optional)
...
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 at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.
Response Data
...
Examples
| 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
...
(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
...
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
...
(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
...
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
...
(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
...
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
...
(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
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||||
|---|---|---|---|---|
|