Get an entity schema by ID

GET

https://{tenant_name}.benchling.com/api/v2/entity-schemas/:schema_id

GET

/api/v2/entity-schemas/:schema_id

curl https://{tenant_name}.benchling.com/api/v2/entity-schemas/schema_id \
     -H "Authorization: Bearer <token>"

{
  "archiveRecord": {
    "reason": "Made in error"
  },
  "fieldDefinitions": [
    {
      "archiveRecord": {
        "reason": "Made in error"
      },
      "id": "tsf_HXUnClU9",
      "isMulti": true,
      "isRequired": true,
      "name": "Resistance Gene",
      "type": "dna_sequence_link"
    }
  ],
  "id": "string",
  "name": "string",
  "type": "custom_entity",
  "prefix": "string",
  "registryId": "string",
  "constraint": {
    "fieldDefinitionNames": [
      "string"
    ],
    "hasUniqueResidues": true
  },
  "containableType": "NONE",
  "containerNameTemplateParts": [
    {
      "datetimeFormat": "string",
      "fieldId": "string",
      "text": "string",
      "type": "string"
    }
  ],
  "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
  "nameTemplateParts": [
    {
      "datetimeFormat": "string",
      "fieldId": "string",
      "text": "string",
      "type": "string"
    }
  ]
}

Get an entity schema by ID

Authentication

AuthorizationBearer

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

Path parameters

schema_idstringRequired

ID of schema to get

Response

archiveRecordobject or nullOptional

fieldDefinitionslist of objectsOptional

idstringOptional

namestringOptional

typeenumOptionalRead-only

prefixstringOptional

registryIdstringOptional

constraintobject or nullOptional

containableTypeenumOptional

Allowed values:

containerNameTemplatePartslist of objects or nullOptional

modifiedAtdatetimeOptional

DateTime the Entity Schema was last modified

nameTemplatePartslist of objects or nullOptional

Errors

400

Bad Request Error

404

Not Found Error