Create Fieldset

POST

https://{tenant_name}.benchling.com/api/v3/fieldset

POST

/api/v3/fieldset

curl -X POST https://{tenant_name}.benchling.com/api/v3/fieldset \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "displayName": "displayName",
  "itemIdPrefix": "itemIdPrefix",
  "organizationId": "organizationId"
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "availableRegistrationNamingOptions": [
    "NEW_IDS"
  ],
  "constraint": {
    "__typename": "__typename",
    "fieldDefinitionNames": [
      "fieldDefinitionNames"
    ],
    "hasUniqueResidues": true
  },
  "createdAt": "createdAt",
  "description": "description",
  "displayName": "displayName",
  "fieldDefinitions": "fieldDefinitions",
  "id": "id",
  "itemIdPrefix": "itemIdPrefix",
  "itemType": "AA_SEQUENCE",
  "modifiedAt": "modifiedAt",
  "nameTemplate": {
    "__typename": "__typename",
    "parts": [
      {}
    ],
    "shouldOrderPartsBySequence": true
  },
  "organization": {
    "__typename": "__typename",
    "id": "id"
  },
  "systemName": "systemName"
}

Create Fieldset.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

displayNamestringRequired

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

itemIdPrefixstringRequired

Prefix string prepended to generated entity IDs for implementing schemas.

organizationIdstringRequired

The API ID of the organization this fieldset belongs to.

availableRegistrationNamingOptionslist of enumsOptional

Registration naming strategies for entities on implementing schemas.

constraintobjectOptional

Uniqueness constraint for registered entities of schemas that implement this fieldset.

descriptionstringOptional

A description of the fieldset. At most 1000 characters.

fieldDefinitionslist of objectsOptional

Field definitions to create on this fieldset.

itemTypeenumOptional

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

systemNamestringOptional

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

Response

Created

__typenamestringOptional

archiveReasonstring or nullOptional

Reason the Fieldset was archived

archivedbooleanOptional

If the Fieldset is archived

availableRegistrationNamingOptionslist of enumsOptional

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

constraintobject or nullOptional

Uniqueness constraint configuration for registered entities of schemas that implement this fieldset. Ensures that a specified combination of field values is unique across those entities. Null means no constraint.

createdAtstringOptional

DateTime the Fieldset was created

descriptionstringOptional

The description of this Fieldset.

displayNamestringOptional

The user-facing name of this fieldset.

fieldDefinitionsstringOptionalformat: "uri"

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

idstringOptional

itemIdPrefixstring or nullOptional

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

itemTypeenum or nullOptional

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.

modifiedAtstringOptional

DateTime the Fieldset was last modified

nameTemplateobject or nullOptional

Entity name template that auto-generates names for entities of implementing schemas when they are registered. Used in conjunction with availableRegistrationNamingOptions. Null means no template.

organizationobjectOptional

Organization the Fieldset is in

systemNamestringOptional

The machine-readable identifier for warehouse and API access.

Errors

400

Fieldset Create Request Bad Request Error

403

Fieldset Create Request Forbidden Error

404

Fieldset Create Request Not Found Error

409

Fieldset Create Request Conflict Error

429

Fieldset Create Request Too Many Requests Error

500

Fieldset Create Request Internal Server Error