ReactionResponse

Reaction resource returned by the API, including resource metadata, its trigger condition, and its ordered action chain.

idId (string)필수

Server-assigned unique identifier

nameName (string)필수

Resource name

alias object

Display name shown to users.

하나 이상(anyOf)

• string
• null

string

categoryCategory (string)필수

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.

기본값: []

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)필수

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

typeType (string)필수

Possible values: [user, group, public]

display_nameDisplay Name (string)필수

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 object필수

When the reaction fires

kind필수

When the reaction fires

Possible values: [function, ontology, time]

function

languageLanguage (string)필수

상수 값: python

codeCode (string)필수

Python function body executed by this action.

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

schedule object

5-field cron; the cadence that wakes the condition (1 min floor). Exactly one of schedule / rrule.

하나 이상(anyOf)

• string
• null

string

rrule object

iCal RRULE (RFC 5545), e.g. FREQ=MONTHLY;BYDAY=-1FR;BYHOUR=9 — the cadences cron cannot say (last Friday of the month, every other week). A cadence of a day or longer (FREQ DAILY or coarser, at most 24 fires a day); a finer one is a cron schedule. Evaluated in the scheduler's timezone; a DTSTART must carry one. Exactly one of schedule / rrule, same 1 min floor.

하나 이상(anyOf)

• string
• null

string

context object

Values carried as-is into the payload's context on every firing — which report to run, a threshold, a channel

property name*any

Values carried as-is into the payload's context on every firing — which report to run, a threshold, a channel

schema object

JSON Schema of the dict run returns; declared, it is what the actions' {{context.*}} references are validated against at save time and the return value at run time

하나 이상(anyOf)

• object
• null

object

ontology

schedule object

5-field cron; the cadence that wakes the condition (1 min floor). Exactly one of schedule / rrule.

하나 이상(anyOf)

• string
• null

string

rrule object

iCal RRULE (RFC 5545), e.g. FREQ=MONTHLY;BYDAY=-1FR;BYHOUR=9 — the cadences cron cannot say (last Friday of the month, every other week). A cadence of a day or longer (FREQ DAILY or coarser, at most 24 fires a day); a finer one is a cron schedule. Evaluated in the scheduler's timezone; a DTSTART must carry one. Exactly one of schedule / rrule, same 1 min floor.

하나 이상(anyOf)

• string
• null

string

context object

Values carried as-is into the payload's context on every firing — which report to run, a threshold, a channel

property name*any

Values carried as-is into the payload's context on every firing — which report to run, a threshold, a channel

target_idTarget Id (string)필수

Subject EntityType.id or RelationType.id

where object

Membership predicate written as one nested expression. Every node takes the form {operator: arguments}: and, or, and not combine nodes; the comparisons eq, ne, gt, gte, lt, lte, in, not_in, contains, starts_with, and ends_with take a column reference and either a literal, another column, or a relative time such as {"now": "-7d"}; the aggregates count, sum, min, and max are allowed as the left operand of an ordered or equality comparison; and exists traverses a relation, with absence expressed by not. Omit this field to match every subject event.

하나 이상(anyOf)

• object
• null

object

set object

A walker definition (from + ops[] — D2) whose TERMINAL type is the subject; the matching set is its materialization. A where beside it screens the materialized rows.

하나 이상(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).

ago object

The past reading {"ago": col} operands read — "7d" · "12h" · "30m". Bounded by the mirror's retention at save time.

하나 이상(anyOf)

• string
• null

string

transitionTransition (string)

Which set transition fires: entry — in the set now, not at the cursor; exit — the reverse, the payload row is the last member state; change — a member at both whose changed columns differ, the payload carries previous. Exits and changes fail closed without a cursor.

Possible values: [entry, exit, change]

기본값: entry

initialInitial (string)

What the first evaluation does when there is no cursor yet (a new reaction, or an edited condition): seed records the current members and fires nothing, fire fires every current member as an entry. fire is for transition='entry' only — exit and change have no transition to fire without a previous evaluation.

Possible values: [seed, fire]

기본값: seed

changed object

change only: the columns whose value change fires (any-of)

하나 이상(anyOf)

• string[]
• null

Array [

string

]

previous object

change only: a where over the cursor-time row — columns against literals (no hops, now, column operands or ago)

하나 이상(anyOf)

• object
• null

object

function object

Optional function-backed gate evaluated after the declarative predicate and immediately before the action chain. It applies to subject-scoped triggers only, and a false result acknowledges the event and skips the actions.

하나 이상(anyOf)

• FunctionGate
• null

languageLanguage (string)필수

상수 값: python

codeCode (string)필수

Python function body executed by this action.

params object

Bound parameters passed to the function

property name*any

Bound parameters passed to the function

time

schedule object

5-field cron; the cadence that wakes the condition (1 min floor). Exactly one of schedule / rrule.

하나 이상(anyOf)

• string
• null

string

rrule object

iCal RRULE (RFC 5545), e.g. FREQ=MONTHLY;BYDAY=-1FR;BYHOUR=9 — the cadences cron cannot say (last Friday of the month, every other week). A cadence of a day or longer (FREQ DAILY or coarser, at most 24 fires a day); a finer one is a cron schedule. Evaluated in the scheduler's timezone; a DTSTART must carry one. Exactly one of schedule / rrule, same 1 min floor.

하나 이상(anyOf)

• string
• null

string

context object

Values carried as-is into the payload's context on every firing — which report to run, a threshold, a channel

property name*any

Values carried as-is into the payload's context on every firing — which report to run, a threshold, a channel

actions object[]필수

Sequential action chain

Array [

다음 중 하나(oneOf)

• OntologyAction
• 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)필수

상수 값: ontology

editsobject[]필수

Walker write requests applied in order, in one transaction

Possible values: >= 1

]

itemItem (string)필수사용 중단

ReactionResponse

{
  "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": {
    "schedule": "string",
    "rrule": "string",
    "context": {},
    "kind": "ontology",
    "target_id": "string",
    "where": {},
    "set": {},
    "ago": "string",
    "transition": "entry",
    "initial": "seed",
    "changed": [
      "string"
    ],
    "previous": {},
    "function": {
      "language": "python",
      "code": "string",
      "params": {}
    }
  },
  "actions": [
    {
      "each": "string",
      "on_failure": {},
      "kind": "ontology",
      "edits": [
        {}
      ]
    },
    {
      "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"
    }
  ]
}