Create RequestV2Definition

Beta

POST

https://{tenant_name}.benchling.com/api/v3/request-v2-definition

POST

/api/v3/request-v2-definition

curl -X POST https://{tenant_name}.benchling.com/api/v3/request-v2-definition \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "name",
  "prefix": "prefix",
  "taskSchemaId": "taskSchemaId",
  "templateCollectionId": "templateCollectionId"
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "description": "description",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "prefix": "prefix",
  "templateCollection": {
    "__typename": "__typename",
    "id": "id"
  },
  "webUrl": "webUrl",
  "workflowTaskSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Create RequestV2Definition.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

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

prefixstringRequired

Prefix for the displayId of requests created from this template.

taskSchemaIdstringRequired

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

templateCollectionIdstringRequired

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

descriptionstring or nullOptional

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

Response

Created

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

createdAtstring or nullOptional

creatorobjectOptional

descriptionstring or nullOptional

Description of the request template.

idstringOptional

modifiedAtstring or nullOptional

namestringOptional

prefixstringOptional

The prefix for the displayId of tasks of this schema.

templateCollectionobjectOptional

webUrlstring or nullOptional

workflowTaskSchemaobjectOptional

The task schema backing this configuration.

Errors

400

Request V2definition Create Request Bad Request Error

403

Request V2definition Create Request Forbidden Error

404

Request V2definition Create Request Not Found Error

409

Request V2definition Create Request Conflict Error

429

Request V2definition Create Request Too Many Requests Error

500

Request V2definition Create Request Internal Server Error

Authentication

Headers

Request

Response

Errors