ListResponse[ActionResponse]

Paginated response containing Action Response records. The required field is items.

items object[]required

List of resource items

Array [

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

Display name shown to users.

anyOf

• string
• null

string

categoryCategory (string)required

Resource type tag

type object

Subtype within category

anyOf

• string
• null

string

collection_id object

Parent collection ID

anyOf

• string
• null

string

folder_id object

Identifier of the containing folder.

anyOf

• string
• null

string

tags object

Classification labels

anyOf

• string[]
• null

Array [

string

]

description object

Resource description

anyOf

• string
• null

string

markingsstring[]

Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

Default value: []

created_at object

Creation timestamp (Unix ms)

anyOf

• integer
• null

integer

updated_at object

Last update timestamp (Unix ms)

anyOf

• integer
• null

integer

owners object[]

Users and groups that own the resource.

Array [

idId (string)required

"user." | "group." | "public.all"

typeType (string)required

Possible values: [user, group, public]

display_nameDisplay Name (string)required

avatar_url object

anyOf

• string
• null

string

avatar_config object

anyOf

• object
• null

object

email object

anyOf

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

anyOf

• string
• null

string

Possible values: [owner, grant, admin]

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

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

]

itemItem (string)requireddeprecated

]

next_cursor object

Cursor for next page

anyOf

• string
• null

string

has_moreHas More (boolean)

Whether more pages exist

Default value: false

ListResponse[ActionResponse]

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "alias": "string",
      "category": "string",
      "type": "string",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "markings": [
        "string"
      ],
      "created_at": 0,
      "updated_at": 0,
      "owners": [
        {
          "id": "string",
          "type": "user",
          "display_name": "string",
          "avatar_url": "string",
          "avatar_config": {},
          "email": "user@example.com"
        }
      ],
      "my_share_scope": "owner",
      "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"
        }
      ]
    }
  ],
  "next_cursor": "string",
  "has_more": false
}