| Tip |
|---|
Available from CRM.COM R9.0.0 |
| Table of Contents | ||
|---|---|---|
|
GET workflow_rules/show
This method returns information related with a Workflow Rule. A single Workflow Rule request is returned by each call
Resource URL
http://host_name/crmapi/rest/$version/workflow_rule/show
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Webhook Request Identifier
The identifier of the workflow rule that should be returned as a result. The allowed workflow rule 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 workflow_rules/list
This method returns information related with workflow rules having specific attributes. Multiple workflow rules are returned by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-optional)
...
Webhook Request Identifier
The identifier of the workflow rule that should be returned as a result. The allowed workflow rule identifier fields are the following:
...
entity
(semi-optional)
...
The name of the entity related with the workflow rules that should be returned as a result. The supported entities are the following:
- ACTIVITIES
...
life_cycle_state
(optional)
...
created_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:
|
GET workflow_rules/trigger
This method triggers an existing Workflow Rule. Only one Workflow rule can be triggered in each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Workflow Rule Identifier
The identifier of the Workflow Rule that should be triggered. The allowed Workflow Rule request identifier fields are the following:
...
entity
(mandatory)
...
The name of the Entity with which the Workflow Rule is related to . The supported entities are the following:
- ACTIVITIES
...
entity_id
(mandatory)
...
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 |
|---|---|---|
entity | String | The name of the Entity for which the Workflow Rule was triggered . The supported entities are the following:
|
entity_id | String | The ID of the entity for which the Workflow Rule was triggered |
| workflow_rule | Workflow rule Object | The Workflow Rule which was enforced to be triggered |
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
Workflow Rule Request Data Structure Description
Activities
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Include Page | V4:activities_complete | V4:activities_complete|||||
| Panel | ||||||
| ||||||
|