openapi: 3.2.0 info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html title: Benchling Protein Schema API version: 2.0.0 description: Defines the structure, field definitions, and configuration options for Proteins. servers: - url: /api/v3 security: - oAuth: [] - basicApiKeyAuth: [] tags: - description: Defines the structure, field definitions, and configuration options for Proteins. name: ProteinSchema x-bnch-organization: Benchling paths: /protein-schema: post: description: Create ProteinSchema. operationId: ProteinSchema.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/CreateAntibodySchemaInput' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ProteinSchema' 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 ProteinSchema tags: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema/items: get: description: List ProteinSchema items. operationId: ProteinSchema.List parameters: - $ref: '#/components/parameters/nextToken' - $ref: '#/components/parameters/omit' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/returning' - 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/ProteinSchemaPaginatedList' 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 ProteinSchema items tags: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema/{protein_schema_id}: get: description: Get a single ProteinSchema by ID. operationId: ProteinSchema.Get parameters: - description: ID of the ProteinSchema. in: path name: protein_schema_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/ProteinSchema' 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 ProteinSchema by ID tags: - ProteinSchema x-bnch-rate-limit-tier: 5 patch: description: Update ProteinSchema. operationId: ProteinSchema.Update parameters: - description: ID of the ProteinSchema. in: path name: protein_schema_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/UpdateAntibodySchemaInput' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProteinSchema' 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 ProteinSchema tags: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema/{protein_schema_id}/field-definitions/items: get: description: List SchemaFieldDefinition items. operationId: ProteinSchema.fieldDefinitions.List parameters: - description: ID of the ProteinSchema. in: path name: protein_schema_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: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema/{protein_schema_id}/fieldsets/items: get: description: List Fieldset items. operationId: ProteinSchema.fieldsets.List parameters: - description: ID of the ProteinSchema. in: path name: protein_schema_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/FieldsetUnpaginatedList' 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: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema/{protein_schema_id}:apply-fieldset: post: description: Apply a fieldset to the schema operationId: ProteinSchema.ApplyFieldset parameters: - description: ID of the ProteinSchema. in: path name: protein_schema_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/EntitySchemaApplyFieldsetInput' 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: Apply a fieldset to the schema tags: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema/{protein_schema_id}:set-field-definitions: post: description: Set field definitions on the schema operationId: ProteinSchema.SetFieldDefinitions parameters: - description: ID of the ProteinSchema. in: path name: protein_schema_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/AntibodySchemaSetFieldDefinitionsInput' 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 schema tags: - ProteinSchema x-bnch-rate-limit-tier: 4 /protein-schema:batch-create: post: description: Batch create ProteinSchema synchronously in one transaction. Maximum 25 items per request. operationId: ProteinSchema.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/CreateAntibodySchemaInput' maxItems: 25 minItems: 1 type: array required: - items type: object responses: '201': content: application/json: schema: additionalProperties: false properties: items: items: $ref: '#/components/schemas/ProteinSchema' 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 ProteinSchema tags: - ProteinSchema x-bnch-rate-limit-tier: 3 /protein-schema:batch-update: patch: description: Batch update ProteinSchema synchronously in one transaction. Maximum 25 items per request. operationId: ProteinSchema.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/UpdateAntibodySchemaInputWithPathParams' maxItems: 25 minItems: 1 type: array required: - items type: object responses: '200': content: application/json: schema: additionalProperties: false properties: items: items: $ref: '#/components/schemas/ProteinSchema' 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 ProteinSchema tags: - ProteinSchema x-bnch-rate-limit-tier: 3 /protein-schema:bulk-create: post: description: Bulk create ProteinSchema. operationId: ProteinSchema.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 ProteinSchema tags: - ProteinSchema x-bnch-rate-limit-tier: 2 /protein-schema:bulk-update: patch: description: Bulk update ProteinSchema. operationId: ProteinSchema.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 ProteinSchema tags: - ProteinSchema x-bnch-rate-limit-tier: 2 /tasks/protein-schema/apply-fieldset/{task_id}: get: description: Poll status for Apply a fieldset to the schema. operationId: ProteinSchema.ApplyFieldset.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/EntitySchemaApplyFieldsetOutput' - 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: - ProteinSchema x-bnch-rate-limit-tier: 5 /tasks/protein-schema/set-field-definitions/{task_id}: get: description: Poll status for Set field definitions on the schema. operationId: ProteinSchema.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: - ProteinSchema 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 ProteinFormatRef: properties: __typename: type: string id: format: api_id type: string 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 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 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 RunSchemaRef: properties: __typename: type: string id: format: api_id 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 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 EntitySchemaBaseRef: properties: __typename: type: string id: format: api_id type: string 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 ProteinSchemaPaginatedList: additionalProperties: false properties: items: items: $ref: '#/components/schemas/ProteinSchema' type: array nextToken: type: string type: object EntitySchemaApplyFieldsetWarning: description: A warning raised when attempting to apply a fieldset to an entity schema. properties: __typename: type: string fieldId: type: string supportingInfo: type: string warningType: enum: - FIELD_TYPE_CHANGE - FIELD_IS_REQUIRED_CHANGE - FIELD_IS_MULTI_CHANGE - FIELD_PARENT_LINK_CHANGE - FIELD_SYSTEM_NAME_CHANGE - FIELD_UNIT_CHANGE - FIELD_ARCHIVE_RECORD_CHANGE - WAREHOUSE_CHANGE 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 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 ContainerNameTemplatePartInput: additionalProperties: false properties: configuration: anyOf: - $ref: '#/components/schemas/TextNameTemplatePartConfigurationInput' - $ref: '#/components/schemas/FieldNameTemplatePartConfigurationInput' type: enum: - BARCODE - BARCODE_NUMBER - CHILD_ENTITY_LOT_NUMBER - CONCENTRATION_UNITS - CONCENTRATION_VALUE - CONTAINED_ENTITY_NAME - FIELD - FILL_DATE - FILL_YEAR - LINKED_BIOENTITY_REGISTRY_IDENTIFIER - PARENT_STORABLE_BARCODE - PARENT_STORABLE_NAME - POSITION - PROJECT - QUANTITY_UNITS - QUANTITY_VALUE - REGISTRY_IDENTIFIER_NUMBER - RESTRICTION_STATUS - SAMPLE_LOT_NUMBER - SEPARATOR - TEXT type: string required: - type type: object EntitySchemaApplyFieldsetInput: additionalProperties: false properties: acknowledgeWarnings: description: If false, operation will only commit if there are no warnings in the output. If true, operation will commit even if there are warnings. type: boolean fieldsetId: description: The API ID of the fieldset to apply to the schema. The fieldset must exist and be accessible. type: string required: - fieldsetId type: object UpdateAntibodySchemaInputWithPathParams: additionalProperties: false properties: archiveReason: type: string 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 containerNameTemplate: description: Replaces all existing container name template parts. Legacy datetimeFormat configurations are not preserved. oneOf: - $ref: '#/components/schemas/ContainerNameTemplateInput' - type: 'null' description: description: Updated description. When provided, must be at most 1000 characters. type: string displayName: deprecated: true description: Deprecated. Use name instead. type: string id: description: The API ID of the schema to update. The schema must exist and be accessible. type: string includeRegistryIdInChips: type: boolean isContainable: type: boolean itemIdPrefix: type: string name: description: Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization. type: string nameTemplate: description: Replaces all existing entity name template parts. Legacy datetimeFormat configurations are not preserved. Updating the name template does not automatically modify availableRegistrationNamingOptions — update that field separately if needed. oneOf: - $ref: '#/components/schemas/EntityNameTemplateInput' - type: 'null' systemCategories: items: $ref: '#/components/schemas/SystemCategoryConfigurationInputBase' type: array systemName: description: Updated SQL identifier for the warehouse table name. When provided, must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization. type: string useRegistryIdForItemDisplayLabel: type: boolean required: - id type: object DropdownRef: properties: __typename: type: string id: format: api_id type: string 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 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 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 FieldNameTemplatePartConfiguration: description: Configuration for a schema field name template part. properties: __typename: type: string field: $ref: '#/components/schemas/SchemaFieldDefinitionRef' 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 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 FieldsetUnpaginatedList: additionalProperties: false properties: items: items: $ref: '#/components/schemas/Fieldset' type: array type: object AntibodySchemaSetFieldDefinitionsInput: 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 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 AaSubElementConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_aasubelement type: string required: - systemCategoryId type: object ContainerNameTemplatePart: description: A part in a container name template. properties: __typename: type: string configuration: description: Union of TextNameTemplatePartConfiguration, FieldNameTemplatePartConfiguration oneOf: - anyOf: - $ref: '#/components/schemas/TextNameTemplatePartConfiguration' - $ref: '#/components/schemas/FieldNameTemplatePartConfiguration' discriminator: propertyName: __typename - type: 'null' type: enum: - BARCODE - BARCODE_NUMBER - CHILD_ENTITY_LOT_NUMBER - CONCENTRATION_UNITS - CONCENTRATION_VALUE - CONTAINED_ENTITY_NAME - CONTAINER_CREATED_AT_DATE - CONTAINER_CREATED_AT_YEAR - FIELD - FILL_DATE - FILL_YEAR - HOISTED_FIELD - LINKED_BIOENTITY_REGISTRY_IDENTIFIER - PARENT_STORABLE_BARCODE - PARENT_STORABLE_NAME - POSITION - PROJECT - QUANTITY_UNITS - QUANTITY_VALUE - REGISTRY_IDENTIFIER_NUMBER - REGISTRY_IDENTIFIER_NUMBER_BASE_26 - RESTRICTION_STATUS - SAMPLE_LOT_NUMBER - SEPARATOR - TEXT type: string type: object AaChainConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_aachain type: string required: - systemCategoryId 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 UpdateAntibodySchemaInput: additionalProperties: false properties: archiveReason: type: string 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 containerNameTemplate: description: Replaces all existing container name template parts. Legacy datetimeFormat configurations are not preserved. oneOf: - $ref: '#/components/schemas/ContainerNameTemplateInput' - type: 'null' description: description: Updated description. When provided, must be at most 1000 characters. type: string displayName: deprecated: true description: Deprecated. Use name instead. type: string includeRegistryIdInChips: type: boolean isContainable: type: boolean itemIdPrefix: type: string name: description: Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization. type: string nameTemplate: description: Replaces all existing entity name template parts. Legacy datetimeFormat configurations are not preserved. Updating the name template does not automatically modify availableRegistrationNamingOptions — update that field separately if needed. oneOf: - $ref: '#/components/schemas/EntityNameTemplateInput' - type: 'null' systemCategories: items: $ref: '#/components/schemas/SystemCategoryConfigurationInputBase' type: array systemName: description: Updated SQL identifier for the warehouse table name. When provided, must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization. type: string useRegistryIdForItemDisplayLabel: type: boolean type: object ProteinChainNameTemplatePartConfiguration: description: Configuration for a protein chain name template part. properties: __typename: type: string proteinChain: $ref: '#/components/schemas/ProteinFormatChain' type: object DomainLinkedSchema: description: 'Links a specific domain type and specificity combination to an entity schema or interface. Used in protein schema configurations to specify which schema governs entities created for each domain position in the protein structure.' properties: __typename: type: string domainType: enum: - VL - CL - VH - VHH - CH1 - CH2 - CH3 - CH4 - J - H - L - VA - CA - VB - CB - VG - CG - VD - CD - F - ELEMENT type: string schemaOrInterfaceId: type: - 'null' - string specificity: type: - 'null' - string 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 SystemCategoryConfigurationInputBase: allOf: - properties: systemCategoryId: enum: - ssi_aachain - ssi_aadomain - ssi_aapair - ssi_aasubelement - ssi_antigen - ssi_dnachain - ssi_dnadomain - ssi_dnapair - ssi_dnasubelement type: string required: - systemCategoryId - oneOf: - $ref: '#/components/schemas/AaChainConfigurationInput' - $ref: '#/components/schemas/AaDomainConfigurationInput' - $ref: '#/components/schemas/AaPairConfigurationInput' - $ref: '#/components/schemas/AaSubElementConfigurationInput' - $ref: '#/components/schemas/AntigenConfigurationInput' - $ref: '#/components/schemas/DnaChainConfigurationInput' - $ref: '#/components/schemas/DnaDomainConfigurationInput' - $ref: '#/components/schemas/DnaPairConfigurationInput' - $ref: '#/components/schemas/DnaSubElementConfigurationInput' discriminator: propertyName: systemCategoryId 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 SystemCategoryConfiguration: anyOf: - $ref: '#/components/schemas/BaseSystemCategoryConfiguration' discriminator: propertyName: __typename 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 DomainLinkedSchemaInput: additionalProperties: false properties: label: description: Domain label from the protein format to map to a schema. type: string schemaOrInterfaceId: description: API ID of the schema or schema interface to use for the domain label. type: string required: - label - schemaOrInterfaceId 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 ContainerNameTemplateInput: additionalProperties: false properties: nameTemplateParts: items: $ref: '#/components/schemas/ContainerNameTemplatePartInput' type: array required: - nameTemplateParts 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 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 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 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 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 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 AntigenConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_antigen type: string required: - systemCategoryId 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 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 DnaDomainConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_dnadomain type: string required: - systemCategoryId 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 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 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 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 DnaPairConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_dnapair type: string required: - systemCategoryId 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 AaPairConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_aapair type: string required: - systemCategoryId type: object CreateAntibodySchemaInput: 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 chainLinkedSchemas: description: Schema mappings for chain labels in the protein format. items: $ref: '#/components/schemas/ChainLinkedSchemaInput' type: array description: description: A human-readable description of the schema. At most 1000 characters. type: string displayName: deprecated: true description: Deprecated. Use name instead. type: string domainLinkedSchemas: description: Schema mappings for each domain label in the protein format. items: $ref: '#/components/schemas/DomainLinkedSchemaInput' type: array fieldDefinitions: description: Optional schema field definitions to create on the antibody schema. 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 fieldsets: items: type: string type: array formatId: description: API ID of the protein format that defines the antibody schema structure. type: string includeRegistryIdInChips: type: boolean isContainable: type: boolean itemIdPrefix: type: string name: description: The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization. type: string organizationId: description: The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller. type: string systemCategories: items: $ref: '#/components/schemas/SystemCategoryConfigurationInputBase' type: array systemName: description: The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization. type: string useRegistryIdForItemDisplayLabel: type: boolean required: - organizationId - description - itemIdPrefix - formatId - domainLinkedSchemas - chainLinkedSchemas 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 RnaSequenceSchemaRef: properties: __typename: type: string id: format: api_id type: string 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 AaDomainConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_aadomain type: string required: - systemCategoryId 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 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 ProteinDomainNameTemplatePartConfiguration: description: Configuration for a protein domain name template part. properties: __typename: type: string proteinDomain: $ref: '#/components/schemas/ProteinFormatDomain' 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 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 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 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 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 ProteinSchema: description: Defines the structure, field definitions, and configuration options for Proteins. properties: __typename: type: string archiveReason: type: - 'null' - string 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 chainLinkedSchemas: description: Schema or interface links for each chain label in the protein format. items: $ref: '#/components/schemas/ChainLinkedSchema' type: array constraint: oneOf: - $ref: '#/components/schemas/Constraint' - type: 'null' containableType: enum: - NONE - ENTITY - BATCH type: string containerNameTemplate: oneOf: - $ref: '#/components/schemas/ContainerNameTemplate' - type: 'null' createdAt: format: datetime type: - 'null' - string description: type: string domainLinkedSchemas: description: Schema or interface links for each domain type in the protein format. items: $ref: '#/components/schemas/DomainLinkedSchema' type: array fieldDefinitions: format: uri type: string fieldsets: format: uri type: string format: $ref: '#/components/schemas/ProteinFormatRef' description: The protein format that defines the structure (domains, chains, interactions) for entities of this schema. iconId: enum: - ANTIBODY - BASIC_FOLDER_ITEM type: string id: type: string includeRegistryIdInChips: type: boolean itemIdPrefix: type: string modifiedAt: format: datetime type: string name: type: string nameTemplate: oneOf: - $ref: '#/components/schemas/EntityNameTemplate' - type: 'null' organization: $ref: '#/components/schemas/OrganizationRef' systemCategories: items: $ref: '#/components/schemas/SystemCategoryConfiguration' type: array systemName: type: string useRegistryIdForItemDisplayLabel: type: boolean 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 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 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 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 BaseSystemCategoryConfiguration: description: 'Default configuration for system categories that require no additional configuration beyond the system category identifier.' properties: __typename: type: string systemCategoryId: type: string 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 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 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 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 EntitySchemaApplyFieldsetOutput: description: Return shape for the apply_fieldset API on entity schemas. properties: schema: oneOf: - $ref: '#/components/schemas/EntitySchemaBaseRef' - type: 'null' warnings: items: $ref: '#/components/schemas/EntitySchemaApplyFieldsetWarning' type: array 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 DnaSubElementConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_dnasubelement type: string required: - systemCategoryId 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 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 ChainLinkedSchema: properties: __typename: type: string label: type: string schemaOrInterfaceId: type: - 'null' - string 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 DnaChainConfigurationInput: additionalProperties: false properties: systemCategoryId: enum: - ssi_dnachain type: string required: - systemCategoryId 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 ContainerNameTemplate: description: A name template for containers. properties: __typename: type: string parts: items: $ref: '#/components/schemas/ContainerNameTemplatePart' type: array 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 ChainLinkedSchemaInput: additionalProperties: false properties: label: description: Chain label from the protein format to map to a schema. type: string schemaOrInterfaceId: description: API ID of the schema or schema interface to use for the chain label. type: string required: - label - schemaOrInterfaceId type: object 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 parameters: 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 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 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