Entities data models

deleteEntityInstance — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityInstance — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityInstance — 404 response

The required entity does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityInstance — 409 response

The entity was not deleted. The reason field of the response body tells why. * ENTITY_IS_IN_USE: the entity is in use. This reason is checked first. The data field says what uses it, and only one of these is returned: * data.bizstackAppInstallationIds: a Bizstack App is installed in the entity, or in a descendant that would be deleted with it. Lists the IDs of those installations. Uninstall the apps, then try again. This is checked before alert rules. * data.alertRuleIds: the condition of an alert rule names the entity, or a descendant that would be deleted with it. Lists the IDs of those rules, enabled or disabled. Change or delete the rules, then try again. * ENTITY_HAS_CHILDREN: the entity has children, and deleteDescendants is not true.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityInstance — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityInstance — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityInstance — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityInstance — 200 response

Successful retrieval of entity instance.

Property Type Required Constraints Description

attributes object No The attributes that belong to the entity instance, separated as key-value pairs.

createdAt string No read-only (server-generated); format: date-time Timestamp of entity creation.

displaySettings object No Various user interface settings used for display of the entity instance.

Property Type Required Constraints Description

description string No An intuitive description for the entity instance for display.

iconData object No Metadata used for the uploaded icon of the entity instance.

Properties of iconData
Property	Type	Required	Constraints	Description
`fileName`	string	No		FileName represents the name of the file uploaded.
`url`	string	No		A temporary signed URL for file download.

imageData object No Metadata used for the uploaded image of the entity instance.

Properties of imageData
Property	Type	Required	Constraints	Description
`fileName`	string	No		FileName represents the name of the file uploaded.
`url`	string	No		A temporary signed URL for file download.

name string No The display name for the entity instance.

entityClass string Yes read-only (server-generated) The entity class that the entity was instantiated from.

entityId string Yes read-only (server-generated) Unique entity ID.

homeId integer Yes read-only (server-generated) Home that this entity belongs to.

metrics array<object> No read-only (server-generated) Meta data of the metrics associated with this entity instance.

Properties of metrics
Property	Type	Required	Constraints	Description
`metricsDefinitionId`	string	No		Corresponding metrics definition ID in entity class.

parentId string No The ID of the entity instance that is a parent of the instance.

projectId integer Yes read-only (server-generated) Project that this entity belongs to.

suspendAlertRuleEvaluationConditions array<object> No An array of condition for suspending alerts, which are evaluated as if they are concatenated with OR

Properties of suspendAlertRuleEvaluationConditions
Property	Type	Required	Constraints	Description
`alertConditionTypes`	array<string>	No		An array of alert condition types. This allows suspending alerts based on the alert types. All rules of the specified condition type will be suspended.
`from`	string	No	format: date-time	Timestamp of the begin of the interval. Null applies this rule without this time constrains
`includeDescendants`	boolean	No		Boolean value that shows whether alert rules are suspended for only this entity or this entity and descendants
`rules`	array<number>	No		An array of alertRuleId. Empty array means all rules
`to`	string	No	format: date-time	Timestamp of the end of the interval. Null applies this rule without this time constrains

timeZone string Yes read-only (server-generated) The time zone that the entity exists in. This should be a time zone name defined in the IANA TZ Database.

uiSettings object No An opaque object used by UI applications to store any additional settings. These will override the entity class uiSettings.

updatedAt string No read-only (server-generated); format: date-time Timestamp of the last update on the entity.

getEntityInstance — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityInstance — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityInstance — 404 response

The requested entity does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityInstance — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityInstance — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityInstance — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityInstance — request

Request body for Update entity instance.

Property Type Required Constraints Description

attributes object No The attributes that belong to the entity instance, separated as key-value pairs.

createdAt string No read-only (server-generated); format: date-time Timestamp of entity creation.

displaySettings object No Various user interface settings used for display of the entity instance.

Property Type Required Constraints Description

description string No An intuitive description for the entity instance for display.

iconData object No Metadata used for the uploaded icon of the entity instance.

Properties of iconData
Property	Type	Required	Constraints	Description
`fileName`	string	No		FileName represents the name of the file uploaded.
`url`	string	No		A temporary signed URL for file download.

imageData object No Metadata used for the uploaded image of the entity instance.

Properties of imageData
Property	Type	Required	Constraints	Description
`fileName`	string	No		FileName represents the name of the file uploaded.
`url`	string	No		A temporary signed URL for file download.

name string No The display name for the entity instance.

entityClass string Yes read-only (server-generated) The entity class that the entity was instantiated from.

entityId string Yes read-only (server-generated) Unique entity ID.

homeId integer Yes read-only (server-generated) Home that this entity belongs to.

metrics array<object> No read-only (server-generated) Meta data of the metrics associated with this entity instance.

Properties of metrics
Property	Type	Required	Constraints	Description
`metricsDefinitionId`	string	No		Corresponding metrics definition ID in entity class.

parentId string No The ID of the entity instance that is a parent of the instance.

projectId integer Yes read-only (server-generated) Project that this entity belongs to.

suspendAlertRuleEvaluationConditions array<object> No An array of condition for suspending alerts, which are evaluated as if they are concatenated with OR

Properties of suspendAlertRuleEvaluationConditions
Property	Type	Required	Constraints	Description
`alertConditionTypes`	array<string>	No		An array of alert condition types. This allows suspending alerts based on the alert types. All rules of the specified condition type will be suspended.
`from`	string	No	format: date-time	Timestamp of the begin of the interval. Null applies this rule without this time constrains
`includeDescendants`	boolean	No		Boolean value that shows whether alert rules are suspended for only this entity or this entity and descendants
`rules`	array<number>	No		An array of alertRuleId. Empty array means all rules
`to`	string	No	format: date-time	Timestamp of the end of the interval. Null applies this rule without this time constrains

timeZone string Yes read-only (server-generated) The time zone that the entity exists in. This should be a time zone name defined in the IANA TZ Database.

uiSettings object No An opaque object used by UI applications to store any additional settings. These will override the entity class uiSettings.

updatedAt string No read-only (server-generated); format: date-time Timestamp of the last update on the entity.

updateEntityInstance — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityInstance — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityInstance — 404 response

The requested entity does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityInstance — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityInstance — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityInstance — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertRules — 200 response

Successfully retrieved the alert rules.

Represents an alert rule

An array of objects with the following shape:

Property Type Required Constraints Description

actions array<object> No The actions to take when the alert rule is triggered

Property Type Required Constraints Description

recipients array<one of 5> No Optional. Recipients that will be notified when this action runs. Each recipient is discriminated by its recipientType. Maximum 10 recipients. Assistant recipients (slack, direct, msTeams) must belong to the same project and entity as the alert rule.

One of the following 5 shapes:

Variant 1

Sends the alert notification to an email address.

Property	Type	Required	Constraints	Description
`email`	string	Yes		The destination email address.
`recipientType`	string	Yes	one of: email

Variant 2

Emits an event of eventType into the project event stream.

Property	Type	Required	Constraints	Description
`eventType`	string	Yes		The event type to emit.
`recipientType`	string	Yes	one of: event

Variant 3

Sends the alert notification to a Slack channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Slack assistant.
`channelId`	string	Yes		Slack channel identifier.
`recipientType`	string	Yes	one of: slack
`workspaceId`	string	Yes		Slack workspace identifier.

Variant 4

Sends the alert notification to a Direct chat room via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Direct assistant.
`domainId`	string	Yes		Direct domain identifier.
`recipientType`	string	Yes	one of: direct
`roomId`	string	Yes		Direct room identifier.

Variant 5

Sends the alert notification to a Microsoft Teams channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Microsoft Teams assistant.
`channelId`	string	Yes		Microsoft Teams channel identifier.
`recipientType`	string	Yes	one of: msTeams
`teamId`	string	Yes		Microsoft Teams team identifier.
`tenantId`	string	Yes		Microsoft Teams tenant identifier.

videoFeeds array<object> No Optional. Video feed snapshots to capture and attach to the alert notification when the rule fires. When omitted, no snapshots are captured. Whether/how a given recipient renders the attachment depends on that recipient's channel.

Properties of videoFeeds
Property	Type	Required	Constraints	Description
`entityId`	string	Yes		Entity owning the video feed. Supports the `{{triggeredEntityId}}` template placeholder to refer to the entity that triggered the alert.
`videoFeedId`	string	No		Optional. Specific video feed identifier. When omitted, all video feeds of the entity are used.

condition one of 5 No The condition that triggers the alert rule. The shape is discriminated by conditionType.

One of the following 5 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

delay string No Optional. How long the evaluation is delayed after the job is dispatched (e.g. 1min). Capped at 10 days. Note (Alerting V2): this field is not used by evaluation scheduling; the server silently replaces invalid values with 0sec.

duration string Yes Required. The time range over which data points are aggregated for evaluation (e.g. 1min, 10min, 1hour). Must be a positive, non-zero multiple of the job invocation interval. Capped at 10 days (V2: 1 day). Note (Alerting V2): the multiple-of-interval constraint does not apply; any positive, non-zero duration up to 1 day is accepted.

frequency string No Optional. How often the condition is evaluated (e.g. 1min, 10min, 1hour). Capped at 1 hour. Note (Alerting V2): this field is not used by evaluation scheduling; the server silently replaces invalid values with 1min and the actual cadence is controlled by the platform.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Evaluates several metric conditions together and alerts only when all of them breach at the same severity. Each condition watches its own entity and metric; which entity fills which condition is given explicitly by entityTuples, one tuple per monitored installation. Alerting V2 only, and event-driven only: there is no scheduled evaluation for this condition type, so it has no frequency or delay.

Property Type Required Constraints Description

conditionType string Yes one of: metricsThresholdComposite The discriminator for the condition type. Must be metricsThresholdComposite.

conditions array<object> Yes min items: 2; max items: 10 The AND-ed conditions. Order is significant: a condition's position is its identity, referenced by entityTuples[].entities and by the conditionN message template aliases, so reordering conditions changes the meaning of both. Every condition must define the same set of threshold severities, because the composite severity is the highest severity at which all conditions breach. Two conditions may share, or fully duplicate, the same entityClass + metricsDefinitionId + metricName; the entity binding comes from the tuple, not the condition.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to this condition's metric over its duration.

duration string Yes Required. The time range over which this condition's data points are aggregated (e.g. 1min, 10min). Must be positive and non-zero, capped at 1 day. Each condition has its own duration.

entityClass string Yes The entity class that owns the metric. Every entity bound to this condition's slot must be of this class.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds for this condition. Duplicate severities are not allowed, and the set of severities must be identical across every condition of the rule.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

entityTuples array<object> Yes min items: 1; max items: 100 The explicit entity mappings, one per monitored installation. Each tuple says which real entity fills each condition slot. Tuples are never inferred from entity hierarchy or scope, because that mapping is business knowledge the platform cannot guess. Two tuples of one rule alert independently. Duplicate mappings are rejected.

Properties of entityTuples
Property	Type	Required	Constraints	Description
`entities`	array<string>	Yes	min items: 2; max items: 10	The entity IDs filling each condition slot, positionally aligned with `conditions`: `entities[i]` is evaluated against `conditions[i]`. The length must equal the number of conditions, and each entity must be of its condition's `entityClass` and must be the alert rule's entity or one of its descendants. The same entity may appear in more than one slot.

Variant 3

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

duration string Yes Required. The window in which at least one data point is expected (e.g. 1min, 10min, 1hour). Must be a positive, non-zero multiple of the job invocation interval. Capped at 90 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

duration string Yes Required. The window in which at least one location data point is expected (e.g. 1min, 10min, 1hour). Must be a positive, non-zero multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 5

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes. Note (Alerting V2): this field is not used by evaluation scheduling; the server silently replaces invalid values with 0sec.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceEntityIds array<string> No Required when geofenceAlertType=inAndOut. The ordered list of geofence area entity IDs that define the zones. Validation requires at least one entry. The length of this list also determines the required dimensions of geofenceSeverityMatrix (rows and columns = len + 1, including the "outside" zone).

geofenceExcludingEntityClasses array<string> No Optional. Used only when geofenceAlertType=inOnly. Entity classes whose areas suppress evaluation when a tracked entity is inside them. Must not contain geofenceTargetEntities.entityClass or any entity class listed in geofenceInOnlyConditions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

geofenceInOnlyConditions array<object> No Optional in the schema, but required when geofenceAlertType=inOnly (validation will reject the rule otherwise). Per-entity-class conditions evaluated on geofence entry. entityClass must differ from geofenceTargetEntities.entityClass, severities must be unique across this array, and classes listed here must not appear in geofenceExcludingEntityClasses.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceSeverityMatrix array<array> No Required when geofenceAlertType=inAndOut. A square severity matrix representing transitions between zones (including an implicit "outside" zone). Must have exactly (length of geofenceEntityIds) + 1 rows and the same number of columns. matrix[from][to] gives the severity (0 - None, 1 - High, 2 - Moderate, 3 - Low) for transitioning from zone from to zone to, where index 0 represents outside. Ignored when geofenceAlertType=inOnly.

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditionOperator string No one of: and, or Optional. Logical operator combining metricsConditions. Required when metricsConditions is non-empty. Ignored when metricsConditions is empty or absent.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

