API - Workflow Nodes

Workflow Nodes

Manage workflow nodes. Show existing nodes. Nodes are the building blocks of a workflow. They are connected to each other to form a workflow.

Nodes can (but not always) be Activities. See Activities endpoints for more information.

Endpoints

get/api/v3/workflow/workflow_nodes

Return a paginated list of workflow/nodes

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
id?: unknown
name?: unknown
origin?: unknown
input?: unknown
output?: unknown
data?: unknown
status?: unknown
route?: unknown
created_at?: unknown
run_at?: unknown
completed_at?: unknown
project_id?: unknown
work_unit_id?: unknown
project_id?: unknown
work_unit_id?: unknown
The related resources to include in the response. Allowed resources are:
- `project`
- `work_unit`
included?:
array
Elements: string
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    name?: any;
    origin?: any;
    input?: any;
    output?: any;
    data?: any;
    status?: any;
    route?: any;
    created_at?: any;
    run_at?: any;
    completed_at?: any;
    project_id?: any;
    work_unit_id?: any;
    project_id?: any;
    work_unit_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `project`
  // - `work_unit`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
id?: string
name?: string
origin?: string
input?: open struct
output?: open struct
data?: open struct
status?: string
route?: string
created_at?: datetime
run_at?: datetime
completed_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: string;
      name?: string;
      origin?: string;
      input?: Record<string, any>;
      output?: Record<string, any>;
      data?: Record<string, any>;
      status?: string;
      route?: string;
      created_at?: Date;
      run_at?: Date;
      completed_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

get/api/v3/workflow/workflow_nodes/:resource_id

Show a specific workflow/nodes

Input Schema

object
resource_id: string
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: string;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: string
name?: string
origin?: string
input?: open struct
output?: open struct
data?: open struct
status?: string
route?: string
created_at?: datetime
run_at?: datetime
completed_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: string;
      name?: string;
      origin?: string;
      input?: Record<string, any>;
      output?: Record<string, any>;
      data?: Record<string, any>;
      status?: string;
      route?: string;
      created_at?: Date;
      run_at?: Date;
      completed_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};