You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 5
Next »
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. |
| conditions_set | Set of Workflow Rule Conditions Objects | The set of conditions or the workflow rule |
| actions_set | Set of Workflow Rule Actions Objects | The set of actions or 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 |
workflow_rule_action_values object response data
Name | Type | Description |
| code | String | The code of the Workflow Rule Action which can either be UPDATE INFORMATION, SEND ALERTS, SET APPROVALS, TRIGGER WEBHOOKS. |
field | String | The field which is related to the Workflow Rule Action but only if the action has a code UPDATE INFORMATION. It defines the Entity field being updated by the Workflow Rule Action. |
| value | String | The value to which the Entity instance will be updated to. Applicable only if the action has a code UPDATE INFORMATION |
| webhook_definitions | Set of Webhook Definition Objects | The set of Webhook Definitions which are triggered by the action. Applicable only if the action has a code TRIGGER WEBHOOKS. |
| approval_definitions | Set of Approval Definition Objects | The set of Approval Definitions which are triggered by the action. Applicable only if the action has a code SET APPROVALS, |
| alert_definitions | Set of Alert Definition Objects | The set of Alert Definitions which are triggered by the action. Applicable only if the action has a code SEND ALERTS |
Referred Objects Response Data
webhook_definition object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved webhook definition |
| alternative_code | String | The alternative code of the retrieved webhook definition |
| name | String | The name of the retrieved webhook definition |
| life_cycle_state | String | The life cycle state of the retrieved webhook definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE |
alert_definition object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved alert definition |
| alternative_code | String | The alternative code of the retrieved alert definition |
| name | String | The name of the retrieved alert definition |
| life_cycle_state | String | The life cycle state of the retrieved alert definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE |
| type | String | The type of the alert definition which can be EMAIL or SMS |
approval_definition object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved approval definition |
| alternative_code | String | The alternative code of the retrieved approval definition |
| name | String | The name of the retrieved approval definition |
| life_cycle_state | String | The life cycle state of the retrieved approval definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE |
workflow_rule_condition object response data
Name | Type | Description |
|---|
id | String | The ID of the workflow rule condition |
| code | String | The code of the retrieved workflow rule condition which can either be: WHEN SPECIFIC USER OR UNIT MAKES A CHANGE, WHEN SPECIFIC FIELD CHANGES, WHEN SPECIFIC FIELD CONTAINS SPECIFIC VALUE, WHEN SPECIFIC FIELD CHANGES FROM A SPECIFIC VALUE TO ANOTHER SPECIFIC VALUE
|
| values_set | String | The set of fields and their values per Workflow Rule Condition. The fields and their values depend on the Condition's code |
Referred Objects Response Data
workflow_rule_condition_values object response data
Name | Type | Description |
field | String | The field which is related to the Workflow Rule Condition. It can either have a fixed value or a field of the Entity which is related to the Workflow Rule. A fixed value is applicable only when the code of the Condition is set to SPECIFIC USER OR UNIT MAKES A CHANGE and the available values are be ASSIGN TO USER, ASSIGN TO UNIT, CREATED BY USER, CREATED BY UNIT, SPECIFIC USER, SPECIFIC UNIT |
| value | String | The value of the Condition's field. A value is returned only if the condition's field does not have a fixed value. The condition's value includes a value of the Entity instance. |
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 |