Custom Entity

Create CustomEntity

Create CustomEntity.

post/api/v3/custom-entity

Request

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

Request body

aliasesstring[]
authorIdsstring[]
customFieldsobject
entityRegistryIdstring

Registry ID to assign to the entity. If one is specified, the labeling_strategy must be unspecified.

folderIdstring required
namestring required

Name of the item.

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

Strategy to use for labeling the item in the registry. If one is specified, the entity_registry_id must be unspecified.

registryIdstring nullable

A not null value means the entity should be registered. If not null, the value must match the registry of the item's schema.

schemaFieldsobject
schemaIdstring required

Response

Created

__typenamestring
aliasesstring[] nullable
archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
entityRegistryIdstring nullable

The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered.

idstring
modifiedAtstring datetime nullable
namestring nullable

Name of the item.

authorsstring uri nullable

Changes

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