BEbenchling
Custom Entity

Get CustomEntity by ID

Get a single CustomEntity by ID.

get/api/v3/custom-entity/{custom_entity_id}

Request

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

Path parameters

custom_entity_idstring required

ID of the CustomEntity.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__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.