entityId string No Optional. Scopes the metric evaluation to a specific entity. The entity must be a descendant of the alert rule's owning entity. When omitted, the metric is evaluated against any matching entity of entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

whenLocationIsMissing string No one of: skipEvaluation, setFromAsOutsideOnly, setBothAsOutside Optional. How to treat tracked entities with no recent location data. Defaults to skipEvaluation when omitted.

creationTime string No The time the alert rule was created

description string No The description of the alert rule

disableAutoRecovery boolean No Whether alert based on this rule recover automatically

disableRecoveryAlert boolean No Whether a notification will be sent when an alert recovers

enabled boolean No Whether the alert rule is enabled

id integer No The unique identifier for the alert rule

messageTemplate object No Templates used to render the notification title and message for the different alert state transitions. Template variables are referenced with {{name}} syntax. Supported variables: projectId, alertId, alertRuleId, alertRuleName, entityId, entityName, severity, invocationTime, invocationValue, currentValue.

Property Type Required Constraints Description

decreasedSeverityMessage string No Optional. Message body used when an alert's severity decreases. Max 2000 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity decreased to {{severity}}.

decreasedSeverityTitle string No Optional. Title used when an alert's severity decreases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity decreased.

increasedSeverityMessage string No Optional. Message body used when an alert's severity increases. Max 2000 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity increased to {{severity}}.

increasedSeverityTitle string No Optional. Title used when an alert's severity increases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity increased.

message string No Optional. Message body used when an alert is initially fired. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryMessage string No Optional. Message body used when an alert recovers. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryTitle string No Optional. Title used when an alert recovers. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} is back to normal.

severityMessageOverrides array<object> No max items: 3 Optional. Per-severity overrides for title, message, recoveryTitle, and recoveryMessage. When an override entry exists for the current severity and the field is non-empty, it takes precedence over the corresponding top-level field. increasedSeverityTitle, increasedSeverityMessage, decreasedSeverityTitle, and decreasedSeverityMessage are NOT overridable per severity. Each severity value must appear at most once.

Properties of severityMessageOverrides
Property	Type	Required	Constraints	Description
`message`	string	No		Optional. Message body override used when an alert fires at this severity. Max 2000 runes.
`recoveryMessage`	string	No		Optional. Message body override used when an alert recovers from this severity. Max 2000 runes.
`recoveryTitle`	string	No		Optional. Title override used when an alert recovers from this severity. Max 200 runes.
`severity`	integer	Yes	one of: 1, 2, 3	The alert severity level this override applies to. 1 = high, 2 = moderate, 3 = low. Must not be 0 (none).
`title`	string	No		Optional. Title override used when an alert fires at this severity. Max 200 runes.

title string Yes Title used when an alert is initially fired. Max 200 runes. Required.

name string No The name of the alert rule

projectId integer No The unique identifier for the project the alert rule belongs to

reasonForDisabling unknown No read-only (server-generated); one of: unknown, api, invalid_entity, invalid_metric The reason why this alert rule was disabled. Will not be set when the alert rule is enabled

scheduleId string No The schedule ID for the alert rule

updateTime string No The time the alert rule was last updated

listProjectEntityAlertRules — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertRules — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertRules — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertRules — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertRules — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertRules — request

Request body for Create an alert rule.

Property Type Required Constraints Description

actions array<object> No The actions to take when the alert rule is triggered

Property Type Required Constraints Description

One of the following 5 shapes:

Variant 1

Sends the alert notification to an email address.

Property	Type	Required	Constraints	Description
`email`	string	Yes		The destination email address.
`recipientType`	string	Yes	one of: email

Variant 2

Emits an event of eventType into the project event stream.

Property	Type	Required	Constraints	Description
`eventType`	string	Yes		The event type to emit.
`recipientType`	string	Yes	one of: event

Variant 3

Sends the alert notification to a Slack channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Slack assistant.
`channelId`	string	Yes		Slack channel identifier.
`recipientType`	string	Yes	one of: slack
`workspaceId`	string	Yes		Slack workspace identifier.

Variant 4

Sends the alert notification to a Direct chat room via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Direct assistant.
`domainId`	string	Yes		Direct domain identifier.
`recipientType`	string	Yes	one of: direct
`roomId`	string	Yes		Direct room identifier.

Variant 5

Sends the alert notification to a Microsoft Teams channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Microsoft Teams assistant.
`channelId`	string	Yes		Microsoft Teams channel identifier.
`recipientType`	string	Yes	one of: msTeams
`teamId`	string	Yes		Microsoft Teams team identifier.
`tenantId`	string	Yes		Microsoft Teams tenant identifier.

Properties of videoFeeds
Property	Type	Required	Constraints	Description
`entityId`	string	Yes		Entity owning the video feed. Supports the `{{triggeredEntityId}}` template placeholder to refer to the entity that triggered the alert.
`videoFeedId`	string	No		Optional. Specific video feed identifier. When omitted, all video feeds of the entity are used.

condition one of 5 Yes The condition that triggers the alert rule. The shape is discriminated by conditionType.

One of the following 5 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Property Type Required Constraints Description

conditionType string Yes one of: metricsThresholdComposite The discriminator for the condition type. Must be metricsThresholdComposite.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to this condition's metric over its duration.

entityClass string Yes The entity class that owns the metric. Every entity bound to this condition's slot must be of this class.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Properties of entityTuples
Property	Type	Required	Constraints	Description
`entities`	array<string>	Yes	min items: 2; max items: 10	The entity IDs filling each condition slot, positionally aligned with `conditions`: `entities[i]` is evaluated against `conditions[i]`. The length must equal the number of conditions, and each entity must be of its condition's `entityClass` and must be the alert rule's entity or one of its descendants. The same entity may appear in more than one slot.

Variant 3

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 5

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

description string No default: "" The description of the alert rule

disableAutoRecovery boolean No default: false Whether alert based on this rule recover automatically

disableRecoveryAlert boolean No default: false Whether a notification will be sent when an alert recovers

enabled boolean No default: false Whether the alert rule is enabled

Property Type Required Constraints Description

decreasedSeverityTitle string No Optional. Title used when an alert's severity decreases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity decreased.

increasedSeverityTitle string No Optional. Title used when an alert's severity increases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity increased.

message string No Optional. Message body used when an alert is initially fired. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryMessage string No Optional. Message body used when an alert recovers. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryTitle string No Optional. Title used when an alert recovers. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} is back to normal.

Properties of severityMessageOverrides
Property	Type	Required	Constraints	Description
`message`	string	No		Optional. Message body override used when an alert fires at this severity. Max 2000 runes.
`recoveryMessage`	string	No		Optional. Message body override used when an alert recovers from this severity. Max 2000 runes.
`recoveryTitle`	string	No		Optional. Title override used when an alert recovers from this severity. Max 200 runes.
`severity`	integer	Yes	one of: 1, 2, 3	The alert severity level this override applies to. 1 = high, 2 = moderate, 3 = low. Must not be 0 (none).
`title`	string	No		Optional. Title override used when an alert fires at this severity. Max 200 runes.

title string Yes Title used when an alert is initially fired. Max 200 runes. Required.

name string Yes The name of the alert rule

scheduleId string No The schedule ID for the alert rule

createProjectEntityAlertRules — 201 response

Successfully created a new alert rule.

Property Type Required Constraints Description

actions array<object> No The actions to take when the alert rule is triggered

Property Type Required Constraints Description

One of the following 5 shapes:

Variant 1

Sends the alert notification to an email address.

Property	Type	Required	Constraints	Description
`email`	string	Yes		The destination email address.
`recipientType`	string	Yes	one of: email

Variant 2

Emits an event of eventType into the project event stream.

Property	Type	Required	Constraints	Description
`eventType`	string	Yes		The event type to emit.
`recipientType`	string	Yes	one of: event

Variant 3

Sends the alert notification to a Slack channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Slack assistant.
`channelId`	string	Yes		Slack channel identifier.
`recipientType`	string	Yes	one of: slack
`workspaceId`	string	Yes		Slack workspace identifier.

Variant 4

Sends the alert notification to a Direct chat room via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Direct assistant.
`domainId`	string	Yes		Direct domain identifier.
`recipientType`	string	Yes	one of: direct
`roomId`	string	Yes		Direct room identifier.

Variant 5

Sends the alert notification to a Microsoft Teams channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Microsoft Teams assistant.
`channelId`	string	Yes		Microsoft Teams channel identifier.
`recipientType`	string	Yes	one of: msTeams
`teamId`	string	Yes		Microsoft Teams team identifier.
`tenantId`	string	Yes		Microsoft Teams tenant identifier.

Properties of videoFeeds
Property	Type	Required	Constraints	Description
`entityId`	string	Yes		Entity owning the video feed. Supports the `{{triggeredEntityId}}` template placeholder to refer to the entity that triggered the alert.
`videoFeedId`	string	No		Optional. Specific video feed identifier. When omitted, all video feeds of the entity are used.

condition one of 5 No The condition that triggers the alert rule. The shape is discriminated by conditionType.

One of the following 5 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Property Type Required Constraints Description

conditionType string Yes one of: metricsThresholdComposite The discriminator for the condition type. Must be metricsThresholdComposite.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to this condition's metric over its duration.

entityClass string Yes The entity class that owns the metric. Every entity bound to this condition's slot must be of this class.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Properties of entityTuples
Property	Type	Required	Constraints	Description
`entities`	array<string>	Yes	min items: 2; max items: 10	The entity IDs filling each condition slot, positionally aligned with `conditions`: `entities[i]` is evaluated against `conditions[i]`. The length must equal the number of conditions, and each entity must be of its condition's `entityClass` and must be the alert rule's entity or one of its descendants. The same entity may appear in more than one slot.

Variant 3

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 5

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

creationTime string No The time the alert rule was created

description string No The description of the alert rule

disableAutoRecovery boolean No Whether alert based on this rule recover automatically

disableRecoveryAlert boolean No Whether a notification will be sent when an alert recovers

enabled boolean No Whether the alert rule is enabled

id integer No The unique identifier for the alert rule

Property Type Required Constraints Description

decreasedSeverityTitle string No Optional. Title used when an alert's severity decreases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity decreased.

increasedSeverityTitle string No Optional. Title used when an alert's severity increases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity increased.

message string No Optional. Message body used when an alert is initially fired. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryMessage string No Optional. Message body used when an alert recovers. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryTitle string No Optional. Title used when an alert recovers. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} is back to normal.

Properties of severityMessageOverrides
Property	Type	Required	Constraints	Description
`message`	string	No		Optional. Message body override used when an alert fires at this severity. Max 2000 runes.
`recoveryMessage`	string	No		Optional. Message body override used when an alert recovers from this severity. Max 2000 runes.
`recoveryTitle`	string	No		Optional. Title override used when an alert recovers from this severity. Max 200 runes.
`severity`	integer	Yes	one of: 1, 2, 3	The alert severity level this override applies to. 1 = high, 2 = moderate, 3 = low. Must not be 0 (none).
`title`	string	No		Optional. Title override used when an alert fires at this severity. Max 200 runes.

title string Yes Title used when an alert is initially fired. Max 200 runes. Required.

name string No The name of the alert rule

projectId integer No The unique identifier for the project the alert rule belongs to

scheduleId string No The schedule ID for the alert rule

updateTime string No The time the alert rule was last updated

createProjectEntityAlertRules — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertRules — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertRules — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertRules — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertRules — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertRule — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertRule — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertRule — 404 response

The required alertRule does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertRule — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertRule — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertRule — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertRule — 200 response

Successfully retrieved the alert rule with specified ID.

Property Type Required Constraints Description

actions array<object> No The actions to take when the alert rule is triggered

Property Type Required Constraints Description

One of the following 5 shapes:

Variant 1

Sends the alert notification to an email address.

Property	Type	Required	Constraints	Description
`email`	string	Yes		The destination email address.
`recipientType`	string	Yes	one of: email

Variant 2

Emits an event of eventType into the project event stream.

Property	Type	Required	Constraints	Description
`eventType`	string	Yes		The event type to emit.
`recipientType`	string	Yes	one of: event

Variant 3

Sends the alert notification to a Slack channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Slack assistant.
`channelId`	string	Yes		Slack channel identifier.
`recipientType`	string	Yes	one of: slack
`workspaceId`	string	Yes		Slack workspace identifier.

Variant 4

Sends the alert notification to a Direct chat room via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Direct assistant.
`domainId`	string	Yes		Direct domain identifier.
`recipientType`	string	Yes	one of: direct
`roomId`	string	Yes		Direct room identifier.

