Request Template

Create RequestV2Definition

Create RequestV2Definition.

post/api/v3/request-v2-definition

Request

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

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

descriptionstring nullable

Description of the request template. Must not exceed 1024 characters and must not contain a null character.

namestring required

Name of the request template. Must not be empty, must not exceed 255 characters, and must not contain a null character.

prefixstring required

Prefix for the displayId of requests created from this template.

taskSchemaIdstring required

API ID of the workflow task schema that defines the task structure and fields for this request template.

templateCollectionIdstring required

API ID of the template collection that this request template belongs to.

Response

Created

archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
descriptionstring nullable

Description of the request template.

idstring
modifiedAtstring datetime nullable
namestring
prefixstring

The prefix for the displayId of tasks of this schema.

webUrlstring nullable

Changes

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