{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Oligos API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Oligos",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Oligos",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/oligos",
            "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": "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 an Oligo. Restricts results to those with the specified name, alias, or entity registry ID."
              },
              {
                "name": "bases",
                "value": "",
                "type": "query",
                "description": "Full bases of the oligo. 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.\n"
              },
              {
                "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 Oligos 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 Oligos. Use \"ANY_ARCHIVED\" to filter for archived Oligos 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": "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)."
              }
            ]
          },
          "docs": "List Oligos"
        },
        {
          "info": {
            "name": "Create an Oligo",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/oligos",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an Oligo"
        },
        {
          "info": {
            "name": "Get an Oligo",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/oligos/:oligo_id",
            "params": [
              {
                "name": "oligo_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)."
              }
            ]
          },
          "docs": "Get an Oligo"
        },
        {
          "info": {
            "name": "Update an Oligo",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/oligos/:oligo_id",
            "params": [
              {
                "name": "oligo_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an Oligo"
        },
        {
          "info": {
            "name": "Archive Oligos",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/oligos:archive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive Oligos"
        },
        {
          "info": {
            "name": "Bulk Create DNA Oligos",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/oligos:bulk-create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk Create DNA Oligos\nPlease migrate to [Bulk Create DNA Oligos](#/DNA%20Oligos/bulkCreateDNAOligos) so that we can support RNA Oligos.\n"
        },
        {
          "info": {
            "name": "Bulk get Oligos by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/oligos:bulk-get",
            "params": [
              {
                "name": "oligoIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of IDs of Oligos 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)."
              }
            ]
          },
          "docs": "Bulk get Oligos by ID"
        },
        {
          "info": {
            "name": "Unarchive Oligos",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/oligos:unarchive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unarchive Oligos"
        }
      ]
    }
  ],
  "bundled": true
}