Ontology

Actions

The governed way to change ontology data.

An action type defines one kind of change people, apps and agents may make.

What an action type declares

• Parameters, each with a name, data type, whether it is required, and an optional default (a generated id, a fixed value, or the object's previous value).
• Rules that make the edit: create, modify, create_or_modify, delete, create_link, delete_link, or a function that computes the edits.
• Side effects: a notification (info, warning or critical), an outbound webhook, or a scheduled follow-up.
• Submission criteria: conditions that must all hold, such as the caller having a role or a parameter having a certain value.
• Postconditions: checks on the result before it is committed. If one fails, nothing is committed.
• Approval: an action can require a second person to approve it.

Applying an action

POST /api/v2/ontologies/{ontology}/actions/{action}/apply
Content-Type: application/json

{ "parameters": { "order": "ORD-1001", "status": "shipped" } }

Batch variants (applyBatch) apply many edits in one call.

Actions that need approval

When an action requires approval, applying it creates a pending request instead of changing data. A person with approval permission accepts or rejects it in Approvals, or through: