API - Project Data

Project Data

Manage project data. Create new data, update and delete them.

TODO: DOC: Explain data structure

Endpoints

get/api/v3/workflow/project_data

Return a paginated list of workflow/project/data

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
project_id?: unknown
key?: unknown
value?: unknown
label?: unknown
visible?: unknown
project_id?: unknown
key?: unknown
The related resources to include in the response. Allowed resources are:
- `project`
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;
    project_id?: any;
    key?: any;
    value?: any;
    label?: any;
    visible?: any;
    project_id?: any;
    key?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `project`
  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?: integer
key?: string
value?: string
label?: string
visible?: boolean
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      key?: string;
      value?: string;
      label?: string;
      visible?: boolean;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/workflow/project_data

Create a new workflow/project/data

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
key?: string
value?: string
label?: string
visible?: boolean
relationships?:
object
project:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      key?: string;
      value?: string;
      label?: string;
      visible?: boolean;
    };
    relationships?: { project: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/workflow/project_data/:resource_id

Delete the workflow/project/data

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/workflow/project_data/:resource_id

Show a specific workflow/project/data

Input Schema

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

Typescript

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

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
key?: string
value?: string
label?: string
visible?: boolean
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      key?: string;
      value?: string;
      label?: string;
      visible?: boolean;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/workflow/project_data/:resource_id

Update a workflow/project/data

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
value?: string
label?: string
visible?: boolean

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      value?: string;
      label?: string;
      visible?: boolean;
    };
  };
};