ZRM Docs
Domain Model

Agent Rule

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
titlestringYesTitle
contentstringYesContent
scopeenum(global, account, category, project_type)YesScope
scopeRefIdstringNoID of the associated scope ref
scopeRefLabelstringNoScope ref label
priorityintegerYesPriority
isActivebooleanYesIs active
createdByUserIdstringYesID of the associated created by user
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
titlestringYesTitle
contentstringYesContent
scopeenum(global, account, category, project_type)YesScope
scopeRefIdstringNoID of the associated scope ref
scopeRefLabelstringNoScope ref label
priorityintegerYes0Priority
isActivebooleanYestrueIs active
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
titlestringNoTitle
contentstringNoContent
scopeenum(global, account, category, project_type)NoScope
scopeRefIdstringNoID of the associated scope ref
scopeRefLabelstringNoScope ref label
priorityintegerNo0Priority
isActivebooleanNotrueIs active

On this page