Create a new workflow task group

POST

https://{tenant_name}.benchling.com/api/v2/workflow-task-groups

POST

/api/v2/workflow-task-groups

curl -X POST https://{tenant_name}.benchling.com/api/v2/workflow-task-groups \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "folderId": "string",
  "schemaId": "prstsch_KnR9iVum"
}'

{
  "displayId": "string",
  "id": "prs_giVNQcTL",
  "name": "string",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "createdAt": "2020-08-01T00:00:00.000Z",
  "creationOrigin": {
    "application": "string",
    "originId": "string",
    "originModalUuid": "string",
    "originType": "string"
  },
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "folder": {
    "archiveRecord": {
      "reason": "Made in error"
    },
    "id": "string",
    "name": "string",
    "parentFolderId": "string",
    "projectId": "string"
  },
  "modifiedAt": "2020-08-01T00:00:00.000Z",
  "outputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ],
  "responsibleTeam": {
    "id": "string",
    "name": "string"
  },
  "watchers": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "webURL": "string",
  "workflowTaskSchema": {
    "id": "string",
    "name": "string"
  },
  "workflowTasks": [
    {
      "displayId": "string",
      "id": "wftask_OnnsW08k"
    }
  ],
  "executionType": "DIRECT",
  "flowchartConfigVersionId": "wffccv_giVNQcAF",
  "flowchartTaskGroups": [
    {
      "displayId": "string",
      "id": "prs_giVNQcTL",
      "name": "string",
      "nodeConfigId": "wffcnc_giVNQcTL"
    }
  ],
  "nodeConfig": {
    "id": "string",
    "nodeDetails": {
      "nodeType": "ROOT",
      "id": "wfrnd_hbVNQcEM",
      "rootTaskSchema": {
        "id": "string",
        "name": "string"
      }
    },
    "nodeType": "ROOT"
  },
  "rootTaskGroup": {
    "displayId": "string",
    "id": "prs_giVNQcTL",
    "name": "string"
  },
  "workflowOutputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ]
}

Create a new workflow task group. If no name is specified, uses the workflow schema name and a unique incrementor separated by a single whitespace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

folderIdstringRequired

ID of the folder that contains the workflow task group

schemaIdstringRequired

The workflow task schema of tasks in this task group

namestringOptional

The name of the workflow task group

watcherIdslist of stringsOptional

IDs of the users watching the workflow task group

Response

displayIdstringOptional

User-friendly ID of the workflow task group

idstringOptionalRead-only

The ID of the workflow task group

namestringOptional

The name of the workflow task group

archiveRecordobject or nullOptional

createdAtstringOptional

The ISO formatted date and time that the task group was created

creationOriginobjectOptional

creatorobjectOptional

folderobjectOptional

modifiedAtstringOptional

The ISO formatted date and time that the task group was last modified

outputslist of objectsOptional

The outputs of the workflow task group

responsibleTeamobject or nullOptional

watcherslist of objectsOptional

The users watching the workflow task group

webURLstringOptionalRead-onlyformat: "uri"

URL of the workflow task group

workflowTaskSchemaobjectOptional

workflowTaskslist of objectsOptional

The input tasks to the workflow task group

executionTypeenumOptional

The method by which the workflow is executed

flowchartConfigVersionIdstringOptional

The flowchart configuration that this task group uses. This will be null if the task group does not have executionType FLOWCHART.

flowchartTaskGroupslist of objectsOptional

The task groups that are members of the flowchart that this task group is the root of. This will be null this task group is not the root task group of a flowchart (eg if the task group does not have executionType FLOWCHART).

nodeConfigobjectOptional

The node in a Flowchart that this task group is associated with. This will be null if the task group is not part of a flowchart.

rootTaskGroupobjectOptional

The task group associated with the root node of the flowchart that this task group is a part of. This will be null if the task group is not part of a flowchart.

workflowOutputslist of objectsOptional

The outputs of the workflow task group

Errors

400

Bad Request Error