Create an entity schema

Dev

POST

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

POST

/api/v2-alpha/entity-schemas

curl -X POST https://{tenant_name}.benchling.com/api/v2-alpha/entity-schemas \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "prefix": "string",
  "registryId": "string",
  "type": "custom_entity"
}'

{
  "authParentOption": "FOLDER",
  "constraint": {
    "areUniqueResiduesCaseSensitive": true,
    "fields": [
      {
        "name": "string"
      }
    ],
    "hasUniqueCanonicalSmiles": true,
    "hasUniqueResidues": true
  },
  "containableType": "NONE",
  "fields": [
    {
      "fieldType": "dna_sequence_link",
      "isMulti": true,
      "isParentLink": true,
      "isRequired": true,
      "name": "string"
    }
  ],
  "includeRegistryIdInChips": true,
  "isContainable": true,
  "labelingStrategies": [
    "NEW_IDS"
  ],
  "mixtureSchemaConfig": {},
  "name": "string",
  "prefix": "string",
  "registryId": "string",
  "resultSchemaId": "string",
  "sequenceType": "string",
  "shouldCreateAsOligo": true,
  "shouldOrderNamePartsBySequence": true,
  "showResidues": true,
  "type": "custom_entity",
  "useOrganizationCollectionAliasForDisplayLabel": true,
  "archiveRecord": {
    "reason": "Made in error"
  },
  "id": "ts_abcdefgh",
  "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
  "nameTemplate": [
    {
      "datetimeFormat": "string",
      "fieldId": "string",
      "text": "string",
      "type": "string"
    }
  ]
}

Create an entity schema

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

prefixstringRequired

registryIdstringRequired

typeenumRequired

authParentOptionenumOptional

Allowed values:

constraintobject or nullOptional

containableTypeenumOptional

Allowed values:

fieldslist of objects or nullOptional

includeRegistryIdInChipsbooleanOptional

isContainablebooleanOptional

labelingStrategieslist of enumsOptional

mixtureSchemaConfigobject or nullOptional

resultSchemaIdstring or nullOptional

sequenceTypestring or nullOptional

shouldCreateAsOligobooleanOptional

shouldOrderNamePartsBySequencebooleanOptional

showResiduesbooleanOptional

useOrganizationCollectionAliasForDisplayLabelbooleanOptional

Response

Created

authParentOptionenumOptional

Allowed values:

constraintobject or nullOptional

containableTypeenumOptional

Allowed values:

fieldslist of objects or nullOptional

includeRegistryIdInChipsbooleanOptional

isContainablebooleanOptional

labelingStrategieslist of enumsOptional

mixtureSchemaConfigobject or nullOptional

namestringOptional

prefixstringOptional

registryIdstringOptional

resultSchemaIdstring or nullOptional

sequenceTypestring or nullOptional

shouldCreateAsOligobooleanOptional

shouldOrderNamePartsBySequencebooleanOptional

showResiduesbooleanOptional

typeenumOptional

useOrganizationCollectionAliasForDisplayLabelbooleanOptional

archiveRecordobject or nullOptional

idstringOptional

modifiedAtdatetimeOptional

DateTime the Entity Schema was last modified

nameTemplatelist of objectsOptional

Errors

400

Bad Request Error