{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Containers API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Containers",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List containers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/containers",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return."
              },
              {
                "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."
              },
              {
                "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 container. Restricts results to those with the specified name."
              },
              {
                "name": "nameIncludes",
                "value": "",
                "type": "query",
                "description": "Name substring of a container. Restricts results to those with names that include the provided substring.\n"
              },
              {
                "name": "ancestorStorageId",
                "value": "",
                "type": "query",
                "description": "ID of a plate, box, or location. Restricts results to those located in the specified inventory."
              },
              {
                "name": "storageContentsId",
                "value": "",
                "type": "query",
                "description": "ID of an entity or entity schema. Restricts results to those that contain the specified entities or entities of the specified schema.\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 containers. Use \"ANY_ARCHIVED\" to filter for archived containers regardless of reason. Use \"ANY_ARCHIVED_OR_NOT_ARCHIVED\" to return items for both archived and unarchived.\n"
              },
              {
                "name": "checkoutStatus",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of check-out statuses. Restricts results to those that match one of the specified statuses. Valid statuses are AVAILABLE, RESERVED, and CHECKED_OUT.\n"
              },
              {
                "name": "checkoutAssigneeIds.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user or team IDs. Maximum of 100. Restricts results to those that are reserved or checked out for a user or team who matches any of the specified IDs or returns a 400 error with a list of invalid IDs.\n"
              },
              {
                "name": "restrictionStatus",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of restriction statuses. Restricts results to those that match one of the specified statuses. Valid statuses are RESTRICTED, UNRESTRICTED, and NOT_APPLICABLE.\n"
              },
              {
                "name": "sampleOwnerIds.allOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user or team IDs. Restricts results to those that match all of the specified IDs or returns a 400 error with a list of invalid IDs.\n"
              },
              {
                "name": "sampleOwnerIds.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user or team IDs. Maximum of 100. Restricts results to those that match any of the specified IDs or returns a 400 error with a list of invalid IDs.\n"
              },
              {
                "name": "sampleOwnerIds.noneOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user or team IDs. Restricts results to those that do not match any of the specified IDs or returns a 400 error with a list of invalid IDs.\n"
              },
              {
                "name": "restrictedSamplePartyIds.allOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user, team, or app IDs. Restricts results to those that match all of the specified IDs or returns a 400 error with a list of invalid IDs.\n"
              },
              {
                "name": "restrictedSamplePartyIds.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user, team, or app IDs. Maximum of 100. Restricts results to those that match any of the specified IDs or returns a 400 error with a list of invalid IDs.\n"
              },
              {
                "name": "restrictedSamplePartyIds.noneOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of user, team, or app IDs. Restricts results to those that do not match any of the specified IDs or returns a 400 error with a list of invalid IDs.\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": "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 containers"
        },
        {
          "info": {
            "name": "Create a new container",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new container"
        },
        {
          "info": {
            "name": "get a container by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/containers/:container_id",
            "params": [
              {
                "name": "container_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 a container by id"
        },
        {
          "info": {
            "name": "update a container",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/containers/:container_id",
            "params": [
              {
                "name": "container_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "update a container"
        },
        {
          "info": {
            "name": "List a container's contents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/containers/:container_id/contents",
            "params": [
              {
                "name": "container_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List a container's contents"
        },
        {
          "info": {
            "name": "Get a container content",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/containers/:container_id/contents/:containable_id",
            "params": [
              {
                "name": "container_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "containable_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get a container content"
        },
        {
          "info": {
            "name": "Update a container content",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/containers/:container_id/contents/:containable_id",
            "params": [
              {
                "name": "container_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "containable_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a container content"
        },
        {
          "info": {
            "name": "Delete a container content",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v2/containers/:container_id/contents/:containable_id",
            "params": [
              {
                "name": "container_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "containable_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a container content"
        },
        {
          "info": {
            "name": "Transfer into container",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers/:destination_container_id:transfer",
            "params": [
              {
                "name": "destination_container_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transfers a volume of an entity or container into a destination container.\nTransfering a volume is cumulative with the existing destination container's contents. To transfer an entire container's contents, the sourceContainerId should be specified. To otherwise transfer multiple entities within a container, you can make multiple calls to this endpoint, specifying a single entity with each call.\n"
        },
        {
          "info": {
            "name": "Archive containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:archive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive containers"
        },
        {
          "info": {
            "name": "Bulk create containers. Limit of 1000 containers per request.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:bulk-create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk create containers"
        },
        {
          "info": {
            "name": "Bulk get a set of containers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/containers:bulk-get",
            "params": [
              {
                "name": "containerIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of container IDs.\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": "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 a set of containers. Provide either containerIds or barcodes, not both."
        },
        {
          "info": {
            "name": "Bulk update containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:bulk-update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk update containers"
        },
        {
          "info": {
            "name": "Check in containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:check-in",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Check in containers to signify that they are available for use."
        },
        {
          "info": {
            "name": "Check out containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:check-out",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Check out containers to signify that they are in use."
        },
        {
          "info": {
            "name": "Print labels",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:print-labels",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Print labels. Supported print methods are \"REMOTE_PRINT_SERVER\", \"LEGACY_HTTP\", and \"LEGACY_TCP\"."
        },
        {
          "info": {
            "name": "Reserve containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:reserve",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reserve containers to signify that someone plans to use the containers."
        },
        {
          "info": {
            "name": "Unarchive containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/containers:unarchive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unarchive containers"
        },
        {
          "info": {
            "name": "Transfers into containers",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/transfers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transfers a volume of an entity or container into a destination container. Limit of 5000 transfers per request. Concentration of all contents in the destination container will be automatically updated based on the previous volume & concentrations of the contents in that container, the concentration of the contents being transferred in, the volume of the contents being transferred in, and the final volume of the container. If no concentration is specified, the concentration will not be tracked.\n"
        }
      ]
    }
  ],
  "bundled": true
}