You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the workflow rule | name (semi-optional) | String | The name of the workflow rule | alternative_code (semi-optional) | String | The alternative code of the workflow rule |
|
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: - ACCOUNTSRECEIVABLE
- ACTIVITIES
- ADHOCDISCOUNT
- CONTACTINFORMATION
CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS - LEADS
- PAYMENTS
- PAYMENTCANCELLATIONS
- REFUNDS
- REWARDOFFERS
- SERVICEREQUESTS
- SUBSCRIPTIONS
- WALLETS
- WALLETTRANSACTIONS
- WRITEOFFS
|
| 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
entity_type object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved entity type |
name | String | The name of the retrieved entity type |
alternative_code | String | The alternative code of the retrieved entity type |
| description | String | A description of the retrieved entity type |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
Examples
Example 1
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 |
| workflow_rule_identifier (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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the workflow rule | name (semi-optional) | String | The name of the workflow rule | alternative_code (semi-optional) | String | The alternative code of the workflow rule |
|
entity (semi-optional) | 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
(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
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: - ACCOUNTSRECEIVABLE
- ACTIVITIES
- ADHOCDISCOUNT
- CONTACTINFORMATION
CREDITNOTES INVOICES INVOICECANCELLATIONS JOBS - LEADS
- PAYMENTS
- PAYMENTCANCELLATIONS
- REFUNDS
- REWARDOFFERS
- SERVICEREQUESTS
- SUBSCRIPTIONS
- WALLETS
- WALLETTRANSACTIONS
- WRITEOFFS
|
| 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
entity_type object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved entity type |
name | String | The name of the retrieved entity type |
alternative_code | String | The alternative code of the retrieved entity type |
| description | String | A description of the retrieved entity type |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
Examples
Example 1
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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the Workflow Rule | number (semi-optional) | String | The number of the Workflow Rule | name (semi-optional) | String | The name of the Workflow Rule |
|
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
| | |
|---|
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 |
workflow_rule object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved workflow rule |
| alternative_code | String | The alternative code of the retrieved workflow rule |
| name | String | The name of the retrieved workflow rule |
| life_cycle_state | String | The life cycle state of the retrieved workflow rule. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE |
Examples
Example 1
HTTP Method: GET
Request:
Response: