BEbenchling
customEntities

Create a custom entity

Create a custom entity

post/custom-entities

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Request body

aliasesstring[]

Aliases to add to the custom entity

authorIdsstring[]

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

customFieldsCustomFields
fieldsFields
folderIdstring

ID of the folder containing the entity. Can be left empty when registryId is present.

namestring required
schemaIdstring required
entityRegistryIdstring

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

namingStrategy'NEW_IDS' | 'IDS_FROM_NAMES' | 'DELETE_NAMES' | 'SET_FROM_NAME_PARTS' | 'REPLACE_NAMES_FROM_PARTS' | 'KEEP_NAMES' | 'REPLACE_ID_AND_NAME_FROM_PARTS'

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
registryIdstring

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

aliasesstring[]
apiURLstring uri

The canonical url of the Custom Entity in the API.

createdAtstring date-time
customFieldsCustomFields
entityRegistryIdstring nullable
fieldsFields
folderIdstring nullable
idstring
modifiedAtstring date-time
namestring
registryIdstring nullable
urlstring

The path of the web URL, omitting the tenant domain

webURLstring

Changes

No recorded changes to this operation across all 1 revision of this API.