Variant 5

Sends the alert notification to a Microsoft Teams channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Microsoft Teams assistant.
`channelId`	string	Yes		Microsoft Teams channel identifier.
`recipientType`	string	Yes	one of: msTeams
`teamId`	string	Yes		Microsoft Teams team identifier.
`tenantId`	string	Yes		Microsoft Teams tenant identifier.

Properties of videoFeeds
Property	Type	Required	Constraints	Description
`entityId`	string	Yes		Entity owning the video feed. Supports the `{{triggeredEntityId}}` template placeholder to refer to the entity that triggered the alert.
`videoFeedId`	string	No		Optional. Specific video feed identifier. When omitted, all video feeds of the entity are used.

condition one of 5 No The condition that triggers the alert rule. The shape is discriminated by conditionType.

One of the following 5 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Property Type Required Constraints Description

conditionType string Yes one of: metricsThresholdComposite The discriminator for the condition type. Must be metricsThresholdComposite.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to this condition's metric over its duration.

entityClass string Yes The entity class that owns the metric. Every entity bound to this condition's slot must be of this class.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Properties of entityTuples
Property	Type	Required	Constraints	Description
`entities`	array<string>	Yes	min items: 2; max items: 10	The entity IDs filling each condition slot, positionally aligned with `conditions`: `entities[i]` is evaluated against `conditions[i]`. The length must equal the number of conditions, and each entity must be of its condition's `entityClass` and must be the alert rule's entity or one of its descendants. The same entity may appear in more than one slot.

Variant 3

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 5

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

creationTime string No The time the alert rule was created

description string No The description of the alert rule

disableAutoRecovery boolean No Whether alert based on this rule recover automatically

disableRecoveryAlert boolean No Whether a notification will be sent when an alert recovers

enabled boolean No Whether the alert rule is enabled

id integer No The unique identifier for the alert rule

Property Type Required Constraints Description

decreasedSeverityTitle string No Optional. Title used when an alert's severity decreases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity decreased.

increasedSeverityTitle string No Optional. Title used when an alert's severity increases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity increased.

message string No Optional. Message body used when an alert is initially fired. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryMessage string No Optional. Message body used when an alert recovers. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryTitle string No Optional. Title used when an alert recovers. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} is back to normal.

Properties of severityMessageOverrides
Property	Type	Required	Constraints	Description
`message`	string	No		Optional. Message body override used when an alert fires at this severity. Max 2000 runes.
`recoveryMessage`	string	No		Optional. Message body override used when an alert recovers from this severity. Max 2000 runes.
`recoveryTitle`	string	No		Optional. Title override used when an alert recovers from this severity. Max 200 runes.
`severity`	integer	Yes	one of: 1, 2, 3	The alert severity level this override applies to. 1 = high, 2 = moderate, 3 = low. Must not be 0 (none).
`title`	string	No		Optional. Title override used when an alert fires at this severity. Max 200 runes.

title string Yes Title used when an alert is initially fired. Max 200 runes. Required.

name string No The name of the alert rule

projectId integer No The unique identifier for the project the alert rule belongs to

scheduleId string No The schedule ID for the alert rule

updateTime string No The time the alert rule was last updated

getProjectEntityAlertRule — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertRule — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertRule — 404 response

The requested alertRule does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertRule — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertRule — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertRule — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertRule — request

Request body for Update an alert rule.

Property Type Required Constraints Description

actions array<object> No The actions to take when the alert rule is triggered

Property Type Required Constraints Description

One of the following 5 shapes:

Variant 1

Sends the alert notification to an email address.

Property	Type	Required	Constraints	Description
`email`	string	Yes		The destination email address.
`recipientType`	string	Yes	one of: email

Variant 2

Emits an event of eventType into the project event stream.

Property	Type	Required	Constraints	Description
`eventType`	string	Yes		The event type to emit.
`recipientType`	string	Yes	one of: event

Variant 3

Sends the alert notification to a Slack channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Slack assistant.
`channelId`	string	Yes		Slack channel identifier.
`recipientType`	string	Yes	one of: slack
`workspaceId`	string	Yes		Slack workspace identifier.

Variant 4

Sends the alert notification to a Direct chat room via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Direct assistant.
`domainId`	string	Yes		Direct domain identifier.
`recipientType`	string	Yes	one of: direct
`roomId`	string	Yes		Direct room identifier.

Variant 5

Sends the alert notification to a Microsoft Teams channel via an assistant.

Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		Identifier of the Microsoft Teams assistant.
`channelId`	string	Yes		Microsoft Teams channel identifier.
`recipientType`	string	Yes	one of: msTeams
`teamId`	string	Yes		Microsoft Teams team identifier.
`tenantId`	string	Yes		Microsoft Teams tenant identifier.

Properties of videoFeeds
Property	Type	Required	Constraints	Description
`entityId`	string	Yes		Entity owning the video feed. Supports the `{{triggeredEntityId}}` template placeholder to refer to the entity that triggered the alert.
`videoFeedId`	string	No		Optional. Specific video feed identifier. When omitted, all video feeds of the entity are used.

condition one of 5 No The condition that triggers the alert rule. The shape is discriminated by conditionType.

One of the following 5 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Property Type Required Constraints Description

conditionType string Yes one of: metricsThresholdComposite The discriminator for the condition type. Must be metricsThresholdComposite.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to this condition's metric over its duration.

entityClass string Yes The entity class that owns the metric. Every entity bound to this condition's slot must be of this class.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Properties of entityTuples
Property	Type	Required	Constraints	Description
`entities`	array<string>	Yes	min items: 2; max items: 10	The entity IDs filling each condition slot, positionally aligned with `conditions`: `entities[i]` is evaluated against `conditions[i]`. The length must equal the number of conditions, and each entity must be of its condition's `entityClass` and must be the alert rule's entity or one of its descendants. The same entity may appear in more than one slot.

Variant 3

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 5

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

description string No The description of the alert rule

disableAutoRecovery boolean No Whether alert based on this rule recover automatically

disableRecoveryAlert boolean No If true, the alert notification will not be sent when an alert recovers

enabled boolean No Whether the alert rule is enabled

Property Type Required Constraints Description

decreasedSeverityTitle string No Optional. Title used when an alert's severity decreases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity decreased.

increasedSeverityTitle string No Optional. Title used when an alert's severity increases. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} severity increased.

message string No Optional. Message body used when an alert is initially fired. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryMessage string No Optional. Message body used when an alert recovers. Max 2000 runes. When omitted, defaults to a link back to the alert detail page in the BizStack console.

recoveryTitle string No Optional. Title used when an alert recovers. Max 200 runes. When omitted, defaults to [{{alertRuleName}}] {{entityName}} is back to normal.

Properties of severityMessageOverrides
Property	Type	Required	Constraints	Description
`message`	string	No		Optional. Message body override used when an alert fires at this severity. Max 2000 runes.
`recoveryMessage`	string	No		Optional. Message body override used when an alert recovers from this severity. Max 2000 runes.
`recoveryTitle`	string	No		Optional. Title override used when an alert recovers from this severity. Max 200 runes.
`severity`	integer	Yes	one of: 1, 2, 3	The alert severity level this override applies to. 1 = high, 2 = moderate, 3 = low. Must not be 0 (none).
`title`	string	No		Optional. Title override used when an alert fires at this severity. Max 200 runes.

title string Yes Title used when an alert is initially fired. Max 200 runes. Required.

name string No The name of the alert rule

scheduleId string No The schedule ID for the alert rule. For removing the schedule from the alert rule, set this to empty string.

updateProjectEntityAlertRule — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertRule — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertRule — 404 response

The requested alertRule does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertRule — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertRule — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertRule — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlerts — 200 response

Successful retrieval of alerts.

Represents an alert

An array of objects with the following shape:

Property Type Required Constraints Description

alertRuleId integer No The unique identifier for the alert rule

condition one of 4 No The snapshot of condition that triggered the alert. The shape is discriminated by conditionType.

One of the following 4 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 3

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

description string No The description of the alert

entityID string No The unique identifier for the entity the alert rule belongs to

entityTuple array<string> No For a composite metrics-threshold alert only: the entity ID filling each condition slot, ordered by condition index, so tuples can be told apart. Absent for non-composite alerts.

entityType string No The class of the entity

homeId integer No The unique identifier for the home the alert rule belongs to

id string No The unique identifier for the alert

invocationTime string No The time the alert was triggered

metricName string No The name of the metric in which the alert is invoked

metricsDefinitionID string No The identifier of the group that the metric in which the alert is invoked belongs to

projectId integer No The unique identifier for the project the alert rule belongs to

recoveryTime string No The time the alert was recovered

severity integer No The severity of the alert. 1 - High, 2 - Moderate, 3 - Low

state integer No The state of the alert. 1 - Alerting, 2 - Recovered, 3 - Obsolete (an alert becomes obsolete when the alert rule is changed), 4 - Ineffective (an alert becomes ineffective when the alert rule is disabled)

videoFeedFiles array<object> No List of video feed files associated with the alert

Properties of videoFeedFiles
Property	Type	Required	Description
`entityId`	string	No	The identifier of the corresponded entity
`fileId`	string	No	The unique identifier of the file
`videoFeedId`	string	No	The identifier the corresponded video feed

listProjectEntityAlerts — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlerts — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlerts — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlerts — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlerts — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlert — 200 response

Successful retrieval of alert by specified ID.

Property Type Required Constraints Description

alertRuleId integer No The unique identifier for the alert rule

condition one of 4 No The snapshot of condition that triggered the alert. The shape is discriminated by conditionType.

One of the following 4 shapes:

Variant 1

Evaluates an aggregated metric value against one or more severity-based thresholds.

Property Type Required Constraints Description

aggregation string Yes one of: avg, min, max, sum, count The aggregation function applied to the metric over duration.

conditionType string Yes one of: metricsThreshold The discriminator for the condition type. Must be metricsThreshold.

metricsCondition object Yes The metric on which the condition is evaluated.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	Yes		The entity IDs to target (or exclude).
`exclude`	boolean	No		If true, the listed entities are excluded instead of included.
`targetBy`	string	Yes	one of: parents, entities	How to target entities.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

thresholds array<one of 3> Yes min items: 1 Severity-based thresholds. The first matching threshold determines the severity. Duplicate severities are not allowed.

Properties of thresholds
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn	The comparison operator applied to the aggregated value and `operands`.
`severity`	integer	Yes	one of: 1, 2, 3	Alert severity. 1 - High, 2 - Moderate, 3 - Low.

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

Variant 2

Fires an alert when a metric stops reporting data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: metricsHeartbeat The discriminator for the condition type. Must be metricsHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 days.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 1 hour.

metricsCondition object Yes The metric whose heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class that owns the metric.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 3

Fires an alert when an entity stops reporting location data points for the configured duration.

Property Type Required Constraints Description

conditionType string Yes one of: locationHeartbeat The discriminator for the condition type. Must be locationHeartbeat.

delay string No Optional. How long the evaluation is delayed after the job is dispatched. Must be a multiple of the job invocation interval. Capped at 10 minutes.

frequency string No Optional. How often the condition is evaluated (e.g. 1min). Must be a multiple of the job invocation interval. Capped at 10 minutes.

locationCondition object Yes The location data source on which the heartbeat is monitored.

Property Type Required Constraints Description

entityClass string Yes The entity class whose location is monitored.

entityTargetCondition object No Optional. Constraint on which entities the condition applies to. When omitted, the condition applies to the entity that owns the alert rule.

Properties of entityTargetCondition
Property	Type	Required	Constraints
`entityIds`	array<string>	Yes	min items: 1; max items: 100
`exclude`	boolean	No
`targetBy`	string	Yes	one of: parents, entities

severity integer Yes one of: 1, 2, 3 The severity emitted when the heartbeat is missed. 1 - High, 2 - Moderate, 3 - Low.

Variant 4

Evaluates geofence-based metric conditions on tracked entities.

Property Type Required Constraints Description

conditionType string Yes one of: geofence The discriminator for the condition type. Must be geofence.

duration string Yes Required. The time range over which the condition is evaluated (e.g. 1min). Must be a positive, non-zero multiple of the job invocation interval. Capped at 30 minutes.

geofenceAlertType string Yes one of: inOnly, inAndOut Whether to alert only when entering the geofence, or for both enter and exit transitions.

geofenceExcludingEntityIds array<string> No Optional. Geofence entity IDs to exclude from evaluation.

Property Type Required Constraints Description

entityClass string Yes

metricsConditions array<object> No

Properties of metricsConditions
Property	Type	Required
`metricName`	string	Yes
`metricsDefinitionId`	string	Yes
`threshold`	one of 3	Yes
Nested structure continues below this depth.

severity integer Yes one of: 1, 2, 3

geofenceTargetEntities object Yes Specifies the entities whose locations are tracked and evaluated against the geofences.

