v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
WorkItemRules

put/api/work-item-rules/{id}

Path parameters

idstring required

Request body

namestring nullable
descriptionstring nullable
titleTemplatestring nullable
descriptionTemplatestring nullable
speciesIdsstring[] nullable
requiredTagIdsstring[] nullable
excludedTagIdsstring[] nullable
triggerTagIdstring nullable
autoSatisfyOnTriggerboolean nullable
isActiveboolean nullable
locationIdstring nullable
emitReminderCategorystring nullable
emitTaskCategorystring nullable
emitTaskPrioritystring nullable
triggerEventTypesstring[] nullable

Replaces the rule's trigger event types when present (null = leave unchanged).

Response

OK

idstring
namestring
descriptionstring nullable
kindinteger

What domain a WorkItemRule governs. Drives which dimension columns apply and how the debugger/admin UI render the rule in clinic language.

emitTypeinteger

Which work-item table a WorkItemEventType history row refers to.

emitReminderCategoryinteger
emitTaskCategoryinteger
emitTaskPriorityinteger
titleTemplatestring nullable
descriptionTemplatestring nullable
triggerEventTypesstring[]
speciesIdsstring[] nullable
requiredTagIdsstring[] nullable
excludedTagIdsstring[] nullable
triggerTagIdstring nullable
locationIdstring nullable
autoSatisfyOnTriggerboolean
isActiveboolean
createdAtstring date-time
updatedAtstring date-time