OntologyAction

Shared request and response schema. Request: Ontology write action accepted when configuring a reaction, including its target and field mappings. Response: Ontology write action returned for a reaction, including its target and field mappings.

on_failure object

Compensating action, run when this action raises. 1-depth only.

anyOf

• object
• null

kindrequired

Possible values: [function, notification, ontology]

function

on_failure object

Compensating action, run when this action raises. 1-depth only.

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

notification

channelChannel (string)required

Possible values: [pipeline, batch, access, system, agent, infra]

typeType (string)required

collection object

anyOf

• string
• null

string

resource object

anyOf

• string
• null

string

messageMessage (string)required

payload object

property name*any

recipients objectrequired

Notification recipient predicates. Users, groups, collection readers, and broadcast recipients are combined and deduplicated. A request with no predicates is rejected with 422; a valid predicate that resolves to no users creates zero deliveries.

usersstring[]

User identifiers that should receive the notification directly.

groupsstring[]

Group identifiers whose members should receive the notification.

collection object

Collection whose readers should receive the notification.

anyOf

• string
• null

string

broadcastBroadcast (boolean)

Whether every active user should receive the notification.

Default value: false

on_failure object

Compensating action, run when this action raises. 1-depth only.

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

notification

ontology

ontology

languageLanguage (string)required

Constant value: python

codeCode (string)required

Python function body executed by this action.

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

notification

channelChannel (string)required

Possible values: [pipeline, batch, access, system, agent, infra]

typeType (string)required

collection object

anyOf

• string
• null

string

resource object

anyOf

• string
• null

string

messageMessage (string)required

payload object

property name*any

recipients objectrequired

Notification recipient predicates. Users, groups, collection readers, and broadcast recipients are combined and deduplicated. A request with no predicates is rejected with 422; a valid predicate that resolves to no users creates zero deliveries.

usersstring[]

User identifiers that should receive the notification directly.

groupsstring[]

Group identifiers whose members should receive the notification.

collection object

Collection whose readers should receive the notification.

anyOf

• string
• null

string

broadcastBroadcast (boolean)

Whether every active user should receive the notification.

Default value: false

on_failure object

Compensating action, run when this action raises. 1-depth only.

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

on_failure object

Compensating action, run when this action raises. 1-depth only.

anyOf

• object
• null

kind

Possible values: [function, notification, ontology]

function

notification

ontology

languageLanguage (string)required

Constant value: python

codeCode (string)required

Python function body executed by this action.

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

notification

ontology

ontology

kindKind (string)required

Constant value: ontology

target_idTarget Id (string)required

EntityType.id or RelationType.id

opOp (string)required

Possible values: [upsert, delete]

values objectrequired

Row values for upsert / delete key

property name*any

Row values for upsert / delete key

OntologyAction

{
  "kind": "ontology",
  "target_id": "string",
  "op": "upsert",
  "values": {}
}