{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Plates API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Plates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List plates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/plates",
            "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",
                "description": "Method by which to order search results. Valid sorts are barcode, name, modifiedAt, and createdAt. Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt.\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": "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 plate. Restricts results to those with the specified name."
              },
              {
                "name": "nameIncludes",
                "value": "",
                "type": "query",
                "description": "Name substring of a plate. Restricts results to those with names that include the provided substring.\n"
              },
              {
                "name": "emptyPositions",
                "value": "",
                "type": "query",
                "description": "Only return plates that have the specified number of empty positions\n"
              },
              {
                "name": "emptyPositions.gte",
                "value": "",
                "type": "query",
                "description": "Only return plates that have greater-than or equal-to the specified number of empty positions.\n"
              },
              {
                "name": "emptyPositions.gt",
                "value": "",
                "type": "query",
                "description": "Only return plates that have greater-than the specified number of empty positions.\n"
              },
              {
                "name": "emptyPositions.lte",
                "value": "",
                "type": "query",
                "description": "Only return plates that have less-than or equal-to the specified number of empty positions.\n"
              },
              {
                "name": "emptyPositions.lt",
                "value": "",
                "type": "query",
                "description": "Only return plates that have less-than the specified number of empty positions.\n"
              },
              {
                "name": "emptyContainers",
                "value": "",
                "type": "query",
                "description": "Only return plates that have the specified number of empty containers (containers without contents).\n"
              },
              {
                "name": "emptyContainers.gte",
                "value": "",
                "type": "query",
                "description": "Only return plates that have greater-than or equal-to the specified number of empty containers (containers without contents).\n"
              },
              {
                "name": "emptyContainers.gt",
                "value": "",
                "type": "query",
                "description": "Only return plates that have greater-than the specified number of empty containers (containers without contents).\n"
              },
              {
                "name": "emptyContainers.lte",
                "value": "",
                "type": "query",
                "description": "Only return plates that have less-than or equal-to the specified number of empty containers (containers without contents).\n"
              },
              {
                "name": "emptyContainers.lt",
                "value": "",
                "type": "query",
                "description": "Only return plates that have less-than the specified number of empty containers (containers without contents).\n"
              },
              {
                "name": "ancestorStorageId",
                "value": "",
                "type": "query",
                "description": "ID of a location. Restricts results to those located in the specified inventory.\n"
              },
              {
                "name": "storageContentsId",
                "value": "",
                "type": "query",
                "description": "ID of a entity, or entity schema. Restricts results to those that hold containers with entities.\n"
              },
              {
                "name": "storageContentsIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of IDs of entities. Restricts results to those that hold containers with at least one of the specified entities.\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 plates. Use \"ANY_ARCHIVED\" to filter for archived plates regardless of reason. Use \"ANY_ARCHIVED_OR_NOT_ARCHIVED\" to return items for both archived and unarchived.\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": "barcodes",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of barcodes. Matches all of the provided barcodes, or returns a 400 error that includes a list of which barcodes are invalid.\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, 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, case sensitive.\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"
              },
              {
                "name": "creatorIds",
                "value": "",
                "type": "query",
                "description": "Comma separated list of users IDs"
              }
            ]
          },
          "docs": "List plates"
        },
        {
          "info": {
            "name": "Create a plate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/plates",
            "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": "Create a plate"
        },
        {
          "info": {
            "name": "Get a plate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/plates/:plate_id",
            "params": [
              {
                "name": "plate_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"
              }
            ]
          },
          "docs": "Get a plate"
        },
        {
          "info": {
            "name": "Update a plate",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/plates/:plate_id",
            "params": [
              {
                "name": "plate_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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a plate"
        },
        {
          "info": {
            "name": "Archive plates",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/plates:archive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive plates and any containers of the plates"
        },
        {
          "info": {
            "name": "BulkGet plates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/plates:bulk-get",
            "params": [
              {
                "name": "plateIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of plate IDs."
              },
              {
                "name": "barcodes",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of plate barcodes."
              },
              {
                "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"
              }
            ]
          },
          "docs": "BulkGet plates"
        },
        {
          "info": {
            "name": "Unarchive plates",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/plates:unarchive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unarchive plates and the containers that were archived along with them"
        }
      ]
    }
  ],
  "bundled": true
}