List workflow task groups

GET

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

GET

/api/v2/workflow-task-groups

curl -G https://{tenant_name}.benchling.com/api/v2/workflow-task-groups \
     -H "Authorization: Bearer <token>" \
     -d archiveReason=NOT_ARCHIVED \
     --data-urlencode "modifiedAt=> 2022-03-01 AND < 2022-04-01" \
     -d nextToken=Im5ldyB0ZXN0Ig

{
  "nextToken": "Im5ldyB0ZXN0Ig==",
  "workflowTaskGroups": [
    {
      "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"
        }
      ]
    }
  ]
}

List workflow task groups

Authentication

AuthorizationBearer

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

Query parameters

idsstringOptional

Comma separated list of workflow task group IDs

schemaIdstringOptional

The workflow task schema ID of tasks in this task group

folderIdstringOptional

A folder ID

projectIdstringOptional

A project ID

mentionedInstringOptional

A comma separated list entry IDs

watcherIdsstringOptional>=1 character

Comma separated list of user IDs or "null"

executionTypesstringOptional>=1 character

Comma separated list of workflow execution types. Acceptable execution types are "DIRECT" and "ENTRY"

responsibleTeamIdsstringOptional>=1 character

Comma separated list of team IDs or "null"

statusIds.anyOfstringOptional>=1 character

Commas separated list of Status ids. Maximum of 100. Returns workflows where at least one task is of one of the provided statuses.

statusIds.noneOfstringOptional>=1 character

Commas separated list of Status ids. Returns workflows where none of the tasks are of any of the provided statuses.

statusIds.onlystringOptional>=1 character

Commas separated list of Status ids. Returns workflows where all of the tasks are of one of the provided statuses.

namestringOptional

The name of the workflow task group

nameIncludesstringOptional

Part of the name of the workflow task group

creatorIdsstringOptional

Comma separated list of user IDs.

modifiedAtstringOptional

Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.

nextTokenstringOptional

pageSizeintegerOptional0-100Defaults to 50

displayIdsstringOptional

Comma-separated list of Workflow Display IDs.

archiveReasonstringOptional

Archive reason. Restricts items to those with the specified archive reason. Use “NOT_ARCHIVED” to filter for unarchived workflow task groups. Use “ANY_ARCHIVED” to filter for archived workflow task groups regardless of reason. Use “ANY_ARCHIVED_OR_NOT_ARCHIVED” to return items for both archived and unarchived.

Response

nextTokenstringOptional

workflowTaskGroupslist of objectsOptional

Errors

400

Bad Request Error