ListResponse[ReactionResponse]

Paginated response containing Reaction 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

URL-safe short handle

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]

condition objectrequired

When the reaction fires

kindrequired

When the reaction fires

Possible values: [function, ontology, parent, time]

function

languageLanguage (string)required

Constant value: python

codeCode (string)required

Python function body executed by this action.

scheduleSchedule (string)required

Cron expression for evaluation cadence

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

ontology

target_idTarget Id (string)required

EntityType.id or RelationType.id

opOp (string)required

Possible values: [added, modified, removed]

filter object

Optional predicate evaluated against changed row values.

anyOf

• object
• null

object

parent

parent_idParent Id (string)required

Parent Reaction id

time

scheduleSchedule (string)required

Cron expression, e.g. '0 9 * * 1'

actions object[]required

Sequential action chain

Array [

oneOf

• OntologyAction
• FunctionAction
• NotificationAction

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

]

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[ReactionResponse]

{
  "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",
      "condition": {
        "kind": "ontology",
        "target_id": "string",
        "op": "added",
        "filter": {}
      },
      "actions": [
        {
          "kind": "ontology",
          "target_id": "string",
          "op": "upsert",
          "values": {}
        },
        {
          "on_failure": {
            "kind": "ontology",
            "target_id": "string",
            "op": "upsert",
            "values": {}
          },
          "kind": "function",
          "language": "python",
          "code": "string",
          "params": {}
        },
        {
          "channel": "pipeline",
          "type": "string",
          "collection": "string",
          "resource": "string",
          "message": "string",
          "payload": {},
          "recipients": {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "collection": "string",
            "broadcast": false
          },
          "on_failure": {
            "kind": "ontology",
            "target_id": "string",
            "op": "upsert",
            "values": {}
          },
          "kind": "notification"
        }
      ]
    }
  ],
  "next_cursor": "string",
  "has_more": false
}