Properties of geofenceTargetEntities
Property	Type	Required	Description
`entityClass`	string	Yes	The entity class of the geofence entities.
`entityIds`	array<string>	No	Optional. Specific entity IDs to evaluate. Each ID must be a descendant of the alert rule's owning entity. When omitted, all entities of `entityClass` under `parentEntityId` are evaluated; if `parentEntityId` is also omitted, all entities of `entityClass` under the alert rule's owning entity are evaluated.
`parentEntityId`	string	No	Optional. Restricts geofence target entity resolution to descendants of this entity. Must be a descendant of the alert rule's owning entity. When omitted, target entities are resolved under the alert rule's owning entity.

metricsConditions array<object> No Optional. Per-metric threshold conditions evaluated against tracked entities. When present, metricsConditionOperator must also be set.

Property Type Required Constraints Description

entityClass string No Optional. The entity class to evaluate the metric against. When omitted, defaults to geofenceTargetEntities.entityClass.

metricName string Yes The name of the metric inside the metrics definition.

metricsDefinitionId string Yes The identifier of the metrics definition.

threshold one of 3 Yes The threshold the metric value is compared against.

Properties of threshold
Property	Type	Required	Constraints	Description
`operands`	array<number>	Yes		Operand values for the operator. Single value for `greaterThan`/`lessThan`/etc., two values for `between`/`outside` (with `operands[0] < operands[1]`), list for `in`/`notIn`.
`operator`	string	Yes	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan, between, outside, in, notIn

One of the following 3 shapes:

Variant 1

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1
`operator`	unknown	No	one of: greaterThan, greaterThanOrEqualTo, lessThanOrEqualTo, lessThan

Variant 2

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 2; max items: 2
`operator`	unknown	No	one of: between, outside

Variant 3

Property	Type	Required	Constraints	Description
`operands`	unknown	No	min items: 1; max items: 1000
`operator`	unknown	No	one of: in, notIn

description string No The description of the alert

entityID string No The unique identifier for the entity the alert rule belongs to

entityType string No The class of the entity

homeId integer No The unique identifier for the home the alert rule belongs to

id string No The unique identifier for the alert

invocationTime string No The time the alert was triggered

metricName string No The name of the metric in which the alert is invoked

metricsDefinitionID string No The identifier of the group that the metric in which the alert is invoked belongs to

projectId integer No The unique identifier for the project the alert rule belongs to

recoveryTime string No The time the alert was recovered

severity integer No The severity of the alert. 1 - High, 2 - Moderate, 3 - Low

videoFeedFiles array<object> No List of video feed files associated with the alert

Properties of videoFeedFiles
Property	Type	Required	Description
`entityId`	string	No	The identifier of the corresponded entity
`fileId`	string	No	The unique identifier of the file
`videoFeedId`	string	No	The identifier the corresponded video feed

getProjectEntityAlert — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlert — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlert — 404 response

The requested alert does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlert — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlert — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlert — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertSchedules — 200 response

Successfully retrieved the alert schedules.

Represents an alert schedule

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`description`	string	No	default: ""	Optional description for the alert schedule
`entityId`	string	No		Optional entity ID if the schedule is associated with a specific entity
`name`	string	No		The name of the alert schedule
`projectId`	integer	No		The unique identifier for the project the alert rule belongs to
`timeZone`	string	No		The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York')
`weeklySchedules`	object	No		Weekly schedule configuration

listProjectEntityAlertSchedules — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertSchedules — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertSchedules — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertSchedules — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAlertSchedules — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertSchedules — request

Request body for Create an alert schedule.

Property	Type	Required	Constraints	Description
`description`	string	No	default: ""	Optional description for the alert schedule
`name`	string	Yes		The name of the alert schedule
`timeZone`	string	Yes		The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York')
`weeklySchedules`	object	Yes		Weekly schedule configuration

createProjectEntityAlertSchedules — 201 response

Successfully created a new alert schedule.

Property	Type	Required	Constraints	Description
`description`	string	No	default: ""	Optional description for the alert schedule
`entityId`	string	No		Optional entity ID if the schedule is associated with a specific entity
`name`	string	No		The name of the alert schedule
`projectId`	integer	No		The unique identifier for the project the alert rule belongs to
`timeZone`	string	No		The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York')
`weeklySchedules`	object	No		Weekly schedule configuration

createProjectEntityAlertSchedules — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertSchedules — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertSchedules — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertSchedules — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAlertSchedules — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 404 response

The required alertSchedule does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 409 response

The alertSchedule cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAlertSchedule — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertSchedule — 200 response

Successfully retrieved the alert schedule with specified ID.

Property	Type	Required	Constraints	Description
`description`	string	No	default: ""	Optional description for the alert schedule
`entityId`	string	No		Optional entity ID if the schedule is associated with a specific entity
`name`	string	No		The name of the alert schedule
`projectId`	integer	No		The unique identifier for the project the alert rule belongs to
`timeZone`	string	No		The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York')
`weeklySchedules`	object	No		Weekly schedule configuration

getProjectEntityAlertSchedule — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertSchedule — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertSchedule — 404 response

The requested alertSchedule does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertSchedule — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertSchedule — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAlertSchedule — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertSchedule — request

Request body for Update an alert schedule.

Property	Type	Required	Constraints	Description
`description`	string	No	default: ""	Optional description for the alert schedule
`name`	string	No		The name of the alert schedule
`timeZone`	string	No		The time zone to use for the schedule (IANA time zone database format, e.g. 'America/New_York')
`weeklySchedules`	object	No		Weekly schedule configuration

updateProjectEntityAlertSchedule — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertSchedule — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertSchedule — 404 response

The requested alertSchedule does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertSchedule — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertSchedule — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAlertSchedule — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistants — 200 response

Successfully retrieved the assistants.

Represents an instance of AI Assistant associated with a project or entity.

An array of objects with the following shape:

Property Type Required Constraints Description

chatPlatform unknown Yes read-only (server-generated); one of: slack, msTeams, direct Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.

createdAt string No read-only (server-generated); format: date-time Instance creation timestamp.

description string No Additional information about AI Assistant.

directConfig object No This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

domainId string Yes domainID connected to Assistant instance.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityID string No read-only (server-generated) Optional. If present, this identifies the entity instane associated with the AI Assistant instance.

id integer Yes read-only (server-generated) The unique identifier for the AI assistant instance.

msTeamsConfig object No This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tenantId string Yes tenantID connected to Assistant instance.

name string Yes Display name of AI Assistant.

projectId integer Yes read-only (server-generated) The unique identifier for the project the AI Assistant instance belongs to.

slackConfig object No This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also inlcuded.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific Slack channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'DM'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific Slack channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'DM'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tokenState unknown Yes one of: unissued, valid, revoked Current state of athentication token issued by Slack to Assistant instance.

workspaceId string Yes ID of Slack workspace connected to Assistant instance.

updatedAt string No read-only (server-generated); format: date-time Timestamp of last update.

getAssistants — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistants — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistants — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistants — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistants — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createAssistant — request

Request body for Create an assistant.

Property Type Required Constraints Description

chatPlatform unknown Yes read-only (server-generated); one of: slack, msTeams, direct Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.

createdAt string No read-only (server-generated); format: date-time Instance creation timestamp.

description string No Additional information about AI Assistant.

directConfig object No This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

domainId string Yes domainID connected to Assistant instance.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityID string No read-only (server-generated) Optional. If present, this identifies the entity instane associated with the AI Assistant instance.

id integer Yes read-only (server-generated) The unique identifier for the AI assistant instance.

msTeamsConfig object No This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tenantId string Yes tenantID connected to Assistant instance.

name string Yes Display name of AI Assistant.

projectId integer Yes read-only (server-generated) The unique identifier for the project the AI Assistant instance belongs to.

slackConfig object No This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also inlcuded.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific Slack channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'DM'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific Slack channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'DM'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tokenState unknown Yes one of: unissued, valid, revoked Current state of athentication token issued by Slack to Assistant instance.

workspaceId string Yes ID of Slack workspace connected to Assistant instance.

updatedAt string No read-only (server-generated); format: date-time Timestamp of last update.

createAssistant — 201 response

Successfully created a new assistant.

Property Type Required Constraints Description

chatPlatform unknown Yes read-only (server-generated); one of: slack, msTeams, direct Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.

createdAt string No read-only (server-generated); format: date-time Instance creation timestamp.

description string No Additional information about AI Assistant.

directConfig object No This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

domainId string Yes domainID connected to Assistant instance.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityID string No read-only (server-generated) Optional. If present, this identifies the entity instane associated with the AI Assistant instance.

id integer Yes read-only (server-generated) The unique identifier for the AI assistant instance.

msTeamsConfig object No This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tenantId string Yes tenantID connected to Assistant instance.

name string Yes Display name of AI Assistant.

projectId integer Yes read-only (server-generated) The unique identifier for the project the AI Assistant instance belongs to.

slackConfig object No This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also inlcuded.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific Slack channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'DM'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific Slack channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'DM'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tokenState unknown Yes one of: unissued, valid, revoked Current state of athentication token issued by Slack to Assistant instance.

workspaceId string Yes ID of Slack workspace connected to Assistant instance.

updatedAt string No read-only (server-generated); format: date-time Timestamp of last update.

createAssistant — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createAssistant — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createAssistant — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createAssistant — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createAssistant — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 404 response

The required assistant does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 409 response

The assistant cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteAssistant — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistant — 200 response

Successfully retrieved the specified assistant.

Property Type Required Constraints Description

chatPlatform unknown Yes read-only (server-generated); one of: slack, msTeams, direct Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.

createdAt string No read-only (server-generated); format: date-time Instance creation timestamp.

description string No Additional information about AI Assistant.

directConfig object No This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

domainId string Yes domainID connected to Assistant instance.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityID string No read-only (server-generated) Optional. If present, this identifies the entity instane associated with the AI Assistant instance.

id integer Yes read-only (server-generated) The unique identifier for the AI assistant instance.

msTeamsConfig object No This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tenantId string Yes tenantID connected to Assistant instance.

name string Yes Display name of AI Assistant.

projectId integer Yes read-only (server-generated) The unique identifier for the project the AI Assistant instance belongs to.

slackConfig object No This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also inlcuded.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific Slack channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'DM'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific Slack channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'DM'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tokenState unknown Yes one of: unissued, valid, revoked Current state of athentication token issued by Slack to Assistant instance.

workspaceId string Yes ID of Slack workspace connected to Assistant instance.

updatedAt string No read-only (server-generated); format: date-time Timestamp of last update.

getAssistant — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistant — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistant — 404 response

The requested assistant does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistant — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistant — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getAssistant — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateAssistant — request

Request body for Update an assistant.

Property Type Required Constraints Description

chatPlatform unknown Yes read-only (server-generated); one of: slack, msTeams, direct Identifies one of the supported chat platforms that this AI Assistant instance is integrated with.

createdAt string No read-only (server-generated); format: date-time Instance creation timestamp.

description string No Additional information about AI Assistant.

directConfig object No This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

domainId string Yes domainID connected to Assistant instance.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityID string No read-only (server-generated) Optional. If present, this identifies the entity instane associated with the AI Assistant instance.

id integer Yes read-only (server-generated) The unique identifier for the AI assistant instance.

msTeamsConfig object No This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tenantId string Yes tenantID connected to Assistant instance.

name string Yes Display name of AI Assistant.

projectId integer Yes read-only (server-generated) The unique identifier for the project the AI Assistant instance belongs to.

slackConfig object No This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot.

Property Type Required Constraints Description

defaultEntityAccessRule object Yes Default rule of access to entities and their data.

Properties of defaultEntityAccessRule
Property	Type	Required	Constraints	Description
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also inlcuded.

defaultQaRule object Yes Default rule of access to Question-Answering data files.

Property Type Required Constraints Description

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

entityAccessRules array<object> No Entity access rules applied to specific Slack channels. These override the default rule.

Properties of entityAccessRules
Property	Type	Required	Constraints	Description
`channel`	string	No		ChannelID of a channel or 'DM'.
`entityIds`	array<string>	No		List of entity instances that are accessible. The instances' descendants are also included.

qaRules array<object> No QA files access rules applied to specific Slack channels. These override the default rule.

Property Type Required Constraints Description

channel string No ChannelID of a channel or 'DM'.

files object No Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled.

Properties of files
Property	Type	Required	Constraints	Description
`tag`	string	No		The tag assigned to project files or entity files meant for QA indexing.

tokenState unknown Yes one of: unissued, valid, revoked Current state of athentication token issued by Slack to Assistant instance.

workspaceId string Yes ID of Slack workspace connected to Assistant instance.

updatedAt string No read-only (server-generated); format: date-time Timestamp of last update.

updateAssistant — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateAssistant — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateAssistant — 404 response

