Create WellPlateSchema

Beta

POST

https://{tenant_name}.benchling.com/api/v3/well-plate-schema

POST

/api/v3/well-plate-schema

curl -X POST https://{tenant_name}.benchling.com/api/v3/well-plate-schema \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "containerSchemaId": "containerSchemaId",
  "description": "description",
  "height": 1,
  "organizationId": "organizationId",
  "prefix": "prefix",
  "width": 1
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "containerSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "createdAt": "createdAt",
  "description": "description",
  "fieldDefinitions": "fieldDefinitions",
  "height": 1,
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "prefix": "prefix",
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "systemName": "systemName",
  "width": 1
}

Create WellPlateSchema.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

containerSchemaIdstringRequired

The API ID of the container schema defining the well type for plates of this type.

descriptionstringRequired

A human-readable description of the schema. At most 1000 characters.

heightintegerRequired

The number of rows in the grid layout.

organizationIdstringRequired

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

prefixstringRequired

The prefix used for auto-generating barcodes for inventory items of this schema. Must be unique within the registry and cannot end in a digit.

widthintegerRequired

The number of columns in the grid layout.

fieldDefinitionslist of objectsOptional

The fields inherited by plates of this schema.

namestringOptional

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

systemNamestringOptional

The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with ‘bnch$’, and must be unique within the organization.

displayNamestringOptionalDeprecated

Deprecated. Use name instead.

Response

Created

__typenamestringOptional

archiveReasonstring or nullOptional

Why the schema was archived.

archivedbooleanOptional

Whether the schema is archived.

containerSchemaobjectOptional

The container schema used for positions in plates of this schema.

createdAtstringOptional

When the schema was created.

descriptionstringOptional

A description of the schema.

fieldDefinitionsstringOptionalformat: "uri"

The fields inherited by plates of this schema.

heightintegerOptional

The number of rows in plates of this schema.

idstringOptional

The ID of the schema.

modifiedAtstringOptional

When the schema was last modified.

namestringOptional

The name of the schema.

prefixstringOptional

The prefix of barcodes autogenerated for plates of this schema.

registryobjectOptional

The schema's registry.

systemNamestringOptional

A unique, stable identifier for this schema used for programmatic access and integrations.

widthintegerOptional

The number of columns in plates of this schema.

Errors

400

Well Plate Schema Create Request Bad Request Error

403

Well Plate Schema Create Request Forbidden Error

404

Well Plate Schema Create Request Not Found Error

409

Well Plate Schema Create Request Conflict Error

429

Well Plate Schema Create Request Too Many Requests Error

500

Well Plate Schema Create Request Internal Server Error

Authentication

Headers

Request

Response

Errors