{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/benchling/main/json-schema/benchling-request-response-schema.json", "title": "RequestResponse", "x-generated": "2026-10-12", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/benchling-legacy-requests-api-openapi.yml#/components/schemas/RequestResponse", "properties": { "results": { "items": { "$ref": "#/$defs/AssayResult" }, "type": "array" }, "samples": { "description": "Array of samples produced by the Legacy Request.", "items": { "properties": { "batch": { "allOf": [ { "$ref": "#/$defs/RequestResponseSamplesItemBatch" } ], "description": "The sample, if it is a batch resource. Null otherwise." }, "entity": { "allOf": [ { "$ref": "#/$defs/RequestResponseSamplesItemEntity" } ], "description": "The sample, if it is an entity resource. Null otherwise." }, "status": { "description": "The status of the sample, based on the status of the stage run that generated it.", "enum": [ "COMPLETED", "DISCARDED" ], "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object", "$defs": { "AaAnnotation": { "properties": { "color": { "type": "string" }, "end": { "description": "0-based exclusive end index. The end of the AA sequence is always represented as 0.", "type": "integer" }, "id": { "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "notes": { "maxLength": 10000, "type": "string" }, "start": { "description": "0-based inclusive start index.", "type": "integer" }, "type": { "maxLength": 255, "type": "string" } }, "type": "object" }, "AaSequence": { "properties": { "aliases": { "description": "Array of aliases", "items": { "type": "string" }, "type": "array" }, "aminoAcids": { "description": "Amino acids of the AA sequence.", "type": "string" }, "annotations": { "description": "Array of annotation objects on the AA sequence.", "items": { "$ref": "#/$defs/AaAnnotation" }, "type": "array" }, "apiURL": { "description": "The canonical url of the AA Sequence in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "createdAt": { "description": "DateTime the AA sequence was created.", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "$ref": "#/$defs/UserSummary" }, "customFields": { "allOf": [ { "$ref": "#/$defs/CustomFields" } ], "description": "Custom fields set on the AA sequence." }, "entityRegistryId": { "description": "Registry ID of the AA sequence if registered.", "type": [ "string", "null" ] }, "fields": { "$ref": "#/$defs/Fields" }, "folderId": { "description": "ID of the folder that contains the AA sequence.", "type": [ "string", "null" ] }, "id": { "description": "ID of the AA sequence.", "type": "string" }, "length": { "description": "Number of amino acids in the AA sequence.", "type": "integer" }, "modifiedAt": { "description": "DateTime the AA sequence was last modified.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the AA sequence.", "type": "string" }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "description": "Registry the AA sequence is registered in.", "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "url": { "description": "The path of the web URL, omitting the tenant domain", "type": "string" }, "webURL": { "description": "URL of the AA sequence.", "format": "uri", "readOnly": true, "type": "string" } }, "type": "object" }, "AaSequenceSummary": { "properties": { "entityType": { "enum": [ "aa_sequence" ], "type": "string" }, "id": { "type": "string" }, "type": { "deprecated": true, "type": "string" } }, "type": "object" }, "AaSequenceWithEntityType": { "allOf": [ { "$ref": "#/$defs/AaSequence" }, { "properties": { "entityType": { "enum": [ "aa_sequence" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "ArchiveRecord": { "properties": { "reason": { "type": "string" } }, "type": "object" }, "AssayResult": { "properties": { "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ], "description": "ArchiveRecord Resource if the result is archived. This is null if the result is not archived.\n" }, "createdAt": { "description": "DateTime at which the the result was created", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "allOf": [ { "$ref": "#/$defs/UserSummary" } ], "description": "UserSummary Resource of who created the request", "readOnly": true }, "entryId": { "description": "ID of the entry that this result is attached to", "type": [ "string", "null" ] }, "fieldValidation": { "additionalProperties": { "$ref": "#/$defs/UserValidation" }, "description": "Object mapping field names to a UserValidation Resource object for that field. To **set** validation for a result, you *must* use this object.\n", "type": "object" }, "fields": { "allOf": [ { "$ref": "#/$defs/Fields" } ], "description": "Field values for the returned result. Please note the keys of each field are the field's system name (additional_prop) instead of the field's display name (additionalProp).\n" }, "id": { "description": "ID of the result", "type": "string" }, "isReviewed": { "description": "Whether or not this result is attached to an accepted entry", "type": "boolean" }, "modifiedAt": { "description": "DateTime at which the the result was last modified", "format": "date-time", "readOnly": true, "type": "string" }, "projectId": { "description": "ID of the project to insert the result into", "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ], "description": "Schema that the result belongs to", "title": "SchemaProperty" }, "v3Id": { "description": "V3 identifier for the result", "readOnly": true, "type": "string" }, "validationComment": { "readOnly": true, "type": "string" }, "validationStatus": { "readOnly": true, "type": "string" } }, "type": "object" }, "Batch": { "additionalProperties": false, "properties": { "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "createdAt": { "description": "DateTime at which the the result was created", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "allOf": [ { "$ref": "#/$defs/UserSummary" } ], "readOnly": true }, "defaultConcentration": { "$ref": "#/$defs/Measurement" }, "entity": { "oneOf": [ { "$ref": "#/$defs/DnaSequenceSummary" }, { "$ref": "#/$defs/AaSequenceSummary" }, { "$ref": "#/$defs/CustomEntitySummary" } ] }, "fields": { "$ref": "#/$defs/Fields" }, "id": { "readOnly": true, "type": "string" }, "modifiedAt": { "format": "date-time", "readOnly": true, "type": "string" }, "name": { "type": "string" }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ], "readOnly": true, "title": "SchemaProperty" }, "webURL": { "readOnly": true, "type": "string" } }, "type": "object" }, "BatchOrInaccessibleResource": { "oneOf": [ { "$ref": "#/$defs/Batch" }, { "$ref": "#/$defs/InaccessibleResource" } ] }, "ContainerLabels": { "properties": { "barcode": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "CustomEntity": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "apiURL": { "description": "The canonical url of the Custom Entity in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "createdAt": { "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "allOf": [ { "$ref": "#/$defs/UserSummary" }, { "readOnly": true } ] }, "customFields": { "$ref": "#/$defs/CustomFields" }, "entityRegistryId": { "type": [ "string", "null" ] }, "fields": { "$ref": "#/$defs/Fields" }, "folderId": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "modifiedAt": { "format": "date-time", "readOnly": true, "type": "string" }, "name": { "type": "string" }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "url": { "description": "The path of the web URL, omitting the tenant domain", "type": "string" }, "webURL": { "readOnly": true, "type": "string" } }, "type": "object" }, "CustomEntitySummary": { "properties": { "entityType": { "enum": [ "custom_entity" ], "type": "string" }, "id": { "type": "string" }, "type": { "deprecated": true, "type": "string" } }, "type": "object" }, "CustomEntityWithEntityType": { "allOf": [ { "$ref": "#/$defs/CustomEntity" }, { "properties": { "entityType": { "enum": [ "custom_entity" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "CustomField": { "properties": { "value": { "type": "string" } }, "type": "object" }, "CustomFields": { "additionalProperties": { "$ref": "#/$defs/CustomField" }, "type": "object" }, "DnaAnnotation": { "allOf": [ { "$ref": "#/$defs/SequenceFeatureBase" }, { "properties": { "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "start": { "description": "0-based inclusive start index.", "type": "integer" }, "strand": { "maximum": 1, "minimum": -1, "type": "integer" }, "type": { "type": "string" } }, "type": "object" } ] }, "DnaOligo": { "allOf": [ { "$ref": "#/$defs/Oligo" }, { "properties": { "annotations": { "description": "Annotations on the Oligo.", "items": { "$ref": "#/$defs/DnaAnnotation" }, "type": "array" }, "apiURL": { "type": "string" }, "bases": { "type": "string" }, "customNotation": { "description": "Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.", "type": [ "string", "null" ] }, "customNotationName": { "description": "Name of the custom notation specified in the request. Null if no notation was specified.", "type": [ "string", "null" ] }, "helm": { "description": "Representation of the oligo in HELM syntax, including any chemical modifications", "type": "string" } } } ] }, "DnaOligoWithEntityType": { "allOf": [ { "$ref": "#/$defs/DnaOligo" }, { "properties": { "entityType": { "enum": [ "dna_oligo" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "DnaSequence": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "annotations": { "items": { "$ref": "#/$defs/DnaAnnotation" }, "type": "array" }, "apiURL": { "description": "The canonical url of the DNA Sequence in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "bases": { "type": "string" }, "createdAt": { "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "$ref": "#/$defs/UserSummary" }, "customFields": { "$ref": "#/$defs/CustomFields" }, "dnaAlignmentIds": { "description": "API IDs of Nucleotide Alignments involving the RNA sequence", "items": { "type": "string" }, "type": "array" }, "entityRegistryId": { "type": [ "string", "null" ] }, "fields": { "$ref": "#/$defs/Fields" }, "folderId": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "isCircular": { "type": "boolean" }, "length": { "type": "integer" }, "modifiedAt": { "format": "date-time", "readOnly": true, "type": "string" }, "name": { "type": "string" }, "parts": { "items": { "$ref": "#/$defs/DnaSequencePart" }, "type": "array" }, "primers": { "items": { "$ref": "#/$defs/Primer" }, "type": "array" }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "transcriptions": { "items": { "$ref": "#/$defs/DnaSequenceTranscription" }, "type": "array" }, "translations": { "items": { "$ref": "#/$defs/Translation" }, "type": "array" }, "url": { "description": "The path of the web URL, omitting the tenant domain", "type": "string" }, "webURL": { "readOnly": true, "type": "string" } }, "type": "object" }, "DnaSequencePart": { "allOf": [ { "$ref": "#/$defs/NucleotideSequencePart" }, { "properties": { "strand": { "maximum": 1, "minimum": -1, "type": "integer" } }, "type": "object" } ] }, "DnaSequenceSummary": { "properties": { "entityType": { "enum": [ "dna_sequence" ], "type": "string" }, "id": { "type": "string" }, "type": { "deprecated": true, "type": "string" } }, "type": "object" }, "DnaSequenceTranscription": { "properties": { "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "sequenceId": { "description": "Linked RNA sequence ID.", "type": "string" }, "start": { "description": "0-based inclusive start index.", "type": "integer" }, "strand": { "maximum": 1, "minimum": -1, "type": "integer" } }, "type": "object" }, "DnaSequenceWithEntityType": { "allOf": [ { "$ref": "#/$defs/DnaSequence" }, { "properties": { "entityType": { "enum": [ "dna_sequence" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "Entity": { "oneOf": [ { "$ref": "#/$defs/DnaSequenceWithEntityType" }, { "$ref": "#/$defs/RnaSequenceWithEntityType" }, { "$ref": "#/$defs/AaSequenceWithEntityType" }, { "$ref": "#/$defs/MixtureWithEntityType" }, { "$ref": "#/$defs/DnaOligoWithEntityType" }, { "$ref": "#/$defs/RnaOligoWithEntityType" }, { "$ref": "#/$defs/MoleculeWithEntityType" }, { "$ref": "#/$defs/CustomEntityWithEntityType" } ], "type": "object" }, "EntityLabels": { "properties": { "entityRegistryId": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "EntityOrInaccessibleResource": { "oneOf": [ { "$ref": "#/$defs/Entity" }, { "$ref": "#/$defs/InaccessibleResource" } ], "type": "object" }, "Field": { "properties": { "displayValue": { "readOnly": true, "type": [ "string", "null" ] }, "isMulti": { "readOnly": true, "type": "boolean" }, "textValue": { "readOnly": true, "type": [ "string", "null" ] }, "type": { "allOf": [ { "$ref": "#/$defs/FieldType" } ], "readOnly": true }, "value": { "description": "For single link fields, use the id of the item you want to link (eg. \"seq_jdf8BV24\").\nFor multi-link fields, use an array of ids of the items you want to link (eg. [\"seq_jdf8BV24\"])\n", "oneOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "items": { "type": "string" }, "type": "array" } ] } }, "required": [ "value" ], "type": "object" }, "FieldType": { "enum": [ "dna_sequence_link", "aa_sequence_link", "custom_entity_link", "entity_link", "mixture_link", "molecule_link", "dropdown", "part_link", "translation_link", "aa_part_link", "base_molecule_link", "blob_link", "text", "long_text", "batch_link", "storage_link", "entry_link", "assay_request_link", "assay_result_link", "assay_run_link", "boolean", "float", "integer", "datetime", "date", "json" ], "type": "string" }, "Fields": { "additionalProperties": { "$ref": "#/$defs/Field" }, "type": "object" }, "InaccessibleResource": { "additionalProperties": false, "properties": { "inaccessibleId": { "type": "string" }, "resourceType": { "enum": [ "inaccessible_resource" ], "type": "string" }, "type": { "description": "The type of this inaccessible item. Example values: \"custom_entity\", \"container\", \"plate\", \"dna_sequence\"\n", "type": "string" } }, "type": "object" }, "Ingredient": { "properties": { "amount": { "description": "The amount value of this ingredient in its mixture, in string format (to preserve full precision). Pair with `units`. Supports scientific notation (1.23e4). One ingredient on this mixture can have an amount value of `\"QS\"`.\n", "type": [ "string", "null" ] }, "catalogIdentifier": { "type": [ "string", "null" ] }, "componentEntity": { "allOf": [ { "$ref": "#/$defs/EntityLabels" }, { "description": "The entity that uniquely identifies this component." } ] }, "componentLotContainer": { "allOf": [ { "$ref": "#/$defs/ContainerLabels" } ], "description": "The container representing the component lot for this ingredient. This is only present if the mixture schema supports component lots in \"inventory\" format." }, "componentLotEntity": { "allOf": [ { "$ref": "#/$defs/EntityLabels" } ], "description": "The entity representing the component lot for this ingredient. This is only present if the mixture schema supports component lots in \"inventory\" format." }, "componentLotText": { "description": "Text representing the component lot for this ingredient. This is only present if the mixture schema supports component lots in \"text\" format.", "type": [ "string", "null" ] }, "hasParent": { "type": "boolean" }, "notes": { "type": [ "string", "null" ] }, "targetAmount": { "description": "The target amount for this ingredient such that this ingredient's proportion in its mixture would preserve the equivalent ingredient's proportion in the parent mixture. Pair with `units`.", "readOnly": true, "type": [ "string", "null" ] }, "units": { "$ref": "#/$defs/IngredientMeasurementUnits" } }, "type": "object" }, "IngredientMeasurementUnits": { "enum": [ "nL", "uL", "mL", "L", "mg", "g", "kg", "ug", "Units", "Cells", "mol", "mmol", "umol" ], "type": [ "string", "null" ] }, "Measurement": { "properties": { "units": { "description": "Can only be null if value is also null", "type": [ "string", "null" ] }, "value": { "description": "Can only be null if units is also null", "type": [ "number", "null" ] } }, "required": [ "value", "units" ], "type": "object" }, "Mixture": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "allowMeasuredIngredients": { "description": "Derived from the mixture's schema.", "readOnly": true, "type": "boolean" }, "amount": { "description": "The positive numerical amount value of this mixture in string format (to preserve full precision). Pair with `units`. Supports scientific notation (1.23e4).", "type": "string" }, "apiURL": { "description": "The canonical url of the Mixture in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "createdAt": { "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "allOf": [ { "$ref": "#/$defs/UserSummary" }, { "readOnly": true } ] }, "customFields": { "$ref": "#/$defs/CustomFields" }, "entityRegistryId": { "type": [ "string", "null" ] }, "fields": { "allOf": [ { "$ref": "#/$defs/Fields" } ], "description": "Mixtures can have up to one parent mixture field." }, "folderId": { "type": [ "string", "null" ] }, "id": { "type": "string" }, "ingredients": { "description": "List of ingredients on this mixture.", "items": { "$ref": "#/$defs/Ingredient" }, "type": "array" }, "modifiedAt": { "format": "date-time", "readOnly": true, "type": "string" }, "name": { "type": "string" }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "units": { "$ref": "#/$defs/MixtureMeasurementUnits" }, "webURL": { "readOnly": true, "type": "string" } }, "type": "object" }, "MixtureMeasurementUnits": { "enum": [ "nL", "uL", "mL", "L", "g", "kg", "mg", "ug", "Units" ], "type": [ "string", "null" ] }, "MixtureWithEntityType": { "allOf": [ { "$ref": "#/$defs/Mixture" }, { "properties": { "entityType": { "enum": [ "mixture" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "Molecule": { "additionalProperties": false, "properties": { "aliases": { "description": "Array of aliases.", "items": { "type": "string" }, "type": "array" }, "apiURL": { "description": "The canonical url of the Molecule in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "canonicalizedSmiles": { "description": "The canonicalized chemical structure in SMILES format.", "type": "string" }, "createdAt": { "description": "DateTime the Molecule was created.", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "$ref": "#/$defs/UserSummary" }, "customFields": { "allOf": [ { "$ref": "#/$defs/CustomFields" } ], "description": "Custom fields set on the Molecule." }, "entityRegistryId": { "description": "Registry ID of the Molecule if registered.", "type": [ "string", "null" ] }, "fields": { "$ref": "#/$defs/Fields" }, "folderId": { "description": "ID of the folder that contains the Molecule.", "type": [ "string", "null" ] }, "id": { "description": "ID of the Molecule.", "type": "string" }, "modifiedAt": { "description": "DateTime the Molecule was last modified.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the Molecule.", "type": "string" }, "originalSmiles": { "description": "The original chemical structure supplied by the user in SMILES format. Null if the user did not originally supply SMILES.", "type": [ "string", "null" ] }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "description": "Registry the Molecule is registered in.", "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "webURL": { "description": "URL of the Molecule.", "format": "uri", "readOnly": true, "type": "string" } }, "type": "object" }, "MoleculeWithEntityType": { "allOf": [ { "$ref": "#/$defs/Molecule" }, { "properties": { "entityType": { "enum": [ "molecule" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "NucleotideSequencePart": { "properties": { "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "sequenceId": { "type": "string" }, "start": { "description": "0-based inclusive start index.", "type": "integer" } }, "type": "object" }, "Oligo": { "properties": { "aliases": { "description": "Array of aliases", "items": { "type": "string" }, "type": "array" }, "apiURL": { "description": "The canonical url of the Oligo in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "bases": { "description": "Base pairs of the Oligo.", "type": "string" }, "createdAt": { "description": "DateTime the Oligo was created.", "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "$ref": "#/$defs/UserSummary" }, "customFields": { "allOf": [ { "$ref": "#/$defs/CustomFields" } ], "description": "Custom fields set on the Oligo." }, "entityRegistryId": { "description": "Registry ID of the Oligo if registered.", "type": [ "string", "null" ] }, "fields": { "$ref": "#/$defs/Fields" }, "folderId": { "description": "ID of the folder that contains the Oligo.", "type": [ "string", "null" ] }, "id": { "description": "ID of the Oligo.", "type": "string" }, "length": { "description": "Number of bases in the Oligo.", "type": "integer" }, "modifiedAt": { "description": "DateTime the Oligo was last modified.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "Name of the Oligo.", "type": "string" }, "nucleotideType": { "description": "Nucleotide type of the Oligo.", "enum": [ "DNA", "RNA" ], "type": "string" }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "description": "Registry the Oligo is registered in.", "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "webURL": { "description": "URL of the Oligo.", "format": "uri", "readOnly": true, "type": "string" } }, "type": "object" }, "PartySummary": { "properties": { "handle": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Primer": { "properties": { "bases": { "readOnly": true, "type": "string" }, "bindPosition": { "readOnly": true, "type": "integer" }, "color": { "readOnly": true, "type": "string" }, "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "name": { "readOnly": true, "type": "string" }, "oligoId": { "type": "string" }, "overhangLength": { "readOnly": true, "type": "integer" }, "start": { "description": "0-based inclusive start index.", "type": "integer" }, "strand": { "type": "integer" } }, "type": "object" }, "RegistrationOrigin": { "properties": { "originEntryId": { "readOnly": true, "type": [ "string", "null" ] }, "registeredAt": { "format": "date-time", "readOnly": true, "type": "string" } }, "type": "object" }, "RequestResponseSamplesItemBatch": { "allOf": [ { "$ref": "#/$defs/BatchOrInaccessibleResource" } ] }, "RequestResponseSamplesItemEntity": { "allOf": [ { "$ref": "#/$defs/EntityOrInaccessibleResource" } ] }, "RnaAnnotation": { "allOf": [ { "$ref": "#/$defs/SequenceFeatureBase" }, { "properties": { "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "start": { "description": "0-based inclusive start index.", "type": "integer" }, "strand": { "maximum": 1, "minimum": 0, "type": "integer" }, "type": { "type": "string" } }, "type": "object" } ] }, "RnaOligo": { "allOf": [ { "$ref": "#/$defs/Oligo" }, { "properties": { "annotations": { "description": "Annotations on the Oligo.", "items": { "$ref": "#/$defs/RnaAnnotation" }, "type": "array" }, "apiURL": { "type": "string" }, "bases": { "type": "string" }, "customNotation": { "description": "Representation of the oligo in the custom notation specified in the request. Null if no notation was specified.", "type": [ "string", "null" ] }, "customNotationName": { "description": "Name of the custom notation specified in the request. Null if no notation was specified.", "type": [ "string", "null" ] }, "helm": { "description": "Representation of the oligo in HELM syntax, including any chemical modifications", "type": "string" }, "nucleotideType": { "type": "string" } } } ] }, "RnaOligoWithEntityType": { "allOf": [ { "$ref": "#/$defs/RnaOligo" }, { "properties": { "entityType": { "enum": [ "rna_oligo" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "RnaSequence": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "alignmentIds": { "description": "API IDs of Nucleotide Alignments involving the RNA sequence", "items": { "type": "string" }, "type": "array" }, "annotations": { "items": { "$ref": "#/$defs/RnaAnnotation" }, "type": "array" }, "apiURL": { "description": "The canonical url of the RNA Sequence in the API.", "format": "uri", "readOnly": true, "type": "string" }, "archiveRecord": { "allOf": [ { "$ref": "#/$defs/ArchiveRecord" } ] }, "authors": { "items": { "$ref": "#/$defs/UserSummary" }, "type": "array" }, "bases": { "type": "string" }, "createdAt": { "format": "date-time", "readOnly": true, "type": "string" }, "creator": { "$ref": "#/$defs/UserSummary" }, "customFields": { "$ref": "#/$defs/CustomFields" }, "customNotation": { "description": "Representation of the RNA Sequence in the custom notation specified in the request. Null if no notation was specified.", "type": [ "string", "null" ] }, "customNotationName": { "description": "Name of the custom notation specified in the request. Null if no notation was specified.", "type": [ "string", "null" ] }, "entityRegistryId": { "type": [ "string", "null" ] }, "fields": { "$ref": "#/$defs/Fields" }, "folderId": { "type": [ "string", "null" ] }, "helm": { "description": "Representation of the RNA Sequence in HELM syntax, including any chemical modifications.", "type": [ "string", "null" ] }, "id": { "type": "string" }, "isCircular": { "type": "boolean" }, "length": { "type": "integer" }, "modifiedAt": { "format": "date-time", "readOnly": true, "type": "string" }, "name": { "type": "string" }, "parts": { "items": { "$ref": "#/$defs/RnaSequencePart" }, "type": "array" }, "primers": { "items": { "$ref": "#/$defs/Primer" }, "type": "array" }, "registrationOrigin": { "allOf": [ { "$ref": "#/$defs/RegistrationOrigin" } ], "readOnly": true }, "registryId": { "type": [ "string", "null" ] }, "schema": { "allOf": [ { "$ref": "#/$defs/SchemaSummary" } ] }, "translations": { "items": { "$ref": "#/$defs/Translation" }, "type": "array" }, "url": { "description": "The path of the web URL, omitting the tenant domain", "type": "string" }, "webURL": { "readOnly": true, "type": "string" } }, "type": "object" }, "RnaSequencePart": { "allOf": [ { "$ref": "#/$defs/NucleotideSequencePart" }, { "properties": { "strand": { "maximum": 1, "minimum": 1, "type": "integer" } }, "type": "object" } ] }, "RnaSequenceWithEntityType": { "allOf": [ { "$ref": "#/$defs/RnaSequence" }, { "properties": { "entityType": { "enum": [ "rna_sequence" ], "type": "string" } }, "type": "object" } ], "type": "object" }, "SchemaSummary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "SequenceFeatureBase": { "properties": { "color": { "description": "Hex color code used when displaying this feature in the UI.", "type": "string" }, "customFields": { "items": { "$ref": "#/$defs/SequenceFeatureCustomField" }, "maxItems": 100, "type": "array" }, "name": { "maxLength": 2048, "type": "string" }, "notes": { "maxLength": 10000, "type": "string" } }, "type": "object" }, "SequenceFeatureCustomField": { "description": "A name and value pair associated with a sequence feature (annotation or translation). For genbank imports, these are the qualifiers associated with each feature.", "properties": { "name": { "description": "Name of the custom field", "type": "string" }, "value": { "description": "Value of the custom field", "type": "string" } }, "type": "object" }, "Translation": { "allOf": [ { "$ref": "#/$defs/SequenceFeatureBase" }, { "properties": { "aminoAcids": { "readOnly": true, "type": "string" }, "coerceStartCodonToMethionine": { "default": false, "description": "Whether to override the translation of the start codon to Methionine. Has no effect when the start codon already translates to Methionine.", "type": "boolean" }, "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "geneticCode": { "default": "STANDARD", "description": "The genetic code to use when translating the nucleotide sequence into amino acids.", "enum": [ "STANDARD", "VERTEBRATE_MITOCHONDRIAL", "YEAST_MITOCHONDRIAL", "MOLD_PROTOZOAN_COELENTERATE_MITOCHONDRIAL_MYCOPLASMA_SPIROPLASMA", "INVERTEBRATE_MITOCHONDRIAL", "CILIATE_DASYCLADACEAN_HEXAMITA_NUCLEAR", "ECHINODERM_FLATWORM_MITOCHONDRIAL", "EUPLOTID_NUCLEAR", "BACTERIAL_ARCHAEAL_PLANT_PLASTID", "ALTERNATIVE_YEAST_NUCLEAR", "ASCIDIAN_MITOCHONDRIAL", "ALTERNATIVE_FLATWORM_MITOCHONDRIAL", "CHLOROPHYCEAN_MITOCHONDRIAL", "TREMATODE_MITOCHONDRIAL", "SCENEDESMUS_OBLIQUUS_MITOCHONDRIAL", "THRAUSTOCHYTRIUM_MITOCHONDRIAL", "RHABDOPLEURIDAE_MITOCHONDRIAL", "CANDIDATE_DIVISION_SR1_GRACILIBACTERIA", "PACHYSOLEN_TANNOPHILUS_NUCLEAR", "MESODINIUM_NUCLEAR", "PERITRICH_NUCLEAR", "CEPHALODISCIDAE_MITOCHONDRIAL_UAA_TYR" ], "type": "string" }, "regions": { "items": { "properties": { "end": { "description": "0-based exclusive end index. The end of the sequence is always represented as 0.", "type": "integer" }, "start": { "description": "0-based inclusive start index.", "type": "integer" } }, "type": "object" }, "type": "array" }, "start": { "description": "0-based inclusive start index.", "type": "integer" }, "strand": { "type": "integer" } }, "type": "object" } ] }, "UserSummary": { "allOf": [ { "$ref": "#/$defs/PartySummary" }, {} ] }, "UserValidation": { "properties": { "validationComment": { "description": "A string explaining the reason for the provided validation status.", "type": "string" }, "validationStatus": { "description": "Valid values for this enum depend on whether it is used to set a value (e.g., in a POST request), or is a return value for an existing result.\nAcceptable values for setting a status are 'VALID' or 'INVALID'. Possible return values are 'VALID', 'INVALID', or 'PARTIALLY_VALID' (a result will be partially valid if it has some valid fields and some invalid fields).\n", "enum": [ "VALID", "INVALID", "PARTIALLY_VALID" ], "type": "string" } }, "type": "object" } } }