openapi: 3.2.0 info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html title: Benchling Result Schema API version: 2.0.0 description: 'Defines the structure and metadata fields for a category of assay Results in Benchling''s lab automation system. A ResultSchema specifies the field definitions that capture measurement data, calculated values, and other experimental outcomes. Results conforming to a schema are typically created through lab automation output processors (see AutomationOutputProcessor), structured result tables in notebook entries, or via the API. Each schema is owned by an Organization and supports collaboration settings for access control. ResultSchemas are often associated with specific assay types such as ELISA, qPCR, or mass spectrometry, enabling standardized data capture across experiments. Also known as "assay schema" in some contexts (note the assaysch prefix).' servers: - url: /api/v3 security: - oAuth: [] - basicApiKeyAuth: [] tags: - description: 'Defines the structure and metadata fields for a category of assay Results in Benchling''s lab automation system. A ResultSchema specifies the field definitions that capture measurement data, calculated values, and other experimental outcomes. Results conforming to a schema are typically created through lab automation output processors (see AutomationOutputProcessor), structured result tables in notebook entries, or via the API. Each schema is owned by an Organization and supports collaboration settings for access control. ResultSchemas are often associated with specific assay types such as ELISA, qPCR, or mass spectrometry, enabling standardized data capture across experiments. Also known as "assay schema" in some contexts (note the assaysch prefix).' name: ResultSchema x-bnch-organization: Benchling paths: /result-schema/items: get: description: List ResultSchema items. operationId: ResultSchema.List parameters: - $ref: '#/components/parameters/archiveReason.anyOf' - $ref: '#/components/parameters/archived.anyOf' - $ref: '#/components/parameters/createdAt.gt' - $ref: '#/components/parameters/createdAt.gte' - $ref: '#/components/parameters/createdAt.lt' - $ref: '#/components/parameters/createdAt.lte' - $ref: '#/components/parameters/id.anyOf' - $ref: '#/components/parameters/modifiedAt.gt' - $ref: '#/components/parameters/modifiedAt.gte' - $ref: '#/components/parameters/modifiedAt.lt' - $ref: '#/components/parameters/modifiedAt.lte' - $ref: '#/components/parameters/name.anyOf' - $ref: '#/components/parameters/name.anyOf.caseSensitive' - $ref: '#/components/parameters/nextToken' - $ref: '#/components/parameters/omit' - $ref: '#/components/parameters/pageSize' - $ref: '#/components/parameters/returning' - description: 'Method by which to order results. Valid sorts are: createdAt (created time, oldest first) and modifiedAt (modified time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is modifiedAt:desc.' in: query name: sort schema: default: modifiedAt:desc enum: - createdAt:asc - createdAt:desc - modifiedAt:asc - modifiedAt:desc type: string - description: Set to true to access beta operations via /api/v3. in: header name: EARLY-ACCESS required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResultSchemaPaginatedList' 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 ResultSchema items tags: - ResultSchema x-bnch-rate-limit-tier: 4 /result-schema/{result_schema_id}: get: description: Get a single ResultSchema by ID. operationId: ResultSchema.Get parameters: - description: ID of the ResultSchema. in: path name: result_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/ResultSchema' 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 ResultSchema by ID tags: - ResultSchema x-bnch-rate-limit-tier: 5 /result-schema/{result_schema_id}/field-definitions/items: get: description: List SchemaFieldDefinition items. operationId: ResultSchema.fieldDefinitions.List parameters: - description: ID of the ResultSchema. in: path name: result_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: - ResultSchema x-bnch-rate-limit-tier: 4 components: schemas: CustomEntitySchemaRef: properties: __typename: type: string id: format: api_id type: string 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 RunSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object LongTextFieldDefinition: description: A long text field definition for multi-line text values with no length restrictions. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object ResultSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object CustomEntityLinkFieldDefinition: description: A schema field definition for linking to custom entities. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent custom entity. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/CustomEntitySchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object 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 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 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 ResultSchema: description: 'Defines the structure and metadata fields for a category of assay Results in Benchling''s lab automation system. A ResultSchema specifies the field definitions that capture measurement data, calculated values, and other experimental outcomes. Results conforming to a schema are typically created through lab automation output processors (see AutomationOutputProcessor), structured result tables in notebook entries, or via the API. Each schema is owned by an Organization and supports collaboration settings for access control. ResultSchemas are often associated with specific assay types such as ELISA, qPCR, or mass spectrometry, enabling standardized data capture across experiments. Also known as "assay schema" in some contexts (note the assaysch prefix).' properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string fieldDefinitions: description: Defines the metadata fields for results belonging to this schema format: uri type: string id: type: string modifiedAt: description: DateTime the Result Schema was last modified format: datetime type: - 'null' - string name: type: string organization: description: The organization that owns the schema oneOf: - $ref: '#/components/schemas/OrganizationRef' - type: 'null' type: object DnaOligoSchemaRef: properties: __typename: type: string id: format: api_id type: string 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 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 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 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 ResultSchemaPaginatedList: additionalProperties: false properties: items: items: $ref: '#/components/schemas/ResultSchema' type: array nextToken: type: string type: object RnaOligoLinkFieldDefinition: description: A schema field definition for linking to RNA Oligos. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent RNA Oligo. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: $ref: '#/components/schemas/RnaOligoSchemaRef' description: The linked item must be of this schema. This is required because we do not allow linking to a generic RNA Oligo. modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object 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 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 DnaSequenceLinkFieldDefinition: description: A schema field definition for linking to DNA sequences. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent DNA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/DnaSequenceSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object FieldsetRef: properties: __typename: type: string id: format: api_id type: string type: object 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 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 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 RnaSequenceSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object JsonFieldDefinition: description: A JSON field definition for storing structured JSON data. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isRequired: type: boolean modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object 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 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 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 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 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 EquipmentSchemaRef: properties: __typename: type: string id: format: api_id type: string 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 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 OligoConjugateSchemaRef: properties: __typename: type: string id: format: api_id type: string 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 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 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 SchemaFieldDefinitionUnpaginatedList: additionalProperties: false properties: items: items: $ref: '#/components/schemas/SchemaFieldDefinition' type: array type: object MixtureSchemaRef: properties: __typename: type: string id: format: api_id type: string type: object UnitRef: properties: __typename: type: string id: format: api_id type: string type: object AaSequenceLinkFieldDefinition: description: A schema field definition for linking to AA sequences. properties: __typename: type: string archiveReason: type: - 'null' - string archived: type: boolean createdAt: format: datetime type: - 'null' - string derivationType: enum: - DIRECT - COMPUTED - SNAPSHOT type: string description: type: - 'null' - string id: type: string isMulti: type: boolean isParent: description: 'Means the link is from a child to a parent AA sequence. Important for the registry''s lot-numbering functionality.' type: boolean isRequired: type: boolean linkDefinition: oneOf: - $ref: '#/components/schemas/AaSequenceSchemaRef' - type: 'null' modifiedAt: format: datetime type: - 'null' - string name: type: string systemName: type: string type: object parameters: modifiedAt.gt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30. in: query name: modifiedAt.gt schema: format: datetime type: string id.anyOf: description: Restricts results to those matching any of the specified IDs. Comma-separated list. explode: false in: query name: id.anyOf schema: items: type: string maxItems: 100 type: array archived.anyOf: description: If true, returns archived items. If false, returns unarchived items. If both true and false, returns archived and unarchived items. Comma-separated list. explode: false in: query name: archived.anyOf schema: items: type: boolean maxItems: 2 type: array createdAt.lte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or before the specified time. e.g. <= 2017-04-30. in: query name: createdAt.lte schema: format: datetime type: string createdAt.gte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created at or after the specified time. e.g. >= 2017-04-30. in: query name: createdAt.gte schema: format: datetime type: string createdAt.gt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30. in: query name: createdAt.gt schema: format: datetime type: string createdAt.lt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30. in: query name: createdAt.lt schema: format: datetime type: string name.anyOf: description: Restricts results to those that match any of the specified names. Case insensitive. Warning - this filter can be non-performant due to case insensitivity. Ensure only one name filter is used at a time. Comma-separated list. explode: false in: query name: name.anyOf schema: items: type: string maxItems: 100 type: array name.anyOf.caseSensitive: description: Restricts results to those that match any of the specified names. Case sensitive. Ensure only one name filter is used at a time. Comma-separated list. explode: false in: query name: name.anyOf.caseSensitive schema: items: type: string maxItems: 100 type: array modifiedAt.gte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or after the specified time. e.g. >= 2017-04-30. in: query name: modifiedAt.gte schema: format: datetime type: string omit: description: Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning. explode: false in: query name: omit schema: items: type: string type: array nextToken: description: Token for pagination in: query name: nextToken schema: type: string pageSize: description: Number of results to return. Defaults to 50, maximum of 100. in: query name: pageSize schema: type: integer modifiedAt.lte: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified at or before the specified time. e.g. <= 2017-04-30. in: query name: modifiedAt.lte schema: format: datetime type: string modifiedAt.lt: description: Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30. in: query name: modifiedAt.lt schema: format: datetime type: string archiveReason.anyOf: description: Restricts items to those with any of the specified archive reasons. Use "NOT_ARCHIVED" to filter for unarchived items. Use "ANY_ARCHIVED" to filter for archived items regardless of reason. Use "ANY_ARCHIVED_OR_NOT_ARCHIVED" to return items for both archived and unarchived. Comma-separated list. explode: false in: query name: archiveReason.anyOf schema: items: type: string maxItems: 10 type: array returning: description: Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit. explode: false in: query name: returning schema: items: type: string type: array responses: TooManyRequests: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Too Many Requests BadRequest: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Bad Request InternalServerError: content: application/problem+json: schema: $ref: '#/components/schemas/InternalServerError' description: Internal Server Error NotFound: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Not Found Forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/GeneralError' description: Forbidden securitySchemes: basicApiKeyAuth: description: Use issued API key for standard access to the API scheme: basic type: http basicClientIdSecretAuth: description: Auth used as part of client credentials OAuth flow prior to receiving a bearer token. scheme: basic type: http oAuth: description: OAuth2 Client Credentials flow intended for service access flows: clientCredentials: scopes: {} tokenUrl: /oauth/token type: oauth2