{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Entries API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Entries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List entries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/entries",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return. Defaults to 50, maximum of 100."
              },
              {
                "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 modifiedAt (modified time, most recent first) and name (entity name, alphabetical). Optionally add :asc or :desc to specify ascending or descending order.\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 an Entry. Restricts results to those with the specified name."
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "ID of a project. Restricts results to those in the project."
              },
              {
                "name": "archiveReason",
                "value": "",
                "type": "query",
                "description": "Archive reason. Restricts items to those with the specified archive reason. Use \"NOT_ARCHIVED\" to filter for unarchived entries. Use \"ANY_ARCHIVED\" to filter for archived entries regardless of reason. Use \"ANY_ARCHIVED_OR_NOT_ARCHIVED\" to return items for both archived and unarchived.\n"
              },
              {
                "name": "reviewStatus",
                "value": "",
                "type": "query",
                "description": "Restrict results to those with the given review status. Supported statuses: IN_PROGRESS, ACCEPTED, REJECTED, NEEDS_REVIEW, RETRACTED\n"
              },
              {
                "name": "mentionedIn",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of entry IDs. Restricts results to those mentioned within the entries in this list.\n"
              },
              {
                "name": "mentions",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of resource IDs. Restricts results to entries that mention the given items.\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": "schemaId",
                "value": "",
                "type": "query",
                "description": "ID of a schema. Restricts results to those of the specified schema.\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": "assignedReviewerIds.anyOf",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of ids. Restricts results to entries that have assignees of any of the specified ids."
              },
              {
                "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": "displayIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of Entry Display 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).\n\n**Note:** \"entries.days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"entries.days.notes.text\" will return the same model as \"entries.days.notes\".\n"
              }
            ]
          },
          "docs": "List notebook entries"
        },
        {
          "info": {
            "name": "Create a notebook entry",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/entries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a notebook entry"
        },
        {
          "info": {
            "name": "Get a notebook entry by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/entries/:entry_id",
            "params": [
              {
                "name": "entry_id",
                "value": "",
                "type": "path",
                "description": "ID of the entry"
              },
              {
                "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:** \"days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"days.notes.text\" will return the same model as \"days.notes\".\n"
              }
            ]
          },
          "docs": "Get a notebook entry by ID"
        },
        {
          "info": {
            "name": "Update a notebook entry's metadata",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/entries/:entry_id",
            "params": [
              {
                "name": "entry_id",
                "value": "",
                "type": "path",
                "description": "ID of the entry"
              },
              {
                "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:** \"days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"days.notes.text\" will return the same model as \"days.notes\".\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a notebook entry's metadata"
        },
        {
          "info": {
            "name": "Retrieves the metadata for an external file. Use the 'downloadURL' to download the actual file.\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/entries/:entry_id/external-files/:external_file_id",
            "params": [
              {
                "name": "entry_id",
                "value": "",
                "type": "path",
                "description": "ID of the entry the file was uploaded to"
              },
              {
                "name": "external_file_id",
                "value": "",
                "type": "path",
                "description": "ID of the external file"
              }
            ]
          },
          "docs": "Retrieves the metadata for an external file. Use the 'downloadURL' to download the actual file. (Expand the schema view for details)\n"
        },
        {
          "info": {
            "name": "Archive notebook entries",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/entries:archive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive notebook entries"
        },
        {
          "info": {
            "name": "Get notebook entries using entry IDs or display IDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/entries:bulk-get",
            "params": [
              {
                "name": "entryIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of Entry IDs."
              },
              {
                "name": "displayIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of Entry Display 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).\n\n**Note:** \"entries.days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"entries.days.notes.text\" will return the same model as \"entries.days.notes\".\n"
              }
            ]
          },
          "docs": "Get notebook entries using entry IDs or display IDs"
        },
        {
          "info": {
            "name": "Unarchive notebook entries",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/entries:unarchive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unarchive notebook entries"
        },
        {
          "info": {
            "name": "List entry templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/entry-templates",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return. Defaults to 50, maximum of 100."
              },
              {
                "name": "nextToken",
                "value": "",
                "type": "query",
                "description": "Token for pagination"
              },
              {
                "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 Entry Template. Restricts results to those with the specified name."
              },
              {
                "name": "templateCollectionId",
                "value": "",
                "type": "query",
                "description": "ID of a template collection. Resticts results to those in the template collection.\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": "schemaId",
                "value": "",
                "type": "query",
                "description": "ID of a schema. Restricts results to those of the specified schema.\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:** \"entryTemplates.days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"entryTemplates.days.notes.text\" will return the same model as \"entryTemplates.days.notes\".\n"
              }
            ]
          },
          "docs": "List entry templates"
        },
        {
          "info": {
            "name": "Get a notebook template entry by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/entry-templates/:entry_template_id",
            "params": [
              {
                "name": "entry_template_id",
                "value": "",
                "type": "path",
                "description": "ID of the entry template"
              },
              {
                "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:** \"days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"days.notes.text\" will return the same model as \"days.notes\".\n"
              }
            ]
          },
          "docs": "Get a notebook template entry by ID"
        },
        {
          "info": {
            "name": "Update a notebook template entry's metadata",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/entry-templates/:entry_template_id",
            "params": [
              {
                "name": "entry_template_id",
                "value": "",
                "type": "path",
                "description": "ID of the template entry"
              },
              {
                "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:** \"days.notes\" cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g., \"days.notes.text\" will return the same model as \"days.notes\".\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a notebook template entry's metadata"
        }
      ]
    }
  ],
  "bundled": true
}