openapi: 3.2.0 info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html title: Benchling Fieldset API version: 2.0.0 description: 'A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. Fieldsets are created and managed by tenant administrators and belong to an `Organization`. Schemas can implement an interface to inherit its `fieldDefinitions`, ensuring consistent field definitions across entity types. Unlike `StaticSchemaInterface` (which is Benchling-defined and read-only), Fieldsets can be modified by users. May include a `constraint` for uniqueness validation and a `prefix` for ID generation on implementing entities. Can be archived when no longer needed.' servers: - url: /api/v3 security: - oAuth: [] - basicApiKeyAuth: [] tags: - description: 'A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. Fieldsets are created and managed by tenant administrators and belong to an `Organization`. Schemas can implement an interface to inherit its `fieldDefinitions`, ensuring consistent field definitions across entity types. Unlike `StaticSchemaInterface` (which is Benchling-defined and read-only), Fieldsets can be modified by users. May include a `constraint` for uniqueness validation and a `prefix` for ID generation on implementing entities. Can be archived when no longer needed.' name: Fieldset x-bnch-organization: Benchling paths: /fieldset: post: description: Create Fieldset. operationId: Fieldset.Create parameters: - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFieldsetInput' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Fieldset' description: Created '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Create Fieldset tags: - Fieldset x-bnch-rate-limit-tier: 4 /fieldset/items: get: description: List Fieldset items. operationId: Fieldset.List parameters: - $ref: '#/components/parameters/archiveReason.anyOf' - $ref: '#/components/parameters/archived.anyOf' - $ref: '#/components/parameters/createdAt.gt' - $ref: '#/components/parameters/createdAt.gte' - $ref: '#/components/parameters/createdAt.lt' - $ref: '#/components/parameters/createdAt.lte' - $ref: '#/components/parameters/id.anyOf' - $ref: '#/components/parameters/modifiedAt.gt' - $ref: '#/components/parameters/modifiedAt.gte' - $ref: '#/components/parameters/modifiedAt.lt' - $ref: '#/components/parameters/modifiedAt.lte' - $ref: '#/components/parameters/name.anyOf' - $ref: '#/components/parameters/name.anyOf.caseSensitive' - $ref: '#/components/parameters/nextToken' - $ref: '#/components/parameters/omit' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/returning' - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.' in: query name: sort schema: default: modifiedAt:desc enum: - createdAt:asc - createdAt:desc - modifiedAt:asc - modifiedAt:desc type: string - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FieldsetPaginatedList' description: OK headers: {} '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: List Fieldset items tags: - Fieldset x-bnch-rate-limit-tier: 4 /fieldset/{fieldset_id}: get: description: Get a single Fieldset by ID. operationId: Fieldset.Get parameters: - description: ID of the Fieldset. in: path name: fieldset_id required: true schema: type: string - $ref: '#/components/parameters/returning' - $ref: '#/components/parameters/omit' - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Fieldset' description: OK headers: {} '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Get Fieldset by ID tags: - Fieldset x-bnch-rate-limit-tier: 5 patch: description: Update Fieldset. operationId: Fieldset.Update parameters: - description: ID of the Fieldset. in: path name: fieldset_id required: true schema: type: string - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFieldsetInput' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Fieldset' description: OK '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Update Fieldset tags: - Fieldset x-bnch-rate-limit-tier: 4 /fieldset/{fieldset_id}/field-definitions/items: get: description: List SchemaFieldDefinition items. operationId: Fieldset.fieldDefinitions.List parameters: - description: ID of the Fieldset. in: path name: fieldset_id required: true schema: type: string - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SchemaFieldDefinitionUnpaginatedList' description: OK headers: {} '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: List SchemaFieldDefinition items tags: - Fieldset x-bnch-rate-limit-tier: 4 /fieldset/{fieldset_id}:set-field-definitions: post: description: Set field definitions on the fieldset operationId: Fieldset.SetFieldDefinitions parameters: - description: ID of the Fieldset. in: path name: fieldset_id required: true schema: type: string - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FieldsetSetFieldDefinitionsInput' responses: '202': content: application/json: schema: $ref: '#/components/schemas/AsyncTaskLink' description: Task started '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Set field definitions on the fieldset tags: - Fieldset x-bnch-rate-limit-tier: 4 /fieldset:batch-create: post: description: Batch create Fieldset synchronously in one transaction. Maximum 25 items per request. operationId: Fieldset.BatchCreate parameters: - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: items: items: $ref: '#/components/schemas/CreateFieldsetInput' maxItems: 25 minItems: 1 type: array required: - items type: object responses: '201': content: application/json: schema: additionalProperties: false properties: items: items: $ref: '#/components/schemas/Fieldset' type: array required: - items type: object description: Created '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Batch create Fieldset tags: - Fieldset x-bnch-rate-limit-tier: 3 /fieldset:batch-update: patch: description: Batch update Fieldset synchronously in one transaction. Maximum 25 items per request. operationId: Fieldset.BatchUpdate parameters: - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: additionalProperties: false properties: items: items: $ref: '#/components/schemas/UpdateFieldsetInputWithPathParams' maxItems: 25 minItems: 1 type: array required: - items type: object responses: '200': content: application/json: schema: additionalProperties: false properties: items: items: $ref: '#/components/schemas/Fieldset' type: array required: - items type: object description: OK '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Batch update Fieldset tags: - Fieldset x-bnch-rate-limit-tier: 3 /fieldset:bulk-create: post: description: Bulk create Fieldset. operationId: Fieldset.BulkCreate parameters: - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkImport' responses: '202': content: application/json: schema: $ref: '#/components/schemas/AsyncTaskLink' description: Task started '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Bulk create Fieldset tags: - Fieldset x-bnch-rate-limit-tier: 2 /fieldset:bulk-update: patch: description: Bulk update Fieldset. operationId: Fieldset.BulkUpdate parameters: - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkImport' responses: '202': content: application/json: schema: $ref: '#/components/schemas/AsyncTaskLink' description: Task started '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Bulk update Fieldset tags: - Fieldset x-bnch-rate-limit-tier: 2 /tasks/fieldset/set-field-definitions/{task_id}: get: description: Poll status for Set field definitions on the fieldset. operationId: Fieldset.SetFieldDefinitions.Get parameters: - description: ID of the asynchronous task to poll. in: path name: task_id required: true schema: type: string - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string responses: '200': content: application/json: schema: properties: message: type: string result: oneOf: - $ref: '#/components/schemas/SchemaSetFieldDefinitionsOutput' - type: 'null' status: enum: - NOT_STARTED - IN_PROGRESS - COMPLETED - FAILED type: string type: object description: OK '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' summary: Poll async task status tags: - Fieldset x-bnch-rate-limit-tier: 5 components: schemas: CustomEntitySchemaRef: properties: __typename: type: string id: format: api_id type: string type: object TextNameTemplatePartConfigurationInput: additionalProperties: false properties: text: type: string required: - text type: object CreateDnaSequenceLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - DNA_SEQUENCE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateDateFieldDefinitionInput: additionalProperties: false properties: description: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - DATE type: string required: - name - systemName - isRequired - type type: object ProteinFormatChainPosition: description: 'Defines each instance of a polypeptide chain within a `ProteinFormat`, specifying the chain type and its constituent domains. Each chain position has a unique ref identifier and lists the domain positions (see `ProteinFormatDomainPosition`) that compose it in order from N-terminus to C-terminus. For example, a heavy chain position might reference domain positions [VH, CH1, Hinge, CH2, CH3].' properties: __typename: type: string domainPositions: description: A list of all the domain positions that make up the chain position, in order items: $ref: '#/components/schemas/ProteinFormatDomainPosition' type: array ref: description: 'A unique identifier for a physical component (chain or domain) in a protein format. This is used to form a HELM reference that is used in the protein''s complex polymer structure.' type: integer type: description: Type of the chain. enum: - HEAVY - LIGHT - NONE - ALPHA - BETA - JOINING type: string type: object UpdateIntegerFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isRequired: type: boolean name: type: string numericMax: type: number numericMin: type: number systemName: type: string type: enum: - INTEGER type: string unitId: type: string required: - id - name - systemName - isRequired - type type: object CreateFloatFieldDefinitionInput: additionalProperties: false properties: description: type: string displayPrecision: type: integer isRequired: type: boolean name: type: string numericMax: type: number numericMin: type: number systemName: type: string type: enum: - FLOAT type: string unitId: type: string required: - name - systemName - isRequired - type type: object CreateDnaOligoLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - DNA_OLIGO_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateEquipmentLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Equipment. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - EQUIPMENT_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object AssayRequestLinkFieldDefinition: description: A schema field definition for linking to assay requests. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateTextFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - TEXT type: string required: - id - name - systemName - isRequired - type type: object RunSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object UpdateOligoConjugateLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Oligo Conjugate. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - OLIGO_CONJUGATE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateFieldsetLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - FIELDSET_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateBooleanFieldDefinitionInput: additionalProperties: false properties: description: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - BOOLEAN type: string required: - name - systemName - isRequired - type type: object LongTextFieldDefinition: description: A long text field definition for multi-line text values with no length restrictions. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object ResultSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object CustomEntityLinkFieldDefinition: description: A schema field definition for linking to custom entities. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent custom entity. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/CustomEntitySchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateFieldsetInputWithPathParams: additionalProperties: false properties: archiveReason: description: Reason the Fieldset was archived type: string archived: description: If the Fieldset is archived type: boolean availableRegistrationNamingOptions: items: enum: - NEW_IDS - IDS_FROM_NAMES - DELETE_NAMES - SET_FROM_NAME_PARTS - REPLACE_NAMES_FROM_PARTS - KEEP_NAMES - REPLACE_ID_AND_NAME_FROM_PARTS type: string type: array constraint: oneOf: - $ref: '#/components/schemas/CreateFieldsetConstraintInput' - type: 'null' description: description: Updated description. When provided, must be at most 1000 characters. type: string displayName: type: string id: type: string itemIdPrefix: type: string itemType: description: '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.' enum: - AA_SEQUENCE - ANTIBODY - CUSTOM_ENTITY - DNA_OLIGO - DNA_SEQUENCE - ENTRY - EQUIPMENT - MIXTURE - MOLECULE - OLIGO_CONJUGATE - OLIGO_DUPLEX - RNA_OLIGO - RNA_SEQUENCE - TRIAL_SUBJECT type: string nameTemplate: description: Replaces all existing entity name template parts. Setting to null removes the name template and unlocks implementing schemas. Legacy datetimeFormat configurations are not preserved. oneOf: - $ref: '#/components/schemas/EntityNameTemplateInput' - type: 'null' systemName: type: string required: - id type: object UpdateStorableLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - STORAGE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object TranslationLinkFieldDefinition: description: A schema field definition for linking to translations (AA sequences created from RNA). properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent AA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateDateFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - DATE type: string required: - id - name - systemName - isRequired - type type: object OrganizationRef: properties: __typename: type: string id: format: api_id type: string type: object MixtureLinkFieldDefinition: description: A schema field definition for linking to mixtures. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent mixture. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/MixtureSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object TextNameTemplatePartConfiguration: description: Configuration for a literal text name template part. properties: __typename: type: string text: type: string type: object CreateRnaSequenceLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - RNA_SEQUENCE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object DropdownRef: properties: __typename: type: string id: format: api_id type: string type: object CreateCustomEntityLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent custom entity. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - CUSTOM_ENTITY_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object BaseFieldDefinition: description: 'A basic schema field definition for primitive data types. Used for fields with types like TEXT, INTEGER, FLOAT, BOOLEAN, DATE, DATETIME, JSON, and LONG_TEXT. Each field has a user-facing `name` and a `systemName` for warehouse/API access. Fields can be archived when no longer needed. For fields that link to other objects, use `SchemaLinkFieldDefinition`; for dropdown selections, use `DropdownLinkFieldDefinition`.' properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: description: Determines whether multiple values are allowed type: boolean isRequired: description: Determines whether values must be provided type: boolean name: type: string systemName: type: string type: enum: - AA_PART_LINK - AA_SEQUENCE_LINK - ASSAY_REQUEST_LINK - ASSAY_RESULT_LINK - ASSAY_RUN_LINK - BATCH_LINK - BLOB_LINK - BOOLEAN - CUSTOM_ENTITY_LINK - DATE - DATETIME - DNA_SEQUENCE_LINK - ENTITY_LINK - ENTRY_LINK - FLOAT - INTEGER - JSON - LONG_TEXT - MIXTURE_LINK - MOLECULE_LINK - BASE_MOLECULE_LINK - PART_LINK - SAMPLE_LINK - DROPDOWN - STORAGE_LINK - TEXT - TRANSCRIPTION_LINK - TRANSLATION_LINK type: string type: object UpdateCustomEntityLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent custom entity. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - CUSTOM_ENTITY_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object FieldNameTemplatePartConfiguration: description: Configuration for a schema field name template part. properties: __typename: type: string field: $ref: '#/components/schemas/SchemaFieldDefinitionRef' type: object CreateIntegerFieldDefinitionInput: additionalProperties: false properties: description: type: string isRequired: type: boolean name: type: string numericMax: type: number numericMin: type: number systemName: type: string type: enum: - INTEGER type: string unitId: type: string required: - name - systemName - isRequired - type type: object ProteinFormatDomainPosition: description: 'Defines a domain position within a1 `ProteinFormat`, specifying the domain type and identity of each physical domain in the protein format. Each domain position has a unique ref identifier used to construct HELM notation for complex polymer structures. Domain positions are grouped into ProteinFormatDomains, and each group can be uniquely identified by its label, and will be a single amino acid sequence entity in proteins of this format.' properties: __typename: type: string optional: description: Whether this domain is optional in the format. If true, entities of this format may not have this domain. type: boolean ref: description: 'A unique identifier for a physical component (chain or domain) in a protein format. This is used to form a HELM reference that is used in the protein''s complex polymer structure.' type: integer type: description: Type of the domain enum: - VL - CL - VH - VHH - CH1 - CH2 - CH3 - CH4 - J - H - L - VA - CA - VB - CB - VG - CG - VD - CD - F - ELEMENT type: string type: object DnaOligoSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object CreateFieldsetInput: additionalProperties: false properties: availableRegistrationNamingOptions: items: enum: - NEW_IDS - IDS_FROM_NAMES - DELETE_NAMES - SET_FROM_NAME_PARTS - REPLACE_NAMES_FROM_PARTS - KEEP_NAMES - REPLACE_ID_AND_NAME_FROM_PARTS type: string type: array constraint: $ref: '#/components/schemas/CreateFieldsetConstraintInput' description: description: A description of the fieldset. At most 1000 characters. type: string displayName: type: string fieldDefinitions: items: anyOf: - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput' - $ref: '#/components/schemas/CreateDateFieldDefinitionInput' - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput' - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput' - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput' - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput' - $ref: '#/components/schemas/CreateTextFieldDefinitionInput' - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput' type: array itemIdPrefix: type: string itemType: description: '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.' enum: - AA_SEQUENCE - ANTIBODY - CUSTOM_ENTITY - DNA_OLIGO - DNA_SEQUENCE - ENTRY - EQUIPMENT - MIXTURE - MOLECULE - OLIGO_CONJUGATE - OLIGO_DUPLEX - RNA_OLIGO - RNA_SEQUENCE - TRIAL_SUBJECT type: string organizationId: type: string systemName: type: string required: - displayName - organizationId - itemIdPrefix type: object OligoDuplexLinkFieldDefinition: description: A schema field definition for linking to Oligo Duplexes. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Oligo Duplex. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/OligoDuplexSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object FieldNameTemplatePartConfigurationInput: additionalProperties: false properties: fieldId: type: string required: - fieldId type: object DropdownLinkFieldDefinition: description: 'A schema field definition that links to a dropdown for value selection. The `linkDefinition` field references the `Dropdown` configuration that defines the available options. When `isMulti` is true, users can select multiple dropdown options for a single field value. The dropdown provides controlled vocabulary for consistent data entry across the organization.' properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/DropdownRef' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object EntryLinkFieldDefinition: description: A schema field definition for linking to notebook entries. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateTextFieldDefinitionInput: additionalProperties: false properties: description: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - TEXT type: string required: - name - systemName - isRequired - type type: object ProteinChainNameTemplatePartConfiguration: description: Configuration for a protein chain name template part. properties: __typename: type: string proteinChain: $ref: '#/components/schemas/ProteinFormatChain' type: object SchemaLinkFieldDefinition: description: 'A schema field definition for link types that reference other Benchling objects. Extends basic field properties with link-specific constraints.' properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: description: determines whether multiple values are allowed type: boolean isRequired: type: boolean name: type: string schemaId: description: limits links to entities of a specific schema type: - 'null' - string systemName: type: string type: description: indicates the kind of object being linked enum: - AA_PART_LINK - AA_SEQUENCE_LINK - ASSAY_REQUEST_LINK - ASSAY_RESULT_LINK - ASSAY_RUN_LINK - BATCH_LINK - BLOB_LINK - BOOLEAN - CUSTOM_ENTITY_LINK - DATE - DATETIME - DNA_SEQUENCE_LINK - ENTITY_LINK - ENTRY_LINK - FLOAT - INTEGER - JSON - LONG_TEXT - MIXTURE_LINK - MOLECULE_LINK - BASE_MOLECULE_LINK - PART_LINK - SAMPLE_LINK - DROPDOWN - STORAGE_LINK - TEXT - TRANSCRIPTION_LINK - TRANSLATION_LINK type: string type: object UpdateOligoDuplexLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Oligo Duplex. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - OLIGO_DUPLEX_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object InternalServerError: properties: detail: type: - 'null' - string - object errorId: type: string instance: type: string status: type: integer title: type: - 'null' - string type: type: string required: - type - title - detail - status - instance type: object EntityNameTemplate: description: A name template for entities. properties: __typename: type: string parts: items: $ref: '#/components/schemas/EntityNameTemplatePart' type: array shouldOrderPartsBySequence: type: boolean type: object EntityNameTemplatePart: description: A part in an entity name template. properties: __typename: type: string configuration: description: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration, ProteinChainNameTemplatePartConfiguration, ProteinDomainNameTemplatePartConfiguration oneOf: - anyOf: - $ref: '#/components/schemas/TextNameTemplatePartConfiguration' - $ref: '#/components/schemas/FieldNameTemplatePartConfiguration' - $ref: '#/components/schemas/ProteinChainNameTemplatePartConfiguration' - $ref: '#/components/schemas/ProteinDomainNameTemplatePartConfiguration' discriminator: propertyName: __typename - type: 'null' type: enum: - CHILD_ENTITY_LOT_NUMBER - COMPLEX_POLYMER_COMPONENT - CREATED_AT_DATE - CREATED_AT_YEAR - FIELD - HOISTED_FIELD - LINKED_BIOENTITY_REGISTRY_IDENTIFIER - PROJECT - PROTEIN_CHAIN - PROTEIN_DOMAIN - REGISTRY_IDENTIFIER_NUMBER - REGISTRY_IDENTIFIER_NUMBER_BASE_26 - SALT_CODES - SEPARATOR - TEXT type: string type: object RnaOligoLinkFieldDefinition: description: A schema field definition for linking to RNA Oligos. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/RnaOligoSchemaRef' description: The linked item must be of this schema. This is required because we do not allow linking to a generic RNA Oligo. modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateEntryLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - ENTRY_LINK type: string required: - name - systemName - isRequired - type - isMulti type: object AaSequenceSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object StorableLinkFieldDefinition: description: A schema field definition for linking to storable inventory items. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateRnaSequenceLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - RNA_SEQUENCE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object RnaSequenceLinkFieldDefinition: description: A schema field definition for linking to RNA sequences. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/RnaSequenceSchemaRef' description: The linked item must be of this schema. This is required because we do not allow linking to a generic RNA Sequence. modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object FloatFieldDefinition: description: A float field definition for decimal number values. Supports numeric constraints (min/max), display precision, and units. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string displayPrecision: type: - 'null' - integer id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string numericMax: type: - 'null' - number numericMin: type: - 'null' - number systemName: type: string unit: oneOf: - $ref: '#/components/schemas/UnitRef' - type: 'null' type: object CreateBlobLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - BLOB_LINK type: string required: - name - systemName - isRequired - type - isMulti type: object UpdateAssayRunLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ASSAY_RUN_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object DnaSequenceLinkFieldDefinition: description: A schema field definition for linking to DNA sequences. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/DnaSequenceSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object FieldsetRef: properties: __typename: type: string id: format: api_id type: string type: object ProteinFormatDomain: description: 'A domain in a protein format, representing the slot where an amino acid sequence can be used in an entity of this format. Domains are uniquely identified by their label in the format.' properties: __typename: type: string domainPositions: description: A list of all the domain positions of this domain in the format. items: $ref: '#/components/schemas/ProteinFormatDomainPosition' type: array label: description: A human-readable label for the domain, uniquely identifying the domain within the format. type: string optional: description: Whether this domain is optional in the format. If true, entities of this format may not have this domain. type: boolean type: description: The type of the domain (e.g., VH, VL, CH1). enum: - VL - CL - VH - VHH - CH1 - CH2 - CH3 - CH4 - J - H - L - VA - CA - VB - CB - VG - CG - VD - CD - F - ELEMENT type: string type: object FieldsetSetFieldDefinitionsInput: additionalProperties: false properties: fieldDefinitions: items: anyOf: - $ref: '#/components/schemas/CreateBooleanFieldDefinitionInput' - $ref: '#/components/schemas/CreateDateFieldDefinitionInput' - $ref: '#/components/schemas/CreateDateTimeFieldDefinitionInput' - $ref: '#/components/schemas/CreateFloatFieldDefinitionInput' - $ref: '#/components/schemas/CreateIntegerFieldDefinitionInput' - $ref: '#/components/schemas/CreateLongTextFieldDefinitionInput' - $ref: '#/components/schemas/CreateTextFieldDefinitionInput' - $ref: '#/components/schemas/CreateAaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAntibodyLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAssayRequestLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAssayResultLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAssayRunLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateBlobLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateCustomEntityLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateDnaOligoLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateDnaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateDropdownLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateAnyEntityLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateEntryLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateEquipmentLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateFieldsetLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateMixtureLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateMoleculeLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateOligoConjugateLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateOligoDuplexLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateRnaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateRnaOligoLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateStorableLinkFieldDefinitionInput' - $ref: '#/components/schemas/CreateSystemCategoryLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateBooleanFieldDefinitionInput' - $ref: '#/components/schemas/UpdateDateFieldDefinitionInput' - $ref: '#/components/schemas/UpdateDateTimeFieldDefinitionInput' - $ref: '#/components/schemas/UpdateFloatFieldDefinitionInput' - $ref: '#/components/schemas/UpdateIntegerFieldDefinitionInput' - $ref: '#/components/schemas/UpdateLongTextFieldDefinitionInput' - $ref: '#/components/schemas/UpdateTextFieldDefinitionInput' - $ref: '#/components/schemas/UpdateAaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateAntibodyLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateAssayRequestLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateAssayResultLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateAssayRunLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateBlobLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateCustomEntityLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateDnaOligoLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateDnaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateDropdownLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateAnyEntityLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateEntryLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateEquipmentLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateFieldsetLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateMixtureLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateMoleculeLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateOligoConjugateLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateOligoDuplexLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateRnaSequenceLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateRnaOligoLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateStorableLinkFieldDefinitionInput' - $ref: '#/components/schemas/UpdateSystemCategoryLinkFieldDefinitionInput' type: array required: - fieldDefinitions type: object SchemaFieldDefinitionRef: properties: __typename: type: string id: format: api_id type: string type: object CreateAntibodyLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Antibody. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ANTIBODY_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateMoleculeLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent molecule. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - MOLECULE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateEntryLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - ENTRY_LINK type: string required: - id - name - systemName - isRequired - type - isMulti type: object SystemCategoryLinkFieldDefinition: description: A schema field definition for linking to entities that implement a system category (static schema interface). properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object MoleculeLinkFieldDefinition: description: A schema field definition for linking to molecules. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent molecule. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/MoleculeSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateLongTextFieldDefinitionInput: additionalProperties: false properties: description: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - LONG_TEXT type: string required: - name - systemName - isRequired - type type: object FieldsetLinkFieldDefinition: description: A schema field definition for linking to entities that implement a fieldset (custom schema interface). properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent entity. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/FieldsetRef' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateMoleculeLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent molecule. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - MOLECULE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateAaSequenceLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent AA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - AA_SEQUENCE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object TranscriptionLinkFieldDefinition: description: A schema field definition for linking to transcriptions (RNA sequences created from DNA). properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/RnaSequenceSchemaRef' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateAnyEntityLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - ENTITY_LINK type: string required: - name - systemName - isRequired - type - isMulti type: object IntegerFieldDefinition: description: An integer field definition for whole number values. Supports numeric constraints (min/max) and units. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string numericMax: type: - 'null' - number numericMin: type: - 'null' - number systemName: type: string unit: oneOf: - $ref: '#/components/schemas/UnitRef' - type: 'null' type: object CreateOligoDuplexLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Oligo Duplex. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - OLIGO_DUPLEX_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object EntityNameTemplateInput: additionalProperties: false properties: nameTemplateParts: items: $ref: '#/components/schemas/EntityNameTemplatePartInput' type: array shouldOrderPartsBySequence: type: boolean required: - nameTemplateParts - shouldOrderPartsBySequence type: object UpdateAssayRequestLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ASSAY_REQUEST_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object RnaSequenceSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object CreateDateTimeFieldDefinitionInput: additionalProperties: false properties: description: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - DATE_TIME type: string required: - name - systemName - isRequired - type type: object FieldsetPaginatedList: additionalProperties: false properties: items: items: $ref: '#/components/schemas/Fieldset' type: array nextToken: type: string type: object JsonFieldDefinition: description: A JSON field definition for storing structured JSON data. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object Fieldset: description: 'A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. Fieldsets are created and managed by tenant administrators and belong to an `Organization`. Schemas can implement an interface to inherit its `fieldDefinitions`, ensuring consistent field definitions across entity types. Unlike `StaticSchemaInterface` (which is Benchling-defined and read-only), Fieldsets can be modified by users. May include a `constraint` for uniqueness validation and a `prefix` for ID generation on implementing entities. Can be archived when no longer needed.' properties: __typename: type: string archiveReason: description: Reason the Fieldset was archived type: - 'null' - string archived: description: If the Fieldset is archived type: boolean availableRegistrationNamingOptions: items: enum: - NEW_IDS - IDS_FROM_NAMES - DELETE_NAMES - SET_FROM_NAME_PARTS - REPLACE_NAMES_FROM_PARTS - KEEP_NAMES - REPLACE_ID_AND_NAME_FROM_PARTS type: string type: array constraint: oneOf: - $ref: '#/components/schemas/Constraint' - type: 'null' createdAt: description: DateTime the Fieldset was created format: datetime type: string description: description: The description of this Fieldset. type: string displayName: type: string fieldDefinitions: format: uri type: string id: type: string itemIdPrefix: type: - 'null' - string itemType: description: '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.' enum: - AA_SEQUENCE - ANTIBODY - CUSTOM_ENTITY - DNA_OLIGO - DNA_SEQUENCE - ENTRY - EQUIPMENT - MIXTURE - MOLECULE - OLIGO_CONJUGATE - OLIGO_DUPLEX - RNA_OLIGO - RNA_SEQUENCE - TRIAL_SUBJECT - null type: - 'null' - string modifiedAt: description: DateTime the Fieldset was last modified format: datetime type: string nameTemplate: oneOf: - $ref: '#/components/schemas/EntityNameTemplate' - type: 'null' organization: $ref: '#/components/schemas/OrganizationRef' description: Organization the Fieldset is in systemName: type: string type: object EntityNameTemplatePartInput: additionalProperties: false properties: configuration: anyOf: - $ref: '#/components/schemas/TextNameTemplatePartConfigurationInput' - $ref: '#/components/schemas/FieldNameTemplatePartConfigurationInput' - $ref: '#/components/schemas/ProteinChainNameTemplatePartConfigurationInput' - $ref: '#/components/schemas/ProteinDomainNameTemplatePartConfigurationInput' type: enum: - CHILD_ENTITY_LOT_NUMBER - COMPLEX_POLYMER_COMPONENT - CREATED_AT_DATE - CREATED_AT_YEAR - FIELD - LINKED_BIOENTITY_REGISTRY_IDENTIFIER - PROJECT - PROTEIN_CHAIN - PROTEIN_DOMAIN - REGISTRY_IDENTIFIER_NUMBER - SALT_CODES - SEPARATOR - TEXT type: string required: - type type: object DateFieldDefinition: description: A date field definition for date-only values (without time). properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object OligoDuplexSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object RnaOligoSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object UpdateAaSequenceLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent AA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - AA_SEQUENCE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object ProteinDomainNameTemplatePartConfiguration: description: Configuration for a protein domain name template part. properties: __typename: type: string proteinDomain: $ref: '#/components/schemas/ProteinFormatDomain' type: object ProteinFormatChain: description: 'A chain in a protein format, representing the slot where a polypeptide chain can be used in an entity of this format. Chains are uniquely identified by their label in the format. Chains can have multiplicity, meaning there are multiple physical instances of the same chain in a protein of this format.' properties: __typename: type: string chainPositions: description: A list of all the chain positions of this chain in the format. items: $ref: '#/components/schemas/ProteinFormatChainPosition' type: array domains: description: The domains that compose this chain. items: $ref: '#/components/schemas/ProteinFormatDomain' type: array label: description: 'A human-readable label for the chain, such as ''Heavy'' or ''Light 1''. Chains are labeled with an index only when multiple distinct chains of the same type exist. These labels are unique among distinct chains in a format.' type: string type: description: The type of the chain. enum: - HEAVY - LIGHT - NONE - ALPHA - BETA - JOINING type: string type: object Constraint: description: 'Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see `fieldDefinitionNames`) or unique domain-specific properties (see `TypeSpecificConstraint`). The hasUniqueResidues field is a legacy indicator for sequence uniqueness.' properties: __typename: type: string fieldDefinitionNames: oneOf: - items: type: string type: array - type: 'null' hasUniqueResidues: type: - 'null' - boolean type: object AnyEntityLinkFieldDefinition: description: A schema field definition for linking to any entity type. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateAssayRunLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ASSAY_RUN_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateMixtureLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent mixture. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - MIXTURE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateFloatFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string displayPrecision: type: integer id: type: string isRequired: type: boolean name: type: string numericMax: type: number numericMin: type: number systemName: type: string type: enum: - FLOAT type: string unitId: type: string required: - id - name - systemName - isRequired - type type: object DnaSequenceSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object OligoConjugateLinkFieldDefinition: description: A schema field definition for linking to Oligo Conjugates. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Oligo Conjugate. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/OligoConjugateSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object BulkImport: example: fileId: scrfile_jdf8BV24kLmN properties: fileId: description: The API ID of the scratch file (`scrfile_XXXXXXXX`) containing the items to import. The referenced file must be a scratch file whose upload has completed successfully. type: string required: - fileId type: object CreateDropdownLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string dropdownId: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - DROPDOWN type: string required: - name - systemName - isRequired - type - isMulti - dropdownId type: object UpdateBlobLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - BLOB_LINK type: string required: - id - name - systemName - isRequired - type - isMulti type: object UpdateBooleanFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - BOOLEAN type: string required: - id - name - systemName - isRequired - type type: object DnaPartLinkFieldDefinition: description: A schema field definition for linking to DNA parts. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object SchemaFieldDefinition: anyOf: - $ref: '#/components/schemas/AaPartLinkFieldDefinition' - $ref: '#/components/schemas/AaSequenceLinkFieldDefinition' - $ref: '#/components/schemas/AntibodyLinkFieldDefinition' - $ref: '#/components/schemas/AnyEntityLinkFieldDefinition' - $ref: '#/components/schemas/AssayRequestLinkFieldDefinition' - $ref: '#/components/schemas/AssayResultLinkFieldDefinition' - $ref: '#/components/schemas/AssayRunLinkFieldDefinition' - $ref: '#/components/schemas/BaseFieldDefinition' - $ref: '#/components/schemas/BlobLinkFieldDefinition' - $ref: '#/components/schemas/BooleanFieldDefinition' - $ref: '#/components/schemas/CustomEntityLinkFieldDefinition' - $ref: '#/components/schemas/DateFieldDefinition' - $ref: '#/components/schemas/DateTimeFieldDefinition' - $ref: '#/components/schemas/DnaOligoLinkFieldDefinition' - $ref: '#/components/schemas/DnaPartLinkFieldDefinition' - $ref: '#/components/schemas/DnaSequenceLinkFieldDefinition' - $ref: '#/components/schemas/DropdownLinkFieldDefinition' - $ref: '#/components/schemas/EntryLinkFieldDefinition' - $ref: '#/components/schemas/EquipmentLinkFieldDefinition' - $ref: '#/components/schemas/FieldsetLinkFieldDefinition' - $ref: '#/components/schemas/FloatFieldDefinition' - $ref: '#/components/schemas/IntegerFieldDefinition' - $ref: '#/components/schemas/JsonFieldDefinition' - $ref: '#/components/schemas/LongTextFieldDefinition' - $ref: '#/components/schemas/MixtureLinkFieldDefinition' - $ref: '#/components/schemas/MoleculeLinkFieldDefinition' - $ref: '#/components/schemas/OligoConjugateLinkFieldDefinition' - $ref: '#/components/schemas/OligoDuplexLinkFieldDefinition' - $ref: '#/components/schemas/RnaOligoLinkFieldDefinition' - $ref: '#/components/schemas/RnaSequenceLinkFieldDefinition' - $ref: '#/components/schemas/SchemaLinkFieldDefinition' - $ref: '#/components/schemas/StorableLinkFieldDefinition' - $ref: '#/components/schemas/SystemCategoryLinkFieldDefinition' - $ref: '#/components/schemas/TextFieldDefinition' - $ref: '#/components/schemas/TranscriptionLinkFieldDefinition' - $ref: '#/components/schemas/TranslationLinkFieldDefinition' discriminator: propertyName: __typename type: object BooleanFieldDefinition: description: A boolean field definition for true/false values. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object MoleculeSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object UpdateDateTimeFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - DATE_TIME type: string required: - id - name - systemName - isRequired - type type: object AssayRunLinkFieldDefinition: description: A schema field definition for linking to assay runs. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/RunSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateOligoConjugateLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Oligo Conjugate. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - OLIGO_CONJUGATE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateFieldsetLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - FIELDSET_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateAntibodyLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Antibody. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ANTIBODY_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateRnaOligoLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - RNA_OLIGO_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateAssayResultLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ASSAY_RESULT_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object GeneralError: properties: detail: type: - 'null' - string - object instance: type: string status: type: integer title: type: - 'null' - string type: type: string required: - type - title - detail - status - instance type: object ProteinDomainNameTemplatePartConfigurationInput: additionalProperties: false properties: label: type: string required: - label type: object EquipmentSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object UpdateSystemCategoryLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - SYSTEM_CATEGORY_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object TextFieldDefinition: description: A text field definition for short, single-line text values. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateDropdownLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string dropdownId: type: string id: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - DROPDOWN type: string required: - id - name - systemName - isRequired - type - isMulti - dropdownId type: object EquipmentLinkFieldDefinition: description: A schema field definition for linking to Equipment. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Equipment. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/EquipmentSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateAssayRequestLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ASSAY_REQUEST_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object AssayResultLinkFieldDefinition: description: A schema field definition for linking to assay results. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/ResultSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object DateTimeFieldDefinition: description: A datetime field definition for date and time values with timezone support. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object CreateSystemCategoryLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - SYSTEM_CATEGORY_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateDnaSequenceLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - DNA_SEQUENCE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object SchemaSetFieldDefinitionsOutput: description: Return shape for the set_field_definitions API on schemas. properties: fieldDefinitions: items: $ref: '#/components/schemas/SchemaFieldDefinitionRef' type: array schemaId: type: string type: object UpdateDnaOligoLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - DNA_OLIGO_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object UpdateAnyEntityLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean name: type: string systemName: type: string type: enum: - ENTITY_LINK type: string required: - id - name - systemName - isRequired - type - isMulti type: object OligoConjugateSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object CreateFieldsetConstraintInput: additionalProperties: false properties: fieldDefinitionNames: items: type: string type: array hasUniqueCanonicalSmiles: type: boolean uniqueResidues: enum: - EXACT_MATCH - IGNORE_CASE type: string type: object UpdateAssayResultLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - ASSAY_RESULT_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object AaPartLinkFieldDefinition: description: A schema field definition for linking to AA parts. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent AA part. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object AntibodyLinkFieldDefinition: description: A schema field definition for linking to Antibodies. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Antibody. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object AsyncTaskLink: properties: pollingUri: format: uri type: string taskId: type: string type: object BlobLinkFieldDefinition: description: A schema field definition for linking to blobs (file attachments). properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateRnaOligoLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: string name: type: string systemName: type: string type: enum: - RNA_OLIGO_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateEquipmentLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent Equipment. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - EQUIPMENT_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object CreateStorableLinkFieldDefinitionInput: additionalProperties: false properties: description: type: string isMulti: type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - STORAGE_LINK type: string required: - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object DnaOligoLinkFieldDefinition: description: A schema field definition for linking to DNA Oligos. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/DnaOligoSchemaRef' description: The linked item must be of this schema. This is required because we do not allow linking to a generic DNA Oligo. modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object UpdateLongTextFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isRequired: type: boolean name: type: string systemName: type: string type: enum: - LONG_TEXT type: string required: - id - name - systemName - isRequired - type type: object SchemaFieldDefinitionUnpaginatedList: additionalProperties: false properties: items: items: $ref: '#/components/schemas/SchemaFieldDefinition' type: array type: object ProteinChainNameTemplatePartConfigurationInput: additionalProperties: false properties: label: type: string required: - label type: object UpdateMixtureLinkFieldDefinitionInput: additionalProperties: false properties: archiveReason: type: string archived: type: boolean description: type: string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent mixture. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinitionId: type: - 'null' - string name: type: string systemName: type: string type: enum: - MIXTURE_LINK type: string required: - id - name - systemName - isRequired - type - isMulti - linkDefinitionId type: object MixtureSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object UpdateFieldsetInput: additionalProperties: false properties: archiveReason: description: Reason the Fieldset was archived type: string archived: description: If the Fieldset is archived type: boolean availableRegistrationNamingOptions: items: enum: - NEW_IDS - IDS_FROM_NAMES - DELETE_NAMES - SET_FROM_NAME_PARTS - REPLACE_NAMES_FROM_PARTS - KEEP_NAMES - REPLACE_ID_AND_NAME_FROM_PARTS type: string type: array constraint: oneOf: - $ref: '#/components/schemas/CreateFieldsetConstraintInput' - type: 'null' description: description: Updated description. When provided, must be at most 1000 characters. type: string displayName: type: string itemIdPrefix: type: string itemType: description: '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.' enum: - AA_SEQUENCE - ANTIBODY - CUSTOM_ENTITY - DNA_OLIGO - DNA_SEQUENCE - ENTRY - EQUIPMENT - MIXTURE - MOLECULE - OLIGO_CONJUGATE - OLIGO_DUPLEX - RNA_OLIGO - RNA_SEQUENCE - TRIAL_SUBJECT type: string nameTemplate: description: Replaces all existing entity name template parts. Setting to null removes the name template and unlocks implementing schemas. Legacy datetimeFormat configurations are not preserved. oneOf: - $ref: '#/components/schemas/EntityNameTemplateInput' - type: 'null' systemName: type: string type: object UnitRef: properties: __typename: type: string id: format: api_id type: string type: object AaSequenceLinkFieldDefinition: description: A schema field definition for linking to AA sequences. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent AA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/AaSequenceSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object parameters: modifiedAt.gt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30. in: query name: modifiedAt.gt schema: format: datetime type: string id.anyOf: description: Restricts results to those matching any of the specified IDs. Comma-separated list. explode: false in: query name: id.anyOf schema: items: type: string maxItems: 100 type: array archived.anyOf: description: If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list. explode: false in: query name: archived.anyOf schema: items: type: boolean maxItems: 2 type: array createdAt.lte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30. in: query name: createdAt.lte schema: format: datetime type: string createdAt.gte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30. in: query name: createdAt.gte schema: format: datetime type: string createdAt.gt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30. in: query name: createdAt.gt schema: format: datetime type: string createdAt.lt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30. in: query name: createdAt.lt schema: format: datetime type: string name.anyOf: description: Restricts results to those that match any of the specified names. Case insensitive. Warning - this filter can be non-performant due to case insensitivity. Ensure only one name filter is used at a time. Comma-separated list. explode: false in: query name: name.anyOf schema: items: type: string maxItems: 100 type: array name.anyOf.caseSensitive: description: Restricts results to those that match any of the specified names. Case sensitive. Ensure only one name filter is used at a time. Comma-separated list. explode: false in: query name: name.anyOf.caseSensitive schema: items: type: string maxItems: 100 type: array modifiedAt.gte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30. in: query name: modifiedAt.gte schema: format: datetime type: string omit: description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning. explode: false in: query name: omit schema: items: type: string type: array nextToken: description: Token for pagination in: query name: nextToken schema: type: string pageSize: description: Number of results to return. Defaults to 50, maximum of 100. in: query name: pageSize schema: type: integer modifiedAt.lte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30. in: query name: modifiedAt.lte schema: format: datetime type: string modifiedAt.lt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30. in: query name: modifiedAt.lt schema: format: datetime type: string archiveReason.anyOf: description: Restricts items to those with any of the specified archive reasons. Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived. Comma-separated list. explode: false in: query name: archiveReason.anyOf schema: items: type: string maxItems: 10 type: array returning: description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit. explode: false in: query name: returning schema: items: type: string type: array responses: TooManyRequests: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Too Many Requests BadRequest: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Bad Request InternalServerError: content: application/problem+json: schema: $ref: '#/components/schemas/InternalServerError' description: Internal Server Error NotFound: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Not Found Forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Forbidden securitySchemes: basicApiKeyAuth: description: Use issued API key for standard access to the API scheme: basic type: http basicClientIdSecretAuth: description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token. scheme: basic type: http oAuth: description: OAuth2 Client Credentials flow intended for service access flows: clientCredentials: scopes: {} tokenUrl: /oauth/token type: oauth2