The requested assistant does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateAssistant — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateAssistant — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateAssistant — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantDirectRooms — 200 response

Successfully retrieved the list of rooms.

A Direct room associated with an Assistant instance.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`id`	string	Yes	read-only (server-generated)	The unique identifier for the Direct room.
`name`	string	Yes	read-only (server-generated)	The name of the Direct room.

listProjectEntityAssistantDirectRooms — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantDirectRooms — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantDirectRooms — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantDirectRooms — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantEventSubscriptions — 200 response

Successfully retrieved the event subscriptions.

Represents an event subscription for an AI Assistant instance.

An array of objects with the following shape:

Property Type Required Constraints Description

actions array<object> Yes The actions to take when the event is triggered.

Property Type Required Constraints Description

config object No Configuration for the action. The structure depends on the action type. This structure can vary based on the action type, but so far, we only have 'send_message' action type.

Property Type Required Constraints Description

notificationTarget object No The target to send notifications to.

Properties of notificationTarget
Property	Type	Required	Description
`directTargets`	array<object>	No	Direct rooms to send notifications to.
Nested structure continues below this depth.
`msTeamsTargets`	array<object>	No	MS Teams channels to send notifications to.
Nested structure continues below this depth.
`slackTargets`	array<object>	No	Slack channels to send notifications to.
Nested structure continues below this depth.

type unknown No one of: send_message The type of action to perform.

assistantId integer Yes The unique identifier for the AI Assistant instance this event subscription belongs to.

createdAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was created.

description string No A description of the event subscription.

disabled boolean No Whether the event subscription is disabled.

eventType string Yes The type of event to subscribe to. The pair of (assistantId, eventType) must be unique.

id integer No read-only (server-generated) The unique identifier for the event subscription.

name string Yes Display name of the event subscription.

projectId integer Yes The unique identifier for the project the event subscription belongs to.

updatedAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was last updated.

listProjectEntityAssistantEventSubscriptions — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantEventSubscriptions — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantEventSubscriptions — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantEventSubscriptions — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantEventSubscriptions — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAssistantEventSubscriptions — request

Request body for Create event subscription.

Property Type Required Constraints Description

actions array<object> Yes The actions to take when the event is triggered.

Property Type Required Constraints Description

config object No Configuration for the action. The structure depends on the action type. This structure can vary based on the action type, but so far, we only have 'send_message' action type.

Property Type Required Constraints Description

notificationTarget object No The target to send notifications to.

Properties of notificationTarget
Property	Type	Required	Description
`directTargets`	array<object>	No	Direct rooms to send notifications to.
Nested structure continues below this depth.
`msTeamsTargets`	array<object>	No	MS Teams channels to send notifications to.
Nested structure continues below this depth.
`slackTargets`	array<object>	No	Slack channels to send notifications to.
Nested structure continues below this depth.

type unknown No one of: send_message The type of action to perform.

assistantId integer Yes The unique identifier for the AI Assistant instance this event subscription belongs to.

createdAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was created.

description string No A description of the event subscription.

disabled boolean No Whether the event subscription is disabled.

eventType string Yes The type of event to subscribe to. The pair of (assistantId, eventType) must be unique.

id integer No read-only (server-generated) The unique identifier for the event subscription.

name string Yes Display name of the event subscription.

projectId integer Yes The unique identifier for the project the event subscription belongs to.

updatedAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was last updated.

createProjectEntityAssistantEventSubscriptions — 201 response

Successfully created the event subscription.

Property Type Required Constraints Description

actions array<object> Yes The actions to take when the event is triggered.

Property Type Required Constraints Description

config object No Configuration for the action. The structure depends on the action type. This structure can vary based on the action type, but so far, we only have 'send_message' action type.

Property Type Required Constraints Description

notificationTarget object No The target to send notifications to.

Properties of notificationTarget
Property	Type	Required	Description
`directTargets`	array<object>	No	Direct rooms to send notifications to.
Nested structure continues below this depth.
`msTeamsTargets`	array<object>	No	MS Teams channels to send notifications to.
Nested structure continues below this depth.
`slackTargets`	array<object>	No	Slack channels to send notifications to.
Nested structure continues below this depth.

type unknown No one of: send_message The type of action to perform.

assistantId integer Yes The unique identifier for the AI Assistant instance this event subscription belongs to.

createdAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was created.

description string No A description of the event subscription.

disabled boolean No Whether the event subscription is disabled.

eventType string Yes The type of event to subscribe to. The pair of (assistantId, eventType) must be unique.

id integer No read-only (server-generated) The unique identifier for the event subscription.

name string Yes Display name of the event subscription.

projectId integer Yes The unique identifier for the project the event subscription belongs to.

updatedAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was last updated.

createProjectEntityAssistantEventSubscriptions — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAssistantEventSubscriptions — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAssistantEventSubscriptions — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAssistantEventSubscriptions — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createProjectEntityAssistantEventSubscriptions — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 404 response

The required eventSubscription does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 409 response

The eventSubscription cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteProjectEntityAssistantEventSubscription — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAssistantEventSubscription — 200 response

Successfully retrieved the specified event subscription.

Property Type Required Constraints Description

actions array<object> Yes The actions to take when the event is triggered.

Property Type Required Constraints Description

config object No Configuration for the action. The structure depends on the action type. This structure can vary based on the action type, but so far, we only have 'send_message' action type.

Property Type Required Constraints Description

notificationTarget object No The target to send notifications to.

Properties of notificationTarget
Property	Type	Required	Description
`directTargets`	array<object>	No	Direct rooms to send notifications to.
Nested structure continues below this depth.
`msTeamsTargets`	array<object>	No	MS Teams channels to send notifications to.
Nested structure continues below this depth.
`slackTargets`	array<object>	No	Slack channels to send notifications to.
Nested structure continues below this depth.

type unknown No one of: send_message The type of action to perform.

assistantId integer Yes The unique identifier for the AI Assistant instance this event subscription belongs to.

createdAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was created.

description string No A description of the event subscription.

disabled boolean No Whether the event subscription is disabled.

eventType string Yes The type of event to subscribe to. The pair of (assistantId, eventType) must be unique.

id integer No read-only (server-generated) The unique identifier for the event subscription.

name string Yes Display name of the event subscription.

projectId integer Yes The unique identifier for the project the event subscription belongs to.

updatedAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was last updated.

getProjectEntityAssistantEventSubscription — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAssistantEventSubscription — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAssistantEventSubscription — 404 response

The requested eventSubscription does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAssistantEventSubscription — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAssistantEventSubscription — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityAssistantEventSubscription — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAssistantEventSubscription — request

Request body for Update an event subscription.

Property Type Required Constraints Description

actions array<object> Yes The actions to take when the event is triggered.

Property Type Required Constraints Description

config object No Configuration for the action. The structure depends on the action type. This structure can vary based on the action type, but so far, we only have 'send_message' action type.

Property Type Required Constraints Description

notificationTarget object No The target to send notifications to.

Properties of notificationTarget
Property	Type	Required	Description
`directTargets`	array<object>	No	Direct rooms to send notifications to.
Nested structure continues below this depth.
`msTeamsTargets`	array<object>	No	MS Teams channels to send notifications to.
Nested structure continues below this depth.
`slackTargets`	array<object>	No	Slack channels to send notifications to.
Nested structure continues below this depth.

type unknown No one of: send_message The type of action to perform.

assistantId integer Yes The unique identifier for the AI Assistant instance this event subscription belongs to.

createdAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was created.

description string No A description of the event subscription.

disabled boolean No Whether the event subscription is disabled.

eventType string Yes The type of event to subscribe to. The pair of (assistantId, eventType) must be unique.

id integer No read-only (server-generated) The unique identifier for the event subscription.

name string Yes Display name of the event subscription.

projectId integer Yes The unique identifier for the project the event subscription belongs to.

updatedAt string No read-only (server-generated); format: date-time Timestamp when the event subscription was last updated.

updateProjectEntityAssistantEventSubscription — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAssistantEventSubscription — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAssistantEventSubscription — 404 response

The requested eventSubscription does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAssistantEventSubscription — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAssistantEventSubscription — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateProjectEntityAssistantEventSubscription — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantMsTeamsTeams — 200 response

Successfully retrieved the list of rooms.

A Microsoft Teams team associated with an Assistant instance.

An array of objects with the following shape:

Property Type Required Constraints Description

channels array<object> Yes

Properties of channels
Property	Type	Required	Constraints	Description
`id`	string	Yes	read-only (server-generated)	The unique identifier for the channel.
`name`	string	Yes	read-only (server-generated)	The name of the channel.

id string Yes read-only (server-generated) The unique identifier for the Team.

name string Yes read-only (server-generated) The name of the Team.

listProjectEntityAssistantMsTeamsTeams — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantMsTeamsTeams — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantMsTeamsTeams — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantMsTeamsTeams — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantSlackChannels — 200 response

Successfully retrieved the Slack channels.

A Slack channel associated with an Assistant instance.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`id`	string	Yes	read-only (server-generated)	The unique identifier for the Slack Channel.
`name`	string	Yes	read-only (server-generated)	The name of the Slack Channel.

listProjectEntityAssistantSlackChannels — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantSlackChannels — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantSlackChannels — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

listProjectEntityAssistantSlackChannels — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogDefinition — 200 response

Successful retrieval of custom log definition.

Property Type Required Constraints Description

customLogDefinitionId string No ID of the custom log definition. Must be unique within an Entity Class.

dataStoreConfiguration object No Data store configuration of custom log.

Property Type Required Constraints Description

bulkDataLabel string No Unused in this context (leave empty).

cldsConfig object No CLDS configuration. Required only if module type is 'clds'.

Properties of cldsConfig
Property	Type	Required	Constraints	Description
`collectionName`	string	No		CLDS Log Collection Name. Required only if module type is 'clds'.

moduleInstanceId string No Home App Proxy source path. Required only if module type is 'home_app_proxy'.

moduleType string No one of: clds, home_app_proxy Module type, either 'clds' or 'home_app_proxy'.

displayName string No The display name of the custom log definition.

numericFields array<object> No List of numerical field definitions.

Property Type Required Constraints Description

displayName string No The display name of the field.

name string No The name of the field.

range object No The range of the field's values.

Properties of range
Property	Type	Required	Constraints	Description
`max`	number	No		The maximum value.
`min`	number	No		The minimum value.

unit string No The unit of measure.

stringFields array<object> No List of string field definitions.

Property Type Required Constraints Description

displayName string No The display name of the field

enumDefinitions array<object> No read-only (server-generated) The enumerated human-readable values for the field value

Properties of enumDefinitions
Property	Type	Required	Constraints	Description
`name`	string	No		The human-readable value for the field value
`value`	string	No		A field value

name string No The name of the field.

getCustomLogDefinition — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogDefinition — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogDefinition — 404 response

The requested customLog does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogDefinition — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogDefinition — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogDefinition — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getCustomLogData — 200 response

The requested custom log records are returned.

Property Type Required Constraints Description

begin string No read-only (server-generated) The begin time of data entries. The format follows RFC3339.

end string No read-only (server-generated) The end time of data entries. The format follows RFC3339.

limit integer No read-only (server-generated) The maximum number of data entries to be fetched.

records array<object> No read-only (server-generated) Log entries. Each entry is a log record object.

Properties of records
Property	Type	Required	Constraints	Description
`entryId`	string	Yes	read-only (server-generated)	Unique ID of the log record entry.
`eventKey`	string	No	read-only (server-generated)	Event key of the log record.
`fields`	object	Yes	read-only (server-generated)	An object of key-value pairs containing the log data.
`timestamp`	string	Yes	read-only (server-generated)	Time in RFC3339 format.

skip integer No read-only (server-generated) Number of data entries skipped over.

total integer No read-only (server-generated) The total number of data entries for the query.

postCustomLogRecords — request

Request body for Post custom log records.

Represents a custom log record.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`entryId`	string	Yes	read-only (server-generated)	Unique ID of the log record entry.
`eventKey`	string	No	read-only (server-generated)	Event key of the log record.
`fields`	object	Yes	read-only (server-generated)	An object of key-value pairs containing the log data.
`timestamp`	string	Yes	read-only (server-generated)	Time in RFC3339 format.

deleteLogRecordEntry — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLogRecordEntry — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLogRecordEntry — 404 response

The required data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLogRecordEntry — 409 response

The data cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLogRecordEntry — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLogRecordEntry — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLogRecordEntry — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLogRecordEntry — 200 response

The requested custom log record is returned.

Property	Type	Required	Constraints	Description
`entryId`	string	Yes	read-only (server-generated)	Unique ID of the log record entry.
`eventKey`	string	No	read-only (server-generated)	Event key of the log record.
`fields`	object	Yes	read-only (server-generated)	An object of key-value pairs containing the log data.
`timestamp`	string	Yes	read-only (server-generated)	Time in RFC3339 format.

