Skip to navigation
Benchling APIContainer Schema

Get ContainerSchema by ID

Get a single ContainerSchema by ID.

Authentication

AuthorizationBearer

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

Path parameters

container_schema_idstringRequired
ID of the ContainerSchema.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
createdAtstring or nullOptional
descriptionstringOptional
A description of the schema.
fieldDefinitionsstringOptionalformat: "uri"
idstringOptional
modifiedAtstring or nullOptional
DateTime the Container Schema was last modified
namestringOptional
prefixstring or nullOptional
registryobject or nullOptional
systemNamestringOptional
A unique, stable identifier for this schema used for programmatic access and integrations.
typestring or nullOptional

Errors

400
Container Schema Get Request Bad Request Error
403
Container Schema Get Request Forbidden Error
404
Container Schema Get Request Not Found Error
429
Container Schema Get Request Too Many Requests Error
500
Container Schema Get Request Internal Server Error