ActionCreate

Payload used to create Action. Required fields are name, collection_id, actions.

nameName (string)required

Possible values: Value must match regular expression [^\u0009-\u000d\u001c-\u0020\u0085\u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]

alias object

anyOf

• string
• null

string

collection_idCollection Id (string)required

Parent collection ID (required). An Action names collection-local types, so it has no meaningful global form.

Possible values: non-empty

folder_id object

anyOf

• string
• null

string

tags object

anyOf

• string[]
• null

Array [

string

]

description object

anyOf

• string
• null

string

parameters object

property name* object

kindrequired

Possible values: [dataset, entity, value]

dataset

requiredRequired (boolean)

False lets the call omit it — an empty many is [], an empty one is null, a value takes its schema default

Default value: true

dataset_idDataset Id (string)required

Dataset.id the rows belong to

Possible values: non-empty

cardinalityCardinality (string)

Possible values: [one, many]

Default value: one

entity

requiredRequired (boolean)

False lets the call omit it — an empty many is [], an empty one is null, a value takes its schema default

Default value: true

entity_idEntity Id (string)required

EntityType.id the rows belong to

Possible values: non-empty

cardinalityCardinality (string)

Possible values: [one, many]

Default value: one

derive object

walker derive spec — derived columns joining the row

anyOf

• object
• null

object

set object

A walker definition (from + ops[] — D2) whose TERMINAL type is entity_id; its rows are the parameter's rows and the call sends no value. Data positions may read {{context.parameters.<value parameter>}}.

anyOf

• object
• null

object

Ontology set definition: from and optional ops, without a terminal. Its shape is the definition part of the Execute Ontology Request body (POST /api/v1/ontologies/execute).

value

requiredRequired (boolean)

False lets the call omit it — an empty many is [], an empty one is null, a value takes its schema default

Default value: true

schema objectrequired

JSON Schema of the value

property name*any

JSON Schema of the value

checks object[]

Array [

on object

The row parameter judged

anyOf

• string
• null

string

where objectrequired

walker predicate

property name*any

walker predicate

message object

The sentence the refusal carries

anyOf

• string
• null

string

]

actions object[]required

Possible values: >= 1

Array [

oneOf

• OntologyAction
• DatasetAction
• FunctionAction
• NotificationAction

each object

A list path in the payload the body repeats over — context.rows for an ontology condition, context.parameters.<name> for an Action's many row parameter

anyOf

• string
• null

string

on_failure object

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

anyOf

• object
• null

object

One chain action of the same kinds, selected by kind (ontology, dataset, function, or notification). A fallback action cannot have its own on_failure.

kindKind (string)required

Constant value: ontology

editsobject[]required

Walker write requests applied in order, in one transaction

Possible values: >= 1

]

ActionCreate

{
  "name": "string",
  "alias": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "parameters": {},
  "checks": [
    {
      "on": "string",
      "where": {},
      "message": "string"
    }
  ],
  "actions": [
    {
      "each": "string",
      "on_failure": {},
      "kind": "ontology",
      "edits": [
        {}
      ]
    },
    {
      "each": "string",
      "on_failure": {},
      "kind": "dataset",
      "edits": [
        {
          "op": "upsert",
          "values": {}
        }
      ]
    },
    {
      "language": "python",
      "code": "string",
      "params": {},
      "each": "string",
      "on_failure": {},
      "kind": "function"
    },
    {
      "channel": "pipeline",
      "type": "string",
      "collection": "string",
      "resource": "string",
      "message": "string",
      "payload": {},
      "recipients": {
        "users": [
          "string"
        ],
        "groups": [
          "string"
        ],
        "collection": "string",
        "broadcast": false
      },
      "each": "string",
      "on_failure": {},
      "kind": "notification"
    }
  ]
}