{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences DNA Sequences API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "DNA Sequences",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/dna-sequences",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return. Defaults to 50, maximum of 100.\n"
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "Token for pagination"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              },
              {
                "name": "createdAt",
                "value": "",
                "type": "query",
                "description": "Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those created in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.\n"
              },
              {
                "name": "modifiedAt",
                "value": "",
                "type": "query",
                "description": "Datetime, in RFC 3339 format. Supports the > and < operators. Time zone defaults to UTC. Restricts results to those modified in the specified range. e.g. > 2017-04-30. Date ranges can be specified with the following nomenclature > YYYY-MM-DD AND <YYYY-MM-DD.\n"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Name of a DNA Sequence. Restricts results to those with the specified name, alias, or entity registry ID."
              },
              {
                "name": "nameIncludes",
                "value": "",
                "type": "query",
                "description": "Name substring of a DNA Sequence. Restricts results to those with names, aliases, or entity registry IDs that include the provided substring."
              },
              {
                "name": "bases",
                "value": "",
                "type": "query",
                "description": "Full bases of the DNA sequence. Restricts results to those with the specified bases, case-insensitive, allowing for circular or reverse complement matches. Does not allow partial matching or loose matching via degenerate bases."
              },
              {
                "name": "folderId",
                "value": "",
                "type": "query",
                "description": "ID of a folder. Restricts results to those in the folder."
              },
              {
                "name": "mentionedIn",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of entry IDs. Restricts results to DNA sequences mentioned in those entries.\n"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "ID of a project. Restricts results to those in the project."
              },
              {
                "name": "registryId",
                "value": "",
                "type": "query",
                "description": "ID of a registry. Restricts results to those registered in this registry. Specifying \"null\" returns unregistered items.\n"
              },
              {
                "name": "schemaId",
                "value": "",
                "type": "query",
                "description": "ID of a schema. Restricts results to those of the specified schema.\n"
              },
              {
                "name": "schemaFields",
                "value": "",
                "type": "query",
                "description": "Filter based on schema field value (not display value). Restricts results to those with a field whose value matches the filter. For Integer, Float, and Date type fields, supports the >= and <= operators (but not < or >). If any schemaField filters are present, the schemaId param must also be present. Note that all operators must be separated from any values by a single space.\n"
              },
              {
                "name": "archiveReason",
                "value": "",
                "type": "query",
                "description": "Archive reason. Restricts items to those with the specified archive reason. Use \"NOT_ARCHIVED\" to filter for unarchived DNA sequences. Use \"ANY_ARCHIVED\" to filter for archived DNA sequences regardless of reason. Use \"ANY_ARCHIVED_OR_NOT_ARCHIVED\" to return items for both archived and unarchived.\n"
              },
              {
                "name": "mentions",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of item IDs. Restricts results to those that mention the given items in the description.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of ids. Matches all of the provided IDs, or returns a 400 error that includes a list of which IDs are invalid.\n"
              },
              {
                "name": "entityRegistryIds.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of entity registry IDs. Maximum of 100. Restricts results to those that match any of the specified registry IDs.\n"
              },
              {
                "name": "names.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, aliases, or entity registry IDs, case insensitive.  Warning - this filter can be non-performant due to case insensitivity.\n"
              },
              {
                "name": "names.anyOf.caseSensitive",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of names. Maximum of 100. Restricts results to those that match any of the specified names, aliases, or entity registry IDs, case sensitive.\n"
              },
              {
                "name": "creatorIds",
                "value": "",
                "type": "query",
                "description": "Comma separated list of users IDs"
              },
              {
                "name": "authorIds.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma separated list of user or app IDs. Maximum of 100."
              },
              {
                "name": "returning",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, [click here](https://docs.benchling.com/docs/getting-started-1#returning-query-parameter).\n\n**Note**: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: \"dnaSequences.annotations.id\" will return the same as \"dnaSequences.annotations\".\n"
              }
            ]
          },
          "docs": "List DNA sequences"
        },
        {
          "info": {
            "name": "Create a DNA sequence",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a DNA sequence"
        },
        {
          "info": {
            "name": "Get a DNA sequence",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/dna-sequences/:dna_sequence_id",
            "params": [
              {
                "name": "dna_sequence_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "returning",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, [click here](https://docs.benchling.com/docs/getting-started-1#returning-query-parameter).\n\n**Note**: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: \"annotations.id\" will return the same as \"annotations\".\n"
              }
            ]
          },
          "docs": "Get a DNA sequence"
        },
        {
          "info": {
            "name": "Update a DNA sequence",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/dna-sequences/:dna_sequence_id",
            "params": [
              {
                "name": "dna_sequence_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a DNA sequence"
        },
        {
          "info": {
            "name": "Create or update a registered DNA sequence",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/dna-sequences/:entity_registry_id:upsert",
            "params": [
              {
                "name": "entity_registry_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update a registered DNA sequence.\n\nSchema field links can be populated using entity registry IDs or API IDs. In the `value` field of the [Field](#/components/schemas/FieldWithResolution) resource, the object `{\"entityRegistryId\": ENTITY_REGISTRY_ID}` may be provided instead of the API ID if desired (see example value).\n"
        },
        {
          "info": {
            "name": "Archive DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:archive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive DNA sequences"
        },
        {
          "info": {
            "name": "Auto-annotate DNA sequences with matching features from specified Feature Libraries",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:auto-annotate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Auto-annotate DNA sequences with matching features from specified Feature Libraries. Limit of 2000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "Autofill DNA sequence parts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:autofill-parts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Autofill DNA sequence parts. Limit of 2000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "Autofill DNA sequence transcriptions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:autofill-transcriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Autofill DNA sequence transcriptions from RNA Sequences with matching schemas and bases. Limit of 2000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "Autofill DNA sequence translations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:autofill-translations",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Autofill DNA sequence translations. Limit of 2000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "Bulk Create DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:bulk-create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk Create DNA sequences. Limit of 1000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "Bulk get DNA sequences by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/dna-sequences:bulk-get",
            "params": [
              {
                "name": "dnaSequenceIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of IDs of DNA sequences to get.\n"
              },
              {
                "name": "returning",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, [click here](https://docs.benchling.com/docs/getting-started-1#returning-query-parameter).\n\n**Note**: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: \"dnaSequences.annotations.id\" will return the same as \"dnaSequences.annotations\".\n"
              }
            ]
          },
          "docs": "Bulk get DNA sequences by ID"
        },
        {
          "info": {
            "name": "Bulk Update DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:bulk-update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk Update DNA sequences. Limit of 1000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "Bulk upsert DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:bulk-upsert",
            "params": [
              {
                "name": "returning",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, '*'. For more information, [click here](https://docs.benchling.com/docs/getting-started-1#returning-query-parameter).\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "All entities and their schemas must be within the same registry.\n\nThis operation performs the following actions:\n1. Any existing objects are looked up in Benchling by the provided entity registry ID.\n2. Then, all objects are either created or updated accordingly, temporarily skipping any schema field links between objects.\n3. Schema field links can be populated using entity registry IDs or API IDs. In the `value` field of the [Field](#/components/schemas/FieldWithResolution) resource, the object"
        },
        {
          "info": {
            "name": "Find matching regions for DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:find-matching-regions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Find matching regions for DNA sequences. Limit of 1000 DNA Sequences per request."
        },
        {
          "info": {
            "name": "List entities with matching bases",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:match-bases",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns DNA Sequences that exactly match the provided bases.\n"
        },
        {
          "info": {
            "name": "Create codon-optimized DNA sequences.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:optimize-codons",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create codon-optimized DNA sequences."
        },
        {
          "info": {
            "name": "Search DNA Sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:search-bases",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns DNA Sequences that contain the provided bases. Search indexing is asynchronous, so results my be not be available immediately after creation.\n"
        },
        {
          "info": {
            "name": "Unarchive DNA sequences",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/dna-sequences:unarchive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unarchive DNA sequences"
        }
      ]
    }
  ],
  "bundled": true
}