BEbenchling
customEntities

Create or update a registered custom entity

Create or update a registered custom entity.

Schema field links can be populated using entity registry IDs or API IDs. In the value field of the Field resource, the object {"entityRegistryId": ENTITY_REGISTRY_ID} may be provided instead of the API ID if desired (see example value).

patch/custom-entities/{entity_registry_id}:upsert

Request

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

Path parameters

entity_registry_idstring required

Request body

archiveRecordArchiveRecordSet

Currently, we only support setting a null value for archiveRecord, which unarchives the item

fieldsFieldsWithResolution
namestring required
registryIdstring required
schemaIdstring required
aliasesstring[]

Aliases to add to the custom entity

authorIdsstring[]

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

customFieldsCustomFields
folderIdstring

ID of the folder that the entity is moved into

Response

Updated

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.