{
  "opencollection": "1.0.0",
  "info": {
    "name": "Benchling AA Sequences Custom Entities API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/api/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Custom Entities",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List custom entities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/custom-entities",
            "params": [
              {
                "name": "nextToken",
                "value": "",
                "type": "query"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query"
              },
              {
                "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 custom entity. Restricts results to those with the specified name, alias, or entity registry ID."
              },
              {
                "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)."
              },
              {
                "name": "nameIncludes",
                "value": "",
                "type": "query",
                "description": "Name substring of a custom entity. Restricts results to those with names, aliases, or entity registry IDs that include the provided substring.\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 custom entities 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 custom entities. Use \"ANY_ARCHIVED\" to filter for archived custom entities 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 resource 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": "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": "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": "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."
              }
            ]
          },
          "docs": "List custom entities"
        },
        {
          "info": {
            "name": "Create a custom entity",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/custom-entities",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a custom entity"
        },
        {
          "info": {
            "name": "Get a custom entity",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/custom-entities/:custom_entity_id",
            "params": [
              {
                "name": "custom_entity_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 custom entity"
        },
        {
          "info": {
            "name": "Update a custom entity",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/custom-entities/:custom_entity_id",
            "params": [
              {
                "name": "custom_entity_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a custom entity"
        },
        {
          "info": {
            "name": "Create or update a registered custom entity",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v2/custom-entities/:entity_registry_id:upsert",
            "params": [
              {
                "name": "entity_registry_id",
                "value": "entity_registry_id_001",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update a registered custom entity.\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 custom entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/custom-entities:archive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive custom entities"
        },
        {
          "info": {
            "name": "Bulk Create custom entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/custom-entities:bulk-create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk Create custom entities. Limit of 2500 custom entities per request."
        },
        {
          "info": {
            "name": "Bulk get custom entities by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v2/custom-entities:bulk-get",
            "params": [
              {
                "name": "customEntityIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of IDs of custom entities 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 custom entities by ID"
        },
        {
          "info": {
            "name": "Bulk Update custom entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/custom-entities:bulk-update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk Update custom entities"
        },
        {
          "info": {
            "name": "Bulk upsert custom entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/custom-entities:bulk-upsert",
            "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": "Unarchive custom entities",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v2/custom-entities:unarchive",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Unarchive custom entities"
        }
      ]
    }
  ],
  "bundled": true
}