Get a workflow task schema

GET

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

GET

/api/v2/workflow-task-schemas/:schema_id

curl https://{tenant_name}.benchling.com/api/v2/workflow-task-schemas/prstsch_KnR9iVum \
     -H "Authorization: Bearer <token>"

{
  "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"
}

Get a workflow task schema

Authentication

AuthorizationBearer

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

Path parameters

schema_idstringRequired

The workflow task schema ID

Response

archiveRecordobject or nullOptional

fieldDefinitionslist of objectsOptional

idstringOptional

namestringOptional

typestringOptional

canSetAssigneeOnTaskCreationbooleanOptional

Whether or not tasks of this schema can be created with a non-null assignee.

defaultCreationFolderIdstring or nullOptional

ID of the default folder for creating workflow task groups

defaultEntryExecutionFolderIdstring or nullOptional

ID of the default folder for workflow task execution entries

defaultResponsibleTeamobject or nullOptional

entryTemplateIdstring or nullOptional

The ID of the template of the entries tasks of this schema will be executed into.

isPropagateWatchersEnabledbooleanOptional

Whether propagation of watchers has been enabled for this task schema.

prefixstringOptional

The prefix for the displayId of tasks of this schema.

statusLifecycleobjectOptional

taskGroupPrefixstringOptional

The prefix for the displayId of task groups containing tasks of this schema

workflowOutputSchemaobject or nullOptional

defaultResponsiblePartieslist of objectsOptional

Default list of users and teams that are responsible for tasks of this schema

executionTypeenumOptional

The method by which instances of this schema are executed

flowchartConfigobjectOptional

modifiedAtdatetimeOptionalRead-only

DateTime the Oligo was last modified.

Errors

404

Not Found Error