List workflow task schemas

GET

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

GET

/api/v2/workflow-task-schemas

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

{
  "nextToken": "Im5ldyB0ZXN0Ig==",
  "workflowTaskSchemas": [
    {
      "archiveRecord": {
        "reason": "Made in error"
      },
      "fieldDefinitions": [
        {
          "archiveRecord": {
            "reason": "Made in error"
          },
          "id": "tsf_HXUnClU9",
          "isMulti": true,
          "isRequired": true,
          "name": "Resistance Gene",
          "type": "dna_sequence_link"
        }
      ],
      "id": "string",
      "name": "string",
      "type": "string",
      "canSetAssigneeOnTaskCreation": true,
      "defaultCreationFolderId": "string",
      "defaultEntryExecutionFolderId": "string",
      "defaultResponsibleTeam": {
        "id": "string",
        "name": "string"
      },
      "entryTemplateId": "tmpl_27b8fb",
      "isPropagateWatchersEnabled": true,
      "prefix": "string",
      "statusLifecycle": {
        "id": "prstswf_123kjlkj",
        "initialStatus": {
          "displayName": "Pending",
          "id": "wfts_wQzUCsW0",
          "statusType": "PENDING"
        },
        "name": "Direct Completion",
        "statuses": [
          {
            "displayName": "Pending",
            "id": "prsts_wQzUCsW0",
            "statusType": "PENDING"
          },
          {
            "displayName": "In Progress",
            "id": "prsts_fc0781",
            "statusType": "IN_PROGRESS"
          }
        ],
        "transitions": [
          {
            "from": {
              "displayName": "Pending",
              "id": "wfts_wQzUCsW0",
              "statusType": "PENDING"
            },
            "to": {
              "displayName": "Pending",
              "id": "wfts_wQzUCsW0",
              "statusType": "PENDING"
            }
          }
        ]
      },
      "taskGroupPrefix": "string",
      "workflowOutputSchema": {
        "archiveRecord": {
          "reason": "Made in error"
        },
        "fieldDefinitions": [
          {
            "archiveRecord": {
              "reason": "Made in error"
            },
            "id": "tsf_HXUnClU9",
            "isMulti": true,
            "isRequired": true,
            "name": "Resistance Gene",
            "type": "dna_sequence_link"
          }
        ],
        "id": "string",
        "name": "string",
        "type": "string",
        "prefix": "string"
      },
      "defaultResponsibleParties": [
        {
          "handle": "string",
          "id": "string",
          "name": "string"
        }
      ],
      "executionType": "DIRECT",
      "flowchartConfig": {
        "flowchartConfigVersionIds": [
          "wffccv_giVNQcAF"
        ],
        "id": "wffcc_giVNQcAF"
      },
      "modifiedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

List workflow task schemas

Authentication

AuthorizationBearer

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

Query parameters

nextTokenstringOptional

pageSizeintegerOptional0-100Defaults to 50

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.

Response

nextTokenstringOptional

workflowTaskSchemaslist of objectsOptional

Errors

404

Not Found Error