workflowTasks

List workflow tasks

List workflow tasks

get/workflow-tasks

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Query parameters

idsstring

Comma separated list of workflow task IDs

workflowTaskGroupIdsstring

Comma separated list of workflow IDs

schemaIdstring

The ID of the workflow task schema of the workflow task

statusIdsstring

Comma separated list of workflow task status ids

assigneeIdsstring

Comma separated list of user ids or "null"

watcherIdsstring

Comma separated list of user IDs or "null"

responsibleTeamIdsstring

Comma separated list of team IDs or "null"

executionOriginIdsstring

Comma separated list of entry IDs

executionTypesstring

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

linkedItemIds.anyOfstring

Comma separated list of bioentity or storable IDs. Maximum of 100. Returns workflow tasks where the task's schema fields reference at least one of the provided items.

linkedItemIds.allOfstring

Comma separated list of bioentity or storable IDs. Returns workflow tasks where the task's schema fields reference all of the provided items.

linkedItemIds.noneOfstring

Comma separated list of bioentity or storable IDs. Returns workflow tasks where the task's schema fields do not reference any of the provided items.

schemaFieldsSchemaFieldsQueryParam

Filter based on schema field value (not display value). Restricts results to those with a field whose value matches the filter. For Integer, Float, and Date type fields, supports the >= and <= operators (but not < or >). If any schemaField filters are present, the schemaId param must also be present. Note that all operators must be separated from any values by a single space.

namestring

The name of the workflow task

nameIncludesstring

Part of the name of the workflow task

creatorIdsstring

Comma separated list of user IDs.

'null'
OR
string date

The date on which the task was scheduled to be executed. Returns tasks which are scheduled on the provided date. If "null" is provided returns tasks which are unshceduled.

scheduledOn.ltstring date

The date on which the task was scheduled to be executed. Returns tasks which are scheduled before the provided date.

scheduledOn.ltestring date

The date on which the task was scheduled to be executed. Returns tasks which are scheduled before or on the provided date.

scheduledOn.gtestring date

The date on which the task was scheduled to be executed. Returns tasks which are scheduled on or after the provided date.

scheduledOn.gtstring date

The date on which the task was scheduled to be executed. Returns tasks which are scheduled after the provided date.

modifiedAtstring

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.

nextTokenstring
pageSizeinteger
displayIdsstring

Comma-separated list of Workflow Task Display IDs.

archiveReasonstring

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

Response

OK

nextTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.