Update WorkflowTaskGroup

PATCH

https://{tenant_name}.benchling.com/api/v3/workflow-task-group/:workflow_task_group_id

PATCH

/api/v3/workflow-task-group/:workflow_task_group_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/workflow-task-group/workflow_task_group_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "authors": "authors",
  "childWorkflowTaskGroups": "childWorkflowTaskGroups",
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "displayId": "displayId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "requestSubmission": {
    "__typename": "__typename",
    "id": "id"
  },
  "rootWorkflowTaskGroup": {
    "__typename": "__typename",
    "id": "id"
  },
  "workflowOutputs": "workflowOutputs",
  "workflowTaskSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "workflowTasks": "workflowTasks"
}

Update WorkflowTaskGroup.

Authentication

AuthorizationBearer

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

Path parameters

workflow_task_group_idstringRequired

ID of the WorkflowTaskGroup.

Request

This endpoint expects an object.

archiveReasonstringOptional

archivedbooleanOptional

namestringOptional

The name of the workflow task group.

Response

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

authorsstring or nullOptionalformat: "uri"

childWorkflowTaskGroupsstring or nullOptionalformat: "uri"

The list of workflow task groups for which this task group is the root in a flowchart

createdAtstringOptional

creatorobject or nullOptional

displayIdstring or nullOptional

User-friendly ID of the workflow task group

folderobjectOptional

idstringOptional

The ID of the workflow task group

modifiedAtstringOptional

namestring or nullOptional

The name of the workflow task group

requestSubmissionobject or nullOptional

A request that this task group was created to fulfill.

rootWorkflowTaskGroupobject or nullOptional

The workflow task group which corresponds to the root node in a flowchart. This is only non-null for task groups that are part of a flowchart

workflowOutputsstring or nullOptionalformat: "uri"

The outputs of the workflow task group

workflowTaskSchemaobjectOptional

workflowTasksstring or nullOptionalformat: "uri"

The tasks in the workflow task group

Errors

400

Workflow Task Group Update Request Bad Request Error

403

Workflow Task Group Update Request Forbidden Error

404

Workflow Task Group Update Request Not Found Error

409

Workflow Task Group Update Request Conflict Error

429

Workflow Task Group Update Request Too Many Requests Error

500

Workflow Task Group Update Request Internal Server Error