Get CustomEntitySchema by ID

GET

https://{tenant_name}.benchling.com/api/v3/custom-entity-schema/:custom_entity_schema_id

GET

/api/v3/custom-entity-schema/:custom_entity_schema_id

curl https://{tenant_name}.benchling.com/api/v3/custom-entity-schema/custom_entity_schema_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "availableRegistrationNamingOptions": [
    "NEW_IDS"
  ],
  "constraint": {
    "__typename": "__typename",
    "fieldDefinitionNames": [
      "fieldDefinitionNames"
    ],
    "hasUniqueResidues": true
  },
  "containableType": "NONE",
  "containerNameTemplate": {
    "__typename": "__typename",
    "parts": [
      {}
    ]
  },
  "createdAt": "createdAt",
  "description": "description",
  "fieldDefinitions": "fieldDefinitions",
  "fieldsets": "fieldsets",
  "iconId": "ANTIBODY",
  "id": "id",
  "includeRegistryIdInChips": true,
  "itemIdPrefix": "itemIdPrefix",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "nameTemplate": {
    "__typename": "__typename",
    "parts": [
      {}
    ],
    "shouldOrderPartsBySequence": true
  },
  "organization": {
    "__typename": "__typename",
    "id": "id"
  },
  "systemCategories": [
    {
      "__typename": "__typename"
    }
  ],
  "systemName": "systemName",
  "useRegistryIdForItemDisplayLabel": true,
  "validationRules": "validationRules"
}

Get a single CustomEntitySchema by ID.

Authentication

AuthorizationBearer

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

Path parameters

custom_entity_schema_idstringRequired

ID of the CustomEntitySchema.

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

__typenamestringOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

availableRegistrationNamingOptionslist of enumsOptional

constraintobject or nullOptional

Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see fieldDefinitionNames) or unique domain-specific properties (see TypeSpecificConstraint). The hasUniqueResidues field is a legacy indicator for sequence uniqueness.

containableTypeenumOptional

Allowed values:

containerNameTemplateobject or nullOptional

A name template for containers.

createdAtstring or nullOptional

descriptionstringOptional

fieldDefinitionsstringOptionalformat: "uri"

fieldsetsstringOptionalformat: "uri"

iconIdenumOptional

idstringOptional

includeRegistryIdInChipsbooleanOptional

itemIdPrefixstringOptional

modifiedAtstringOptional

namestringOptional

nameTemplateobject or nullOptional

A name template for entities.

organizationobjectOptional

systemCategorieslist of objectsOptional

systemNamestringOptional

useRegistryIdForItemDisplayLabelbooleanOptional

validationRulesstringOptionalformat: "uri"

Errors

400

Custom Entity Schema Get Request Bad Request Error

403

Custom Entity Schema Get Request Forbidden Error

404

Custom Entity Schema Get Request Not Found Error

429

Custom Entity Schema Get Request Too Many Requests Error

500

Custom Entity Schema Get Request Internal Server Error