Content

Automations / Get one

Return specific automation rule by id.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/automations/{id}

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source
id	Int32

Request body example

Response status: 200 (OK)

Response type: DTO_automation

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	ReadOnly	Description
condition_groups	DTO_automation_condition_group[]		Condition groups
actions	DTO_automation_action[]		Actions
created_by	DTO_reference_user		Created by
last_updated_by	DTO_reference_user		Last updated by
id	Int32	ReadOnly	Leave empty on input
name	String		Name
trigger_by	ENUM automation_trigger_by		Trigger by
condition_groups_operator	ENUM automation_conditions_operator		Condition groups operator
automation_type	ENUM automation_type		Automation type
execution_order	String	ReadOnly	Execution order
enabled	Boolean		Enabled
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Name	Type	ReadOnly	Description
conditions	DTO_automation_condition[]		Conditions
id	Int32	ReadOnly	Id
conditions_operator	ENUM automation_conditions_operator		Conditions operator

Name	Type	ReadOnly	Description
values	DTO_automation_value[]		Values
id	Int32	ReadOnly	Id
field_key	String		Field key
condition_type	ENUM automation_condition_type		Condition type

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object		Label

Name	Type	Description
value	DTO_automation_value	Value
field_key	String	Field key
action_type	ENUM automation_action_type	Action type

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	CONTAINS	Contains
2	NOT_CONTAINS	Doesn't contain
3	EQUAL	Equals
4	NOT_EQUAL	Not equal
5	CHANGED_TO_EQUAL	Only for update triggers
6	CHANGED_TO_NOT_EQUAL	Only for update triggers
7	AI_EVALUATED	Only for create trigger in combination with specific "any" key

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	SYS_LOCKED_SETTINGS	Only the values can be changed
2	CUSTOM	Custom

GET Automations / List_ only aggregates

DELETE Automations / Delete