Batch

Batch execution resource.

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)

Default value: batch

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

Classification marking identifiers returned for this batch. Change them through the marking endpoints rather than create or update requests.

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

deployment object

anyOf

• string
• null

string

state object

anyOf

• BatchState
• null

stateState (string)required

steps objectrequired

property name* Checkpoint

Step execution checkpoint.

stateState (string)required

Execution state (pending, running, completed, failed)

offsets objectrequired

Processing progress offsets

property name*integer

description object

anyOf

• string
• null

string

start_time object

anyOf

• integer
• null

integer

end_time object

anyOf

• integer
• null

integer

property name*any

Step execution checkpoint.

message object

anyOf

• string
• null

string

Batch

{
  "id": "string",
  "name": "string",
  "alias": "string",
  "category": "batch",
  "type": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "markings": [
    "string"
  ],
  "created_at": 0,
  "updated_at": 0,
  "deployment": "string",
  "state": {
    "state": "string",
    "steps": {},
    "message": "string"
  }
}