v2
latestOpenAPI 3.1.12026-08-078549932.4 MBWorkItemRules
post/api/work-item-rules
Request body
namestring
descriptionstring nullable
kindstring
WorkItemRuleKind name (e.g. "Exam", "Wellness", "Custom").
emitTypestring
WorkItemType name; only "Reminder" is supported today.
emitReminderCategorystring nullable
emitTaskCategorystring nullable
emitTaskPrioritystring nullable
titleTemplatestring nullable
descriptionTemplatestring nullable
triggerEventTypesstring[]
e.g. ["ServicePerformed"] or ["ServiceDeclined"].
speciesIdsstring[] nullable
requiredTagIdsstring[] nullable
excludedTagIdsstring[] nullable
triggerTagIdstring nullable
locationIdstring nullable
autoSatisfyOnTriggerboolean
isActiveboolean
Response
Created
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