{ "opencollection": "1.0.0", "info": { "name": "Benchling AA Sequences Molecules API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/api/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Molecules", "type": "folder" }, "items": [ { "info": { "name": "List Molecules", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/molecules", "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": "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 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 = 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 results to those with the specified archive reason. Use \"NOT_ARCHIVED\" to filter for unarchived Molecules. Use \"ANY_ARCHIVED\" to filter for archived Molecules 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.\n" }, { "name": "authorIds.anyOf", "value": "", "type": "query", "description": "Comma separated list of user or app IDs. Maximum of 100." }, { "name": "chemicalSubstructure.mol", "value": "", "type": "query", "description": "mol-formatted string for a chemical substructure to search by" }, { "name": "chemicalSubstructure.smiles", "value": "", "type": "query", "description": "SMILES string for a chemical substructure to search by" } ] }, "docs": "List molecules" }, { "info": { "name": "Create a Molecule", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/molecules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Molecule" }, { "info": { "name": "Create or update a registered Molecule", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/molecules/:entity_registry_id:upsert", "params": [ { "name": "entity_registry_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update a registered Molecule.\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": "Get a Molecule", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/molecules/:molecule_id", "params": [ { "name": "molecule_id", "value": "", "type": "path" } ] }, "docs": "Get a Molecule" }, { "info": { "name": "Update a Molecule", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/molecules/:molecule_id", "params": [ { "name": "molecule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Molecule" }, { "info": { "name": "Archive Molecules", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/molecules:archive", "body": { "type": "json", "data": "{}" } }, "docs": "Archive Molecules" }, { "info": { "name": "Bulk Create Molecules", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/molecules:bulk-create", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Create Molecules" }, { "info": { "name": "Bulk Update Molecules", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/molecules:bulk-update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update Molecules" }, { "info": { "name": "Bulk upsert Molecules", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/molecules:bulk-upsert", "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": "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 Molecules", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/molecules:unarchive", "body": { "type": "json", "data": "{}" } }, "docs": "Unarchive Molecules" } ] } ], "bundled": true }