Available from CRM.COM R9.0.0
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 | ||||||||||||
| workflow_rule_identifier (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
Name | Type | Description |
|---|---|---|
id | String | The ID of the workflow rule |
name | String | The name of the workflow rule |
| life_cycle_state | String | The life cycle state of the workflow rule which can be EFFECTIVE or NOT EFFECTIVE |
| description | String | The description of the workflow rule |
| processing_order | String | The Processing order of the workflow rule which can be ACTIONS THEN UPDATES, UPDATES THEN ACTIONS |
| priority | String | The Workflow Rule's Priority which can be LOW, MEDIUM, HIGH |
| entity | String | The name of the entity with which the workflow rule is related to. The supported entities are the following:
|
| entity_types | Entity Type Object | The Entity Types which are applicable for the workflow rule |
| log_information | Log Information Object | The log information related with the retrieved workflow rule |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"log_information":
{
"updated_date": "2015-11-05T18:44:23",
"created_date": "2015-11-05T14:47:26",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
"name": "Installation Team 4",
"description": null,
"alternative_code": "IT4"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "m_michael_user",
"username": "m_michael_user",
"id": "970A84FDE9784FCF807597FEA26FA0F1"
}
},
"processing_order": "ANY_ACTION_AND_THEN_UPDATES",
"entity": "ACTIVITIES",
"priority": "LOW",
"life_cycle_state": "EFFECTIVE",
"name": "Workflow Rule",
"id": "7BAB68ADE8A940D2AA7D8300384D7630",
"description": null,
"entity_types":
[
{
"id": "FF7750B1E1C14509B8F7F866414FEA2E",
"name": "Activity Status Transition",
"description": null,
"alternative_code": "AST"
},
{
"id": "8963F9337B1C4CA1BC86D17C29E0A382",
"name": "MKInstall",
"description": null,
"alternative_code": "MK"
}
]
}
}
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 |
entity (mandatory) | String | The name of the entity related with the workflow rules that should be returned as a result. The supported entities are the following:
|
life_cycle_state (optional) | String | The life cycle state of the workflow rules that should be returned as a result. The supported options are EFFECTIVE or NOT EFFECTIVE. By default, all workflow rules are returned. |
created_date (optional) | Date | The created date of the workflow rule 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 workflow rule |
name | String | The name of the workflow rule |
| life_cycle_state | String | The life cycle state of the workflow rule which can be EFFECTIVE or NOT EFFECTIVE |
| description | String | The description of the workflow rule |
| processing_order | String | The Processing order of the workflow rule which can be ACTIONS THEN UPDATES, UPDATES THEN ACTIONS |
| priority | String | The Workflow Rule's Priority which can be LOW, MEDIUM, HIGH |
| entity | String | The name of the entity with which the workflow rule is related to. The supported entities are the following:
|
| entity_types | Entity Type Object | The Entity Types which are applicable for the workflow rule |
| log_information | Log Information Object | The log information related with the retrieved workflow rule |
Referred Objects Response Data
Examples
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 | ||||||||||||
| workflow_rule_identifier (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) | String | The name of the Entity with which the Workflow Rule is related to . The supported entities are the following:
| ||||||||||||
entity_id (mandatory) | String | The ID of the entity instance for which the Workflow Rule is enforced to be triggered. | ||||||||||||
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
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"entity": "ACTIVITIES",
"entity_id": "BCE90B30D846400383759910E7CE5D99",
"workflow_rule":
{
"life_cycle_state": "EFFECTIVE",
"id": "9E8A2D055DBA483F8978E5ACB0DE528B",
"name": "Activity Rule Low",
"alternative_code": "ACT_RULE_LOW"
}
}
}