Create a custom entity

POST

https://{tenant_name}.benchling.com/api/v2/custom-entities

POST

/api/v2/custom-entities

curl -X POST https://{tenant_name}.benchling.com/api/v2/custom-entities \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "schemaId": "string"
}'

{
  "aliases": [
    "sBN000"
  ],
  "apiURL": "https://benchling.com/api/v2/custom-entities/bfi_xCUXNVyG",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "createdAt": "2017-04-18T05:54:56.247545+00:00",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {
    "Legacy ID": {
      "value": "STR100"
    }
  },
  "entityRegistryId": "sBN000",
  "fields": {},
  "folderId": "lib_R8KcsjhW",
  "id": "bfi_xCUXNVyG",
  "modifiedAt": "2017-04-18T05:55:48.685345+00:00",
  "name": "sBN000",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "src_NetYd96a",
  "schema": {
    "id": "ts_EM122lfJ",
    "name": "Strain"
  },
  "url": "string",
  "webURL": "https://benchling.com/benchling/f/R8KcsjhW-academic-registry/bfi-xCUXNVyG-sbn000/edit"
}

Create a custom entity

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

schemaIdstringRequired

aliaseslist of stringsOptional

Aliases to add to the custom entity

authorIdslist of stringsOptional

IDs of users to set as the custom entity's authors.

customFieldsmap from strings to objectsOptional

Custom fields to add to the custom entity. Every field should have its name as a key, mapping to an object with information about the value of the field.

entityRegistryIdstringOptional

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

fieldsmap from strings to objectsOptional

Schema fields to set on the custom entity. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.

folderIdstringOptional

ID of the folder that the entity is moved into

namingStrategyenumOptional

Specifies the behavior for automatically generated names when registering an entity.

NEW_IDS: Generate new registry IDs
IDS_FROM_NAMES: Generate registry IDs based on entity names
DELETE_NAMES: Generate new registry IDs and replace name with registry ID
SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias
REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template
KEEP_NAMES: Keep existing entity names as registry IDs
REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template

registryIdstringOptional

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the /registries endpoint

Required in order for entities to be created directly in the registry.

Response

Created

aliaseslist of stringsOptional

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Custom Entity in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

createdAtdatetimeOptionalRead-only

creatorobjectOptional

customFieldsmap from strings to objectsOptional

entityRegistryIdstring or nullOptional

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

idstringOptional

modifiedAtdatetimeOptionalRead-only

namestringOptional

registrationOriginobject or nullOptional

registryIdstring or nullOptional

schemaobject or nullOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-only

Errors

400

Bad Request Error

503

Service Unavailable Error