LogicalResponse

Data returned for Logical. Required fields are id, name, category, requires, outputs, input, and 1 more.

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]

requiresstring[]required

Physical types a field must have to declare this type

outputs objectrequired

Arrow schema JSON a read produces

property name*any

Arrow schema JSON a read produces

inputs object

Arrow schema JSON of the stored document when input is 'inputs'

anyOf

• object
• null

object

inputInput (string)required

What the column stores: 'outputs' = the outputs fields as one JSON document; 'inputs' = the inputs fields as one JSON document, read through reader; 'raw' = the original value, read through reader

Possible values: [outputs, inputs, raw]

reader object

Script declaring read(value, options)

anyOf

• string
• null

string

options object

Settings passed to read

property name*any

Settings passed to read

itemItem (string)requireddeprecated

LogicalResponse

{
  "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",
  "requires": [
    "string"
  ],
  "outputs": {},
  "inputs": {},
  "input": "outputs",
  "reader": "string",
  "options": {}
}