Skip to main content

ActionUpdate

Action update request — all fields optional. The shape check runs on the MERGED resource in the route (a partial patch cannot be judged alone).

name object
anyOf
string

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
description object
anyOf
string
collection_id object
anyOf
string

Possible values: non-empty

folder_id object
anyOf
string
tags object
anyOf
  • Array [
  • string
  • ]
  • parameters object
    anyOf
    object
    checks object
    anyOf
  • Array [
  • on object

    The row parameter judged

    anyOf
    string
    where objectrequired

    walker predicate

    property name*any

    walker predicate

    message object

    The sentence the refusal carries

    anyOf
    string
  • ]
  • actions object
    anyOf
  • Array [
  • oneOf
    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
    on_failure object

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

    anyOf
    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

  • ]
  • ActionUpdate
    {
    "name": "string",
    "alias": "string",
    "description": "string",
    "collection_id": "string",
    "folder_id": "string",
    "tags": [
    "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"
    }
    ]
    }