BEbenchling
Fieldset

Create Fieldset

Create Fieldset.

post/api/v3/fieldset

Request

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

Request body

availableRegistrationNamingOptionsCreateFieldsetInputAvailableRegistrationNamingOptionsItems[]

Registration naming strategies for entities on implementing schemas.

descriptionstring

A description of the fieldset. At most 1000 characters.

displayNamestring required

The user-facing name. Must be unique within the organization.

itemIdPrefixstring required

Prefix string prepended to generated entity IDs for implementing schemas.

itemType'AA_SEQUENCE' | 'ANTIBODY' | 'CUSTOM_ENTITY' | 'DNA_OLIGO' | 'DNA_SEQUENCE' | 'ENTRY' | 'EQUIPMENT' | 'MIXTURE' | 'MOLECULE' | 'OLIGO_CONJUGATE' | 'OLIGO_DUPLEX' | 'RNA_OLIGO' | 'RNA_SEQUENCE' | 'TRIAL_SUBJECT'

The entity type for implementing schemas (e.g. DNA_SEQUENCE, AA_SEQUENCE).

organizationIdstring required

The API ID of the organization this fieldset belongs to.

systemNamestring

Machine-readable identifier. If not provided, auto-generated from the display name.

Response

Created

__typenamestring
archiveReasonstring nullable

Reason the Fieldset was archived

archivedboolean

If the Fieldset is archived

availableRegistrationNamingOptionsFieldsetAvailableRegistrationNamingOptionsItems[]

The registration naming strategies available for entities of implementing schemas. Determines how entities are named when registered.

createdAtstring datetime

DateTime the Fieldset was created

descriptionstring

The description of this Fieldset.

displayNamestring

The user-facing name of this fieldset.

fieldDefinitionsstring uri

The field definitions that all schemas implementing this fieldset are required to include.

idstring
itemIdPrefixstring nullable

Prefix string prepended to generated entity IDs. Setting this on a fieldset replaces the entity ID prefix on all implementing schemas.

itemType'AA_SEQUENCE' | 'ANTIBODY' | 'CUSTOM_ENTITY' | 'DNA_OLIGO' | 'DNA_SEQUENCE' | 'ENTRY' | 'EQUIPMENT' | 'MIXTURE' | 'MOLECULE' | 'OLIGO_CONJUGATE' | 'OLIGO_DUPLEX' | 'RNA_OLIGO' | 'RNA_SEQUENCE' | 'TRIAL_SUBJECT'

The entity item type that schemas implementing this Fieldset contain (e.g. DNA_SEQUENCE, AA_SEQUENCE, MIXTURE). Null when the Fieldset declares no base bioentity type.

modifiedAtstring datetime

DateTime the Fieldset was last modified

systemNamestring

The machine-readable identifier for warehouse and API access.

Changes

No recorded changes to this operation across all 2 revisions of this API.