getLogRecordEntry — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLogRecordEntry — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLogRecordEntry — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLogRecordEntry — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLogRecordEntry — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLogRecordEntry — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLogRecordEntry — request

Request body for Update log record entry.

Property	Type	Required	Constraints	Description
`fields`	object	Yes	read-only (server-generated)	An object of key-value pairs containing the log data.

updateLogRecordEntry — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLogRecordEntry — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLogRecordEntry — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLogRecordEntry — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLogRecordEntry — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLogRecordEntry — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportCustomLogData — request

Request body for Export custom log data.

Property	Type	Required	Description
`begin`	string	Yes	The begin time of the search range.
`end`	string	Yes	The end time of the search range.
`fileName`	string	No	Optional parameter to specify the export CSV file name. If omitted, custom log definition ID will be used in the file name.
`includeHeader`	boolean	No	If true, the exported CSV file will start with a header.
`timeFormat`	string	No	Optional parameter to specify the timestamp format in the exported CSV. Use "rfc3339Milli" for RFC3339 format with millisecond precision. If omitted, the default format (YYYY/MM/DD HH:MM:SS) is used.

exportCustomLogData — 200 response

The URLs for downloading the exported data are returned.

Property	Type	Required	Constraints	Description
`dataUrl`	string	Yes	read-only (server-generated)	URL of file containing the exported data. This URL is usable only if the export is completed successfully.
`statusUrl`	string	Yes	read-only (server-generated)	URL to a JSON file that reports the status of the export. Clients should poll this URL until a file is returned.

exportCustomLogData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportCustomLogData — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportCustomLogData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportCustomLogData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportCustomLogData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getProjectEntityCustomLogValueList — 200 response

Successfully retrieved distinct values.

Property	Type	Required	Constraints	Description
`count`	integer	Yes		The total number of unique values returned.
`values`	array<object>	Yes		An array containing the unique values found for the field. Values can be strings, numbers, or booleans.

sendEventEntity — request

Request body for Send event to an entity.

Property	Type	Required	Constraints	Description
`eventData`	object	Yes		Event-specific data as a JSON hash. Opaque to the cloud service.
`eventType`	string	Yes	pattern: ^[a-zA-Z](?:[\-_]?[a-zA-Z0-9]+)*$	Event type ID. Must begin 1 or more alpha characters; dashes ('-') and underscores ('_') may be used after the first character but must be followed by 1+ alphanumeric characters.
`homeId`	integer	No	read-only (server-generated)	ID of the home associated with this event. MODE adds this at event delivery to listeners. Devices don't need to add this.
`originDeviceClass`	string	No	read-only (server-generated)	If the event originates from a device, this property is the device's class ID. MODE adds this at event delivery to listener.
`originDeviceId`	integer	No	read-only (server-generated)	MODE adds this at event delivery to listeners. This property is present if the event originates from a device.
`originDeviceIp`	string	No	read-only (server-generated)	IP address of device. This property is present if the event originates from a device. MODE adds this at event delivery to listeners.
`originProjectKeyId`	string	No	read-only (server-generated)	If the event originates from a project API key, this property is the unique key ID. MODE adds this at event delivery to listener.
`originProjectKeyName`	string	No	read-only (server-generated)	If the event originates from a project API key, this property is its display name. MODE adds this at event delivery to listener.
`timestamp`	string	No	read-only (server-generated); format: date-time	Moment when event was triggered. MODE adds this at event delivery to listeners. Devices don't need to add this.

sendEventEntity — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

sendEventEntity — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

sendEventEntity — 404 response

The requested event does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

sendEventEntity — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

sendEventEntity — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

sendEventEntity — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFiles — 200 response

Successful query for files associated with an entity instance.

An arbitrary file associated with an entity.

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`attributes`	object	No		Attributes associated with the entity file, separated as key-value pairs.
`contentType`	string	No		MIME type of the entity file.
`entityId`	string	Yes	read-only (server-generated)	Entity that this entity file belongs to.
`expirationDate`	string	No	format: date-time	Timestamp indicating when the entity file should expire.
`fileId`	string	No	read-only (server-generated)	ID of the entity file.
`fileName`	string	No	read-only (server-generated)	Name of the entity file.
`projectId`	integer	Yes	read-only (server-generated)	Project that this entity file belongs to.
`tags`	array	No		A collection of unique string identifiers associated with the entity file.
`timestamp`	string	No	read-only (server-generated); format: date-time	Timestamp of the entity file.
`url`	string	No		A pre-signed URL for file download.

getEntityFiles — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFiles — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFiles — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFiles — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFiles — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 404 response

The required file does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 409 response

The file cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityFile — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFileMetadata — 200 response

Successful retrieval of entity file metadata.

Property	Type	Required	Constraints	Description
`attributes`	object	No		Attributes associated with the entity file, separated as key-value pairs.
`contentType`	string	No		MIME type of the entity file.
`entityId`	string	Yes	read-only (server-generated)	Entity that this entity file belongs to.
`expirationDate`	string	No	format: date-time	Timestamp indicating when the entity file should expire.
`fileId`	string	No	read-only (server-generated)	ID of the entity file.
`fileName`	string	No	read-only (server-generated)	Name of the entity file.
`projectId`	integer	Yes	read-only (server-generated)	Project that this entity file belongs to.
`tags`	array	No		A collection of unique string identifiers associated with the entity file.
`timestamp`	string	No	read-only (server-generated); format: date-time	Timestamp of the entity file.
`url`	string	No		A pre-signed URL for file download.

getEntityFileMetadata — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFileMetadata — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFileMetadata — 404 response

The requested file does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFileMetadata — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFileMetadata — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityFileMetadata — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityFileMetadata — request

Request body for Update entity file metadata.

Property	Type	Required	Constraints	Description
`attributes`	object	No		Attributes associated with the entity file, separated as key-value pairs.
`expirationDate`	string	No	format: date-time	Timestamp indicating when the entity file should expire.
`tags`	array	No		A collection of unique string identifiers associated with the entity file.

updateEntityFileMetadata — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityFileMetadata — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityFileMetadata — 404 response

The requested file does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityFileMetadata — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityFileMetadata — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityFileMetadata — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 404 response

The required location does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 409 response

The location cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocation — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationMetadata — 200 response

Successful retrieval of location metadata.

Property Type Required Constraints Description

attributeSchema array No read-only (server-generated) A schema used for visualizing the attributes of location.

collectionId string Yes read-only (server-generated) A collection ID that the location belongs to.

collectionKey string Yes read-only (server-generated); one of: ancestor, parent, self, home A type of location collection management pattern.

dataStoreConfiguration object Yes read-only (server-generated) Data store configuration of location.

Properties of dataStoreConfiguration
Property	Type	Required	Description
`bulkDataLabel`	string	No	Bulk data label of the module instance.
`moduleInstanceId`	string	No	Module instance ID for GeoTSDB.
`moduleType`	string	No	Module type. Must be geotsdb.

getLocationMetadata — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationMetadata — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationMetadata — 404 response

The requested location does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationMetadata — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationMetadata — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationMetadata — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLocation — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLocation — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLocation — 404 response

The requested location does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLocation — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLocation — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateLocation — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 404 response

The required data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 409 response

The data cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteLocationData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationData — 200 response

The requested location data entries are returned.

Property Type Required Constraints Description

begin string No read-only (server-generated) The begin time of data entries. The format follows RFC3339.

collectionId string No read-only (server-generated) Identifier of the GeoTSDB collection.

data array<object> No read-only (server-generated) Geospatial Time-series data. Each entry contains the timestamp of the value in RFC3339 format and GeoJSON formatted location data.

Property Type Required Constraints Description

areas array<object> No

Properties of areas
Property	Type	Required
`areaClass`	string	No
`areaId`	string	Yes
`distance`	number	Yes

attributes object No read-only (server-generated) The attributes that belong to the location, separated as key-value pairs.

createdAt string No Created date time in RFC3339 format.

floorId number Yes read-only (server-generated) The floor ID of the location

geometry object Yes read-only (server-generated) The GeoJSON object of the location.

searchKey string Yes read-only (server-generated) The string attached to the location.

timestamp string Yes read-only (server-generated) Time in RFC3339 format.

end string No read-only (server-generated) The end time of data entries. The format follows RFC3339.

getLocationData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationData — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationData — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLocationData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

postLocationData — request

Request body for Post location data.

Property Type Required Constraints Description

data array<object> Yes Time-series data. Each entry contains the timestamp of the value in RFC3339 format.

Properties of data
Property	Type	Required	Description
`areas`	array<object>	No	The areas associated with the location
`attributes`	object	No	The attributes that belong to the location, separated as key-value pairs.
`createdAt`	string	No	Created date time in RFC3339 format.
`floorId`	number	No	The floor ID of the location
`geometry`	object	Yes	The GeoJSON object of the location.
`timestamp`	string	Yes	Time in RFC3339 format.

deleteObjectCounterHistory — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteObjectCounterHistory — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteObjectCounterHistory — 404 response

The required data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteObjectCounterHistory — 409 response

The data cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteObjectCounterHistory — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteObjectCounterHistory — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteObjectCounterHistory — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getObjectCounterHistory — 200 response

The requested object counter data entries are returned.

Property Type Required Constraints Description

counterId string No The unique identifier of the counter.

data array<object> Yes Time-series data. Each entry contains the timestamp of the value in RFC3339 format.

Properties of data
Property	Type	Required	Description
`areaId`	string	Yes	The area of the count.
`count`	number	Yes	The number of objects in an area.
`timestamp`	string	Yes	Time in RFC3339 format.

getObjectCounterHistory — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getObjectCounterHistory — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getObjectCounterHistory — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getObjectCounterHistory — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getObjectCounterHistory — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getObjectCounterHistory — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

manageEntityMedia — request

Request body for Manage entity media.

Property	Type	Required	Constraints	Description
`action`	string	Yes	one of: open-upload, close-upload, delete	Action to be taken.
`fileName`	string	No		Filename of the icon or image. Needed only if requesting to open an upload.
`target`	string	Yes	one of: icon, image	Which media the action should be applied to.

manageEntityMedia — 200 response

Request to upload an icon or image was successful. The response body is a JSON object that contains a signed upload URL. The client should make a PUT request with that URL to upload the icon or image file.

Property	Type	Required	Constraints	Description
`uploadUrl`	string	No		A signed URL for uploading the media file.

manageEntityMedia — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

manageEntityMedia — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

manageEntityMedia — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

manageEntityMedia — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

manageEntityMedia — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 404 response

The required metric does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 409 response

The metric cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetric — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsDefinition — 200 response

Successful retrieval of metrics definition.

Property Type Required Constraints Description

dataStoreConfiguration object Yes Data store configuration of metrics.

Property Type Required Constraints Description

bulkDataLabel string No If Module Type is tsdb or sensor_cloud_tsdb the module instance, this field is the bulk data lable assigned to the TSDB module instance.

moduleInstanceId string No If Module Type is tsdb or sensor_cloud_tsdb, this field is the TSDB module instance ID. If module type is home_app_proxy, this field is the Home App Proxy path.

moduleType string No Module type. Must be tsdb, tsdbv2, sensor_cloud_tsdb, or home_app_proxy.

sensorCloudTSDBConfig object No Required if Module Type is sensor_cloud_tsdb

Properties of sensorCloudTSDBConfig
Property	Type	Required	Constraints	Description
`attributeForCollectionId`	string	No		Entity attribute that holds the TSDB collection ID corresponding to the metrics definition.

tsdbv2Config object No Required if Module Type is tsdbv2

Properties of tsdbv2Config
Property	Type	Required	Constraints	Description
`managed`	boolean	No		Whether BizStack should manage the TSDBv2 schema. If set to true, BizStack will manage the corresponding TSDBv2 schema for the entity metrics definition based on the provided numericMetrics and tagMetrics. This means that BizStack will: - create the schema if it does not exist; - create the numericMetrics and tagMetrics specified in the request; and - delete any numericMetrics and tagMetrics that exist in the TSDBv2 schema but not in the request. If set to false, you are expected to create the TSDBv2 schema yourself and set schemaName accordingly. BizStack will only validate that a schema with schemaName exists. numericMetrics and tagMetrics must be provided if managed=true, and must not be provided if managed=false.
`schemaName`	string	No		Name of TSDBv2 schema used by metrics definition.

displayName string No The display name for the metrics.

metricsDefinitionId string Yes read-only (server-generated) ID of the metrics definition. Must be unique within an Entity Class.

metricsType string Yes read-only (server-generated) Type of metrics. Must be raw or derived.

numericMetrics array Yes List of numerical field definitions.

tagMetrics array No List of string tag definitions.

getMetricsDefinition — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsDefinition — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsDefinition — 404 response

The requested metric does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsDefinition — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsDefinition — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsDefinition — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMetric — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMetric — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMetric — 404 response

The requested metric does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMetric — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMetric — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateMetric — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 404 response

The required data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 409 response

The data cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteMetricsData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsData — 200 response

The requested metrics data entries are returned.

Property	Type	Required	Constraints	Description
`aggregation`	string	No	read-only (server-generated); one of: avg, min, max, sum, count	Aggregation method used.
`begin`	string	No	read-only (server-generated)	The begin time of data entries. The format follows RFC3339.
`data`	array	No	read-only (server-generated)	Collection data. Each entry is an array as tuple and the first item is timestamp of the value in RFC3339 format, followed by the selected values and tags. e.g. [["2016-01-01T00:00:00Z", 1.0, 333, "foo"], ["2016-01-02T00:00:00Z", 2.0, 299, "bar"]]
`end`	string	No	read-only (server-generated)	The end time of data entries. The format follows RFC3339.
`limit`	integer	No	read-only (server-generated)	The maximum number of data entries to be fetched.
`resolution`	string	No	read-only (server-generated); one of: 1min, 10min, 1hour, 1day, 1week, 1month	Aggregation bucket resolution. Its value depends on the time span of the query.
`ts`	string	No	read-only (server-generated)	The point in time (in RFC3339) from which data entries were fetched.

getMetricsData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsData — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsData — 404 response

The requested data does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getMetricsData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

postMetricsData — request

Request body for Post metrics data.

Property Type Required Constraints Description

records array<object> Yes read-only (server-generated) Time-series data. Each entry contains the timestamp of the value in RFC3339 format.

Properties of records
Property	Type	Required	Constraints	Description
`tags`	array<string>	No	read-only (server-generated)	An array of tags. The items must correspond to the items in tagNames
`timestamp`	string	Yes	read-only (server-generated)	Time in RFC3339 format
`values`	array<number>	Yes	read-only (server-generated)	An array of values. The items must correspond to the items in valueNames

tagNames array<string> No read-only (server-generated) List of unique Identifiers of string tags in metrics.

valueNames array<string> Yes read-only (server-generated) List of unique Identifiers of numerical fields in metrics.

exportMetricsData — request

Request body for Export metrics data.

Property	Type	Required	Description
`begin`	string	Yes	The beginning time of the data entries. The format follows RFC3339.
`end`	string	Yes	The end time of the data entries. The format follows RFC3339.
`fileName`	string	No	Optional parameter to specify the export CSV file name. If omitted, metrics definition ID will be used in the file name.
`includeHeader`	boolean	No	If true, the exported CSV file will start with a header.
`timeFormat`	string	No	Optional parameter to specify the timestamp format in the exported CSV. Use "rfc3339Milli" for RFC3339 format with millisecond precision. If omitted, the default format (YYYY/MM/DD HH:MM:SS) is used.

exportMetricsData — 200 response

The URLs for downloading the exported data are returned.

Property	Type	Required	Constraints	Description
`dataUrl`	string	Yes	read-only (server-generated)	URL of file containing the exported data. This URL is usable only if the export is completed successfully.
`statusUrl`	string	Yes	read-only (server-generated)	URL to a JSON file that reports the status of the export. Clients should poll this URL until a file is returned.

exportMetricsData — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportMetricsData — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportMetricsData — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportMetricsData — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

exportMetricsData — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReports — 200 response

Successfully retrieved the scheduled reports.

Property Type Required Constraints Description

data array<object> Yes

Property Type Required Constraints Description

answerEngine object Yes

Properties of answerEngine
Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		ID of the assistant to use for generating answers
`maxConcurrentCalls`	integer	No	default: 4	Maximum number of concurrent calls to the assistant

contents string Yes YAML configuration for report sections

creationTime string No format: date-time When the report was created

description string No Description of the scheduled report

directDestination array<object> No Direct rooms to send the report to

Properties of directDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Direct room ID
`name`	string	No		Direct room name

enabled boolean No Whether the scheduled report is enabled

id integer Yes Unique identifier for the scheduled report

projectId integer Yes ID of the project this report belongs to

reportSchedule object Yes

Properties of reportSchedule
Property	Type	Required	Description
`expression`	string	Yes	Schedule expression (e.g., cron expression)
`timeZone`	string	No	Timezone for the schedule
`type`	string	Yes	Type of schedule (e.g., cron)

slackDestination array<object> No Slack channels to send the report to

Properties of slackDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Slack channel ID
`name`	string	No		Slack channel name

teamsDestination array<object> No MS Teams channels to send the report to

Properties of teamsDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		MS Teams channel ID
`name`	string	No		MS Teams channel name

title string Yes Title of the scheduled report

updateTime string No format: date-time When the report was last updated

metadata object Yes

Properties of metadata
Property	Type	Required	Description
`count`	integer	No	Number of items returned
`limit`	integer	No	Maximum number of items requested
`skip`	integer	No	Number of items skipped
`totalCount`	integer	No	Total number of items available

getEntityScheduledReports — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReports — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReports — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReports — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReports — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityScheduledReport — request

Request body for Create entity scheduled report.

Property Type Required Constraints Description

answerEngine object Yes

Properties of answerEngine
Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		ID of the assistant to use for generating answers
`maxConcurrentCalls`	integer	No	default: 4	Maximum number of concurrent calls to the assistant

contents string Yes YAML configuration for report sections including entities and queries

description string No Description of the scheduled report

directDestination array<object> No Direct rooms to send the report to (required for Direct assistants)

Properties of directDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Direct room ID

enabled boolean No default: true Whether the scheduled report is enabled

projectId integer Yes ID of the project this report belongs to

reportSchedule object Yes

Properties of reportSchedule
Property	Type	Required	Description
`expression`	string	Yes	Schedule expression (e.g., cron expression)
`timeZone`	string	No	Timezone for the schedule
`type`	string	Yes	Type of schedule (e.g., cron)

slackDestination array<object> No Slack channels to send the report to (required for Slack assistants)

Properties of slackDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Slack channel ID

teamsDestination array<object> No MS Teams channels to send the report to (required for MS Teams assistants)

Properties of teamsDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		MS Teams channel ID

title string Yes Title of the scheduled report

createEntityScheduledReport — 201 response

New scheduled report successfully created.

Property Type Required Constraints Description

answerEngine object Yes

Properties of answerEngine
Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		ID of the assistant to use for generating answers
`maxConcurrentCalls`	integer	No	default: 4	Maximum number of concurrent calls to the assistant

contents string Yes YAML configuration for report sections

creationTime string No format: date-time When the report was created

description string No Description of the scheduled report

directDestination array<object> No Direct rooms to send the report to

Properties of directDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Direct room ID
`name`	string	No		Direct room name

enabled boolean No Whether the scheduled report is enabled

id integer Yes Unique identifier for the scheduled report

projectId integer Yes ID of the project this report belongs to

reportSchedule object Yes

Properties of reportSchedule
Property	Type	Required	Description
`expression`	string	Yes	Schedule expression (e.g., cron expression)
`timeZone`	string	No	Timezone for the schedule
`type`	string	Yes	Type of schedule (e.g., cron)

slackDestination array<object> No Slack channels to send the report to

Properties of slackDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Slack channel ID
`name`	string	No		Slack channel name

teamsDestination array<object> No MS Teams channels to send the report to

Properties of teamsDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		MS Teams channel ID
`name`	string	No		MS Teams channel name

title string Yes Title of the scheduled report

updateTime string No format: date-time When the report was last updated

createEntityScheduledReport — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityScheduledReport — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityScheduledReport — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityScheduledReport — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityScheduledReport — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityScheduledReport — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityScheduledReport — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityScheduledReport — 409 response

The scheduledReport cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityScheduledReport — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityScheduledReport — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityScheduledReport — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReport — 200 response

Successfully retrieved the specified scheduled report.

Property Type Required Constraints Description

answerEngine object Yes

Properties of answerEngine
Property	Type	Required	Constraints	Description
`assistantId`	integer	Yes		ID of the assistant to use for generating answers
`maxConcurrentCalls`	integer	No	default: 4	Maximum number of concurrent calls to the assistant

contents string Yes YAML configuration for report sections

creationTime string No format: date-time When the report was created

description string No Description of the scheduled report

directDestination array<object> No Direct rooms to send the report to

Properties of directDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Direct room ID
`name`	string	No		Direct room name

enabled boolean No Whether the scheduled report is enabled

id integer Yes Unique identifier for the scheduled report

projectId integer Yes ID of the project this report belongs to

reportSchedule object Yes

Properties of reportSchedule
Property	Type	Required	Description
`expression`	string	Yes	Schedule expression (e.g., cron expression)
`timeZone`	string	No	Timezone for the schedule
`type`	string	Yes	Type of schedule (e.g., cron)

slackDestination array<object> No Slack channels to send the report to

Properties of slackDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Slack channel ID
`name`	string	No		Slack channel name

teamsDestination array<object> No MS Teams channels to send the report to

Properties of teamsDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		MS Teams channel ID
`name`	string	No		MS Teams channel name

title string Yes Title of the scheduled report

updateTime string No format: date-time When the report was last updated

getEntityScheduledReport — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReport — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReport — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReport — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityScheduledReport — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityScheduledReport — request

Request body for Update an entity scheduled report.

Property Type Required Constraints Description

contents string No YAML configuration for report sections including entities and queries

description string No Description of the scheduled report

directDestination array<object> No Direct rooms to send the report to

Properties of directDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Direct room ID

enabled boolean No Whether the scheduled report is enabled

reportSchedule object No

Properties of reportSchedule
Property	Type	Required	Description
`expression`	string	No	Schedule expression (e.g., cron expression)
`timeZone`	string	No	Timezone for the schedule
`type`	string	No	Type of schedule (e.g., cron)

slackDestination array<object> No Slack channels to send the report to

Properties of slackDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		Slack channel ID

teamsDestination array<object> No MS Teams channels to send the report to

Properties of teamsDestination
Property	Type	Required	Constraints	Description
`id`	string	Yes		MS Teams channel ID

title string No Title of the scheduled report

updateEntityScheduledReport — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityScheduledReport — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityScheduledReport — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityScheduledReport — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

uploadFile — request

Request body for Upload a file.

Property Type Required Constraints Description

action string Yes one of: open-upload, close-upload Action to be taken.

metadata object No Metadata for the file. Required for the open-upload action.

Properties of metadata
Property	Type	Required	Description
`attributes`	string	No	Type of the file.
`contentType`	string	No	Type of the entity instance.
`expirationDate`	string	No	Name of the file.
`fileName`	integer	No	Size of the file.
`tags`	string	No	ID of the file.
`timestamp`	string	No	ID of the entity instance.

numberOfParts integer No Optional number of parts to split the upload into. Defaults to 1.

uploadId string No Upload ID returned from the open-upload action. Required for the close-upload action.

uploadFile — 200 response

For the open-upload action, this represents a successful start of the upload for a file. The response body is a JSON object that contains an array of pre-signed upload URLs. The client should divide up the file in the same number of parts as the number of URLs, and upload each part to its corresponding URL with a PUT request.

Property	Type	Required	Constraints	Description
`uploadId`	string	No		Upload ID returned from the open-upload action.
`urls`	array<string>	No		URL to upload the entity file, or, URLs to upload each part of the entity file.

uploadFile — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

uploadFile — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

uploadFile — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

uploadFile — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

uploadFile — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeeds — 200 response

Successful query for video feeds associated with an entity instance.

Represents a video feed

An array of objects with the following shape:

Property	Type	Required	Constraints	Description
`displayName`	string	No		Display name of the video feed
`entityId`	string	No	read-only (server-generated)	Entity that this entity file belongs to.
`id`	string	No		ID of the video feed
`projectId`	integer	No	read-only (server-generated)	Project that this entity file belongs to.

getVideoFeeds — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeeds — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeeds — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeeds — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeeds — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createVideoFeed — request

Request body for Create a video feed.

Property	Type	Required	Constraints	Description
`displayName`	string	No		Display name of the video feed.

createVideoFeed — 201 response

Successfully created a new video feed.

Property	Type	Required	Constraints	Description
`displayName`	string	No		Display name of the video feed
`entityId`	string	No	read-only (server-generated)	Entity that this entity file belongs to.
`id`	string	No		ID of the video feed
`projectId`	integer	No	read-only (server-generated)	Project that this entity file belongs to.

createVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createVideoFeed — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 404 response

The required videoFeed does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 409 response

The videoFeed cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeed — 200 response

Successfully retrieved the video feed with specified ID.

Property	Type	Required	Constraints	Description
`displayName`	string	No		Display name of the video feed
`entityId`	string	No	read-only (server-generated)	Entity that this entity file belongs to.
`id`	string	No		ID of the video feed
`projectId`	integer	No	read-only (server-generated)	Project that this entity file belongs to.

getVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeed — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeed — 404 response

The requested videoFeed does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateVideoFeed — request

Request body for Update a video feed.

Property	Type	Required	Constraints	Description
`displayName`	string	No		Display name of the video feed.

updateVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateVideoFeed — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateVideoFeed — 404 response

The requested videoFeed does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeedFile — 200 response

Successfully retrieved the video feed file.

Property	Type	Required	Description
`begin`	string	No	The capture start timestamp. Format conforms to RFC3339.
`end`	string	No	The capture end timestamp. Present for video clips, omitted for images. Format conforms to RFC3339.
`entityClass`	string	No	The entity class of the owning entity.
`entityId`	string	No	The entity that owns this file.
`fileId`	string	No	The unique identifier of the file.
`fileName`	string	No	The name of the file.
`homeId`	integer	No	The home that owns this file.
`projectId`	integer	No	The project that owns this file.
`status`	string	No	The status of the file (e.g. requested, uploaded, external).
`storageType`	string	No	The storage backend for the file (e.g. binstore, external).
`type`	string	No	The MIME type of the file (e.g. image/jpeg, video/mp4).
`url`	string	No	A presigned URL for downloading the file.
`videoFeedId`	string	No	The video feed this file belongs to.

getVideoFeedFile — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeedFile — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeedFile — 404 response

The requested file does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeedFile — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeedFile — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVideoFeedFile — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLiveStreamDataVideoFeed — 200 response

Successfully retrieved the video feed with specified ID.

Property	Type	Required	Constraints	Description
`thumbnailUrl`	string	No	read-only (server-generated)	Returns a URL to a thumbnail image of the live stream. This URL can be used to display a preview of the live stream.
`url`	string	Yes	read-only (server-generated)	Returns a stream URL compatible with the HLS protocol. This URL can be used to play the live stream in a HLS video player.

getLiveStreamDataVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLiveStreamDataVideoFeed — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLiveStreamDataVideoFeed — 404 response

The requested live does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLiveStreamDataVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLiveStreamDataVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getLiveStreamDataVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

openWebRTCSignalingSessionVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

openWebRTCSignalingSessionVideoFeed — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

openWebRTCSignalingSessionVideoFeed — 404 response

The requested signaling does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

openWebRTCSignalingSessionVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

openWebRTCSignalingSessionVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

openWebRTCSignalingSessionVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVODStreamVideoFeed — 200 response

Successfully retrieved the video feed with specified ID.

Property	Type	Required	Constraints	Description
`url`	string	Yes	read-only (server-generated)	Returns a stream URL compatible with the HLS protocol. This URL can be used to play the VOD stream in a HLS video player.

getVODStreamVideoFeed — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVODStreamVideoFeed — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVODStreamVideoFeed — 404 response

The requested vod does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVODStreamVideoFeed — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVODStreamVideoFeed — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getVODStreamVideoFeed — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflows — 200 response

Successfully retrieved the workflows.

Represents an automation workflow definition attached to an entity instance.

An array of objects with the following shape:

Property Type Required Constraints Description

createdAt string No The time the workflow was created (ISO 8601).

description string No An optional description of the workflow.

enabled boolean No Whether the workflow is active and eligible to be triggered.

entityId string No The unique identifier for the entity the workflow belongs to.

id string No The unique identifier for the workflow (MongoDB ObjectID hex string, auto-generated).

name string No The display name of the workflow.

projectId integer No The unique identifier for the project the workflow belongs to.

revision integer No Monotonically increasing revision number, updated on every write.

steps array<object> No Ordered list of steps to execute when the workflow runs.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Used by branching nodes (e.g. condition nodes) to define which steps to run for each outcome. Maximum nesting depth is 1.
`id`	string	No	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node. Supports template expressions referencing previous step outputs.
`node`	string	No	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No List of triggers that can start this workflow.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	No		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string No Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string No one of: cron The trigger type. Currently only 'cron' is supported.

updatedAt string No The time the workflow was last updated (ISO 8601).

getEntityWorkflows — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflows — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflows — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflows — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflows — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityWorkflow — request

Request body for Create an entity workflow.

Property Type Required Constraints Description

description string No default: "" An optional description of the workflow.

enabled boolean No default: false Whether the workflow should be active immediately after creation.

name string Yes The display name of the workflow.

steps array<object> No Ordered list of steps to execute when the workflow runs.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Maximum nesting depth is 1.
`id`	string	Yes	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node.
`node`	string	Yes	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No List of triggers that can start this workflow.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	Yes		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string Yes Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string Yes one of: cron The trigger type. Currently only 'cron' is supported.

createEntityWorkflow — 201 response

Workflow successfully created.

Property Type Required Constraints Description

createdAt string No The time the workflow was created (ISO 8601).

description string No An optional description of the workflow.

enabled boolean No Whether the workflow is active and eligible to be triggered.

entityId string No The unique identifier for the entity the workflow belongs to.

id string No The unique identifier for the workflow (MongoDB ObjectID hex string, auto-generated).

name string No The display name of the workflow.

projectId integer No The unique identifier for the project the workflow belongs to.

revision integer No Monotonically increasing revision number, updated on every write.

steps array<object> No Ordered list of steps to execute when the workflow runs.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Used by branching nodes (e.g. condition nodes) to define which steps to run for each outcome. Maximum nesting depth is 1.
`id`	string	No	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node. Supports template expressions referencing previous step outputs.
`node`	string	No	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No List of triggers that can start this workflow.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	No		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string No Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string No one of: cron The trigger type. Currently only 'cron' is supported.

updatedAt string No The time the workflow was last updated (ISO 8601).

createEntityWorkflow — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityWorkflow — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityWorkflow — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityWorkflow — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createEntityWorkflow — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityWorkflow — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityWorkflow — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityWorkflow — 409 response

The workflow cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityWorkflow — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityWorkflow — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteEntityWorkflow — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflow — 200 response

Successfully retrieved the workflow.

Property Type Required Constraints Description

createdAt string No The time the workflow was created (ISO 8601).

description string No An optional description of the workflow.

enabled boolean No Whether the workflow is active and eligible to be triggered.

entityId string No The unique identifier for the entity the workflow belongs to.

id string No The unique identifier for the workflow (MongoDB ObjectID hex string, auto-generated).

name string No The display name of the workflow.

projectId integer No The unique identifier for the project the workflow belongs to.

revision integer No Monotonically increasing revision number, updated on every write.

steps array<object> No Ordered list of steps to execute when the workflow runs.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Used by branching nodes (e.g. condition nodes) to define which steps to run for each outcome. Maximum nesting depth is 1.
`id`	string	No	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node. Supports template expressions referencing previous step outputs.
`node`	string	No	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No List of triggers that can start this workflow.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	No		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string No Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string No one of: cron The trigger type. Currently only 'cron' is supported.

updatedAt string No The time the workflow was last updated (ISO 8601).

getEntityWorkflow — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflow — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflow — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflow — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflow — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityWorkflow — request

Request body for Update an entity workflow.

Property Type Required Constraints Description

description string No New description for the workflow.

enabled boolean No Whether the workflow should be active.

name string No New display name for the workflow.

steps array<object> No Replacement list of steps. Replaces all existing steps when provided.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Maximum nesting depth is 1.
`id`	string	Yes	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node.
`node`	string	Yes	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No Replacement list of triggers. Replaces all existing triggers when provided.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	Yes		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string Yes Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string Yes one of: cron The trigger type. Currently only 'cron' is supported.

updateEntityWorkflow — 200 response

Successfully updated the workflow. Returns the updated workflow object.

Property Type Required Constraints Description

createdAt string No The time the workflow was created (ISO 8601).

description string No An optional description of the workflow.

enabled boolean No Whether the workflow is active and eligible to be triggered.

entityId string No The unique identifier for the entity the workflow belongs to.

id string No The unique identifier for the workflow (MongoDB ObjectID hex string, auto-generated).

name string No The display name of the workflow.

projectId integer No The unique identifier for the project the workflow belongs to.

revision integer No Monotonically increasing revision number, updated on every write.

steps array<object> No Ordered list of steps to execute when the workflow runs.

Properties of steps
Property	Type	Required	Description
`branches`	object	No	Named branches of sub-steps, keyed by branch ID. Used by branching nodes (e.g. condition nodes) to define which steps to run for each outcome. Maximum nesting depth is 1.
`id`	string	No	Unique identifier for the step within this workflow.
`inputs`	object	No	Input values passed to the node. Supports template expressions referencing previous step outputs.
`node`	string	No	The node type to execute for this step. Must be a registered node ID (see GET /workflow/nodes).

triggers array<object> No List of triggers that can start this workflow.

Property Type Required Constraints Description

cron object No Cron trigger configuration. Required when type is 'cron'.

Properties of cron
Property	Type	Required	Constraints	Description
`schedule`	string	No		A standard 5-field cron expression (e.g. '0 9 * * 1-5').
`timeZone`	string	No		IANA timezone name for the cron schedule (e.g. 'America/Los_Angeles'). Defaults to UTC when omitted.

id string No Unique identifier for the trigger within this workflow (alphanumeric, hyphens, or underscores; minimum 3 characters; normalized to lowercase).

type string No one of: cron The trigger type. Currently only 'cron' is supported.

updatedAt string No The time the workflow was last updated (ISO 8601).

updateEntityWorkflow — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityWorkflow — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityWorkflow — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateEntityWorkflow — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRuns — 200 response

Successfully retrieved the workflow runs.

Represents a single execution record of a workflow, without its step execution records. Returned by the run list endpoint; fetch a single run for its steps.

An array of objects with the following shape:

Property Type Required Constraints Description

createdAt string No The time the run was created (ISO 8601).

entityId string No The unique identifier for the entity the workflow belongs to.

error object No Error information set when the run fails. Absent on non-failed runs.

Properties of error
Property	Type	Required	Constraints	Description
`code`	string	No	one of: user, internal, expired	Machine-readable error code. 'user': a failure the user can fix (see 'message'). 'internal': an unexpected failure the user cannot fix. 'expired': the run was not picked up before the timeout.
`message`	string	No		Human-readable, user-facing description of the failure and how to address it. Present for 'user' errors. Safe to display; contains no internal implementation detail.

finishedAt string No The time the run completed (ISO 8601). Absent while the run is queued or running.

id string No The unique identifier for the workflow run.

projectId integer No The unique identifier for the project the run belongs to.

state string No one of: queued, running, succeeded, failed The current lifecycle state of the run.

updatedAt string No The time the run was last updated (ISO 8601).

workflowId string No The unique identifier for the workflow that was executed.

getEntityWorkflowRuns — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRuns — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRuns — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRuns — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRuns — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createRun — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createRun — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createRun — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createRun — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

createRun — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 404 response

The required run does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 409 response

The run cannot be deleted because it is being used by another part of the system.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

deleteRun — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRun — 200 response

Successfully retrieved the workflow run.

Property Type Required Constraints Description

createdAt string No The time the run was created (ISO 8601).

entityId string No The unique identifier for the entity the workflow belongs to.

error object No Error information set when the run fails. Absent on non-failed runs.

Properties of error
Property	Type	Required	Constraints	Description
`code`	string	No	one of: user, internal, expired	Machine-readable error code. 'user': a failure the user can fix (see 'message'). 'internal': an unexpected failure the user cannot fix. 'expired': the run was not picked up before the timeout.
`message`	string	No		Human-readable, user-facing description of the failure and how to address it. Present for 'user' errors. Safe to display; contains no internal implementation detail.

finishedAt string No The time the run completed (ISO 8601). Absent while the run is queued or running.

id string No The unique identifier for the workflow run.

projectId integer No The unique identifier for the project the run belongs to.

state string No one of: queued, running, succeeded, failed The current lifecycle state of the run.

steps array<object> No The step execution records for this run, in the order the steps were started. Empty on runs that have not executed any step yet.

Properties of steps
Property	Type	Required	Constraints	Description
`branchId`	string	No		The ID of the parent step's branch this step belongs to. Absent for top-level steps.
`finishedAt`	string	No		The time the step completed (ISO 8601). Absent while the step is running.
`id`	string	No		The identifier of the workflow step that was executed.
`inputs`	object	No		The resolved input values the step ran with.
`node`	string	No		The node type the step executed.
`outputs`	object	No		The output values the step produced. Absent unless the step succeeded with output.
`parentId`	string	No		The ID of the step this step branched from. Absent for top-level steps.
`startedAt`	string	No		The time the step started (ISO 8601).
`state`	string	No	one of: running, succeeded, failed, cancelled	The state of the step execution.

trigger object No Contextual information about what triggered this run (e.g. cron schedule, manual).

updatedAt string No The time the run was last updated (ISO 8601).

workflowId string No The unique identifier for the workflow that was executed.

getEntityWorkflowRun — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRun — 403 response

Request failed because of denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRun — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRun — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

getEntityWorkflowRun — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateRun — 401 response

Authorization is required to access this resource.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateRun — 403 response

Request failed because of invalid data or denied permission.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateRun — 404 response

The requested run does not exist or is not accessible.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateRun — 429 response

Request failed because of rate limit.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateRun — 500 response

An unexpected error has occurred.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

updateRun — 503 response

The service is temporarily unavailable.

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.