Skip to main content

KanbanWorkspaceState

workflowIdstringrequired
workflowNamestringrequired
targetstringrequired
resolvedTargetstringrequired
artifactDirstringrequired
entrystringrequired
relatedProjects object[]required
  • Array [
  • aliasstringrequired

    Possible values: Value must match regular expression ^[a-z][a-z0-9_-]{0,63}$

    projectIdstring<uuid>required
    grantToRelatedProject objectrequired

    Rules allowing the related project to access the current project's KV; not the current project's permission on the target.

    read objectrequired
    oneOf
    modestringrequired
    Constant value: none
    write objectrequired
    oneOf
    modestringrequired
    Constant value: none
  • ]
  • manifest object
    versionintegerrequired
    Constant value: 1
    params object[]required
  • Array [
  • namestringrequired
    flagstring
    shortFlagstring
    typestringrequired

    Possible values: [string, number, boolean, positional, file]

    requiredboolean
    labelstring
    descriptionstring
    defaultValuestring
    multipleboolean
    controlstring

    Shared form control hint. Date-related controls keep string values: date uses YYYY-MM-DD, time uses HH:mm:ss, datetime uses local YYYY-MM-DDTHH:mm:ss, and date-range uses inclusive YYYY-MM-DD/YYYY-MM-DD. Date controls do not support panel=quick.

    Possible values: [text, textarea, radio, select, checkboxes, date, time, datetime, date-range]

    panelstring

    Possible values: [main, auxiliary, quick]

    resolveOnInputboolean

    Whether main composer input changes trigger the selected entrypoint resolver (or the Conversation executor resolver). Defaults to false.

    options object[]
  • Array [
  • valuestringrequired
    labelstring
    descriptionstring
  • ]
  • acceptstring[]
    formatstring

    Possible values: [json]

  • ]
  • configurations object[]required
  • Array [
  • idstring<uuid>required
    namestringrequired
    values objectrequired

    Host-persisted form string value; converted to JSON native value by parameter definition when injected into the page.

    property name*string
    createdAtstring<date-time>required
    updatedAtstring<date-time>required
  • ]
  • activeConfigurationIdstring<uuid>
    KanbanWorkspaceState
    {
    "workflowId": "string",
    "workflowName": "string",
    "target": "string",
    "resolvedTarget": "string",
    "artifactDir": "string",
    "entry": "string",
    "relatedProjects": [
    {
    "alias": "string",
    "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "grantToRelatedProject": {
    "read": {
    "mode": "none"
    },
    "write": {
    "mode": "none"
    }
    }
    }
    ],
    "manifest": {
    "version": 1,
    "params": [
    {
    "name": "string",
    "flag": "string",
    "shortFlag": "string",
    "type": "string",
    "required": true,
    "label": "string",
    "description": "string",
    "defaultValue": "string",
    "multiple": true,
    "control": "text",
    "panel": "main",
    "resolveOnInput": true,
    "options": [
    {
    "value": "string",
    "label": "string",
    "description": "string"
    }
    ],
    "accept": [
    "string"
    ],
    "format": "json"
    }
    ]
    },
    "configurations": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "values": {},
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "activeConfigurationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }