Create a new workflow task

POST

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

POST

/api/v2/workflow-tasks

curl -X POST https://{tenant_name}.benchling.com/api/v2/workflow-tasks \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "workflowTaskGroupId": "prs_giVNQcTL"
}'

{
  "displayId": "string",
  "id": "wftask_OnnsW08k",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "assignee": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "clonedFrom": {
    "displayId": "string",
    "id": "wftask_OnnsW08k"
  },
  "createdAt": "2020-08-01T00:00:00.000Z",
  "creationOrigin": {
    "application": "string",
    "originId": "string",
    "originModalUuid": "string",
    "originType": "string"
  },
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "executionOrigin": {
    "entryId": "etr_30ad79",
    "originModalUuid": "e8805895-0654-4613-ac04-39ee7462202e",
    "type": "API"
  },
  "fields": {},
  "modifiedAt": "2020-08-01T00:00:00.000Z",
  "outputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ],
  "scheduledOn": "2020-08-01",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "status": {
    "displayName": "Pending",
    "id": "wfts_wQzUCsW0",
    "statusType": "PENDING"
  },
  "webURL": "string",
  "workflowTaskGroup": {
    "displayId": "string",
    "id": "prs_giVNQcTL",
    "name": "string"
  },
  "executionFlowchartId": "wffc_6fd512",
  "executionType": "DIRECT",
  "nextOutputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ],
  "nextTasks": [
    {
      "displayId": "string",
      "id": "wftask_OnnsW08k"
    }
  ],
  "responsibleParties": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "rootTask": {
    "displayId": "string",
    "id": "wftask_OnnsW08k"
  },
  "sourceOutputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ],
  "sourceTasks": [
    {
      "displayId": "string",
      "id": "wftask_OnnsW08k"
    }
  ],
  "workflowOutputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ]
}

Create a new workflow task

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

workflowTaskGroupIdstringRequired

The workflow ID

assigneeIdstringOptional

The id of the user assigned to the task

fieldsmap from strings to objectsOptional

scheduledOndateOptional

The date on which the task is scheduled to be executed

Response

displayIdstringOptional

User-friendly ID of the workflow task

idstringOptionalRead-only

The ID of the workflow task

archiveRecordobject or nullOptional

assigneeobject or nullOptional

clonedFromobject or nullOptional

createdAtstringOptional

The ISO formatted date and time that the task was created

creationOriginobjectOptional

creatorobjectOptional

executionOriginobject or nullOptional

The context into which a task was executed

fieldsmap from strings to objectsOptional

modifiedAtstringOptional

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

outputslist of objectsOptional

scheduledOndate or nullOptional

The date on which the task is scheduled to be executed

schemaobjectOptional

statusobjectOptional

webURLstringOptionalRead-onlyformat: "uri"

URL of the workflow task

workflowTaskGroupobjectOptional

executionFlowchartIdstringOptional

The ID of the flowchart that this task will execute. This will only be defined if the task has exectutionType FLOWCHART

executionTypeenumOptional

The method by which the task of the workflow is executed

nextOutputslist of objectsOptional

The outputs in the flowchart which are generated by this task.

nextTaskslist of objectsOptional

The downstream tasks in the flowchart which are generated by this task.

responsiblePartieslist of objectsOptional

List of users and teams that are responsible for this task

rootTaskobjectOptional

The task which is at the root of the flowchart. This will be null if the task is not part of a flowchart.

sourceOutputslist of objectsOptional

The parent outputs in the flowchart which were used to generate this task.

sourceTaskslist of objectsOptional

The parent tasks in the flowchart which were used to generate this task.

workflowOutputslist of objectsOptional

The outputs of the workflow task group

Errors

400

Bad Request Error