{ "opencollection": "1.0.0", "info": { "name": "Benchling AA Sequences RNA Sequences API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/api/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "RNA Sequences", "type": "folder" }, "items": [ { "info": { "name": "List RNA sequences", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/rna-sequences", "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 name, modifiedAt, and createdAt. Optionally add :asc or :desc to specify ascending or descending order. Default is modifiedAt.\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 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 items to those with the specified archive reason. Use \"NOT_ARCHIVED\" to filter for unarchived RNA sequences. Use \"ANY_ARCHIVED\" to filter for archived RNA sequences 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, 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": "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": "customNotationId", "value": "", "type": "query", "description": "ID of the notation to use in populating the customNotation field." }, { "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**: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: \"rnaSequences.annotations.id\" will return the same as \"rnaSequences.annotations\".\n" } ] }, "docs": "List RNA sequences" }, { "info": { "name": "Create an RNA sequence", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences", "body": { "type": "json", "data": "{}" } }, "docs": "Create an RNA sequence" }, { "info": { "name": "Get an RNA sequence", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/rna-sequences/:rna_sequence_id", "params": [ { "name": "rna_sequence_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\n**Note**: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: \"annotations.id\" will return the same as \"annotations\".\n" }, { "name": "customNotationId", "value": "", "type": "query", "description": "ID of the notation to use in populating the customNotation field." } ] }, "docs": "Get an RNA sequence" }, { "info": { "name": "Update an RNA sequence", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/rna-sequences/:rna_sequence_id", "params": [ { "name": "rna_sequence_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an RNA sequence" }, { "info": { "name": "Archive RNA Sequences", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:archive", "body": { "type": "json", "data": "{}" } }, "docs": "Archive RNA Sequences. RNA sequences that are already registered will not be removed from the registry." }, { "info": { "name": "Auto-annotate RNA sequences with matching features from specified Feature Libraries", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:auto-annotate", "body": { "type": "json", "data": "{}" } }, "docs": "Auto-annotate RNA sequences with matching features from specified Feature Libraries. U/T bases are treated as interchangeable in both features and sequences." }, { "info": { "name": "Autofill RNA sequence parts", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:autofill-parts", "body": { "type": "json", "data": "{}" } }, "docs": "Autofill parts from matching RNA Sequences with linked schemas." }, { "info": { "name": "Autofill RNA sequence translations from Amino Acid sequences with matching schemas", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:autofill-translations", "body": { "type": "json", "data": "{}" } }, "docs": "Autofill RNA sequence translations" }, { "info": { "name": "Bulk Create RNA sequences", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:bulk-create", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Create RNA sequences. Limit of 1000 RNA Sequences per request." }, { "info": { "name": "Bulk get RNA sequences by ID", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/rna-sequences:bulk-get", "params": [ { "name": "rnaSequenceIds", "value": "", "type": "query", "description": "Comma-separated list of IDs of RNA sequences 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).\n\n**Note**: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: \"rnaSequences.annotations.id\" will return the same as \"rnaSequences.annotations\".\n" } ] }, "docs": "Bulk get RNA sequences by ID" }, { "info": { "name": "Bulk Update RNA sequences", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:bulk-update", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk Update RNA sequences" }, { "info": { "name": "Match RNA sequences by bases", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:match-bases", "body": { "type": "json", "data": "{}" } }, "docs": "Return RNA sequences whose bases exactly match the provided query." }, { "info": { "name": "Search RNA Sequences", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:search-bases", "body": { "type": "json", "data": "{}" } }, "docs": "Returns RNA Sequences that contain the provided bases. Search indexing is asynchronous, so results my be not be available immediately after creation.\n" }, { "info": { "name": "Unarchive RNA sequences", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/rna-sequences:unarchive", "body": { "type": "json", "data": "{}" } }, "docs": "Unarchive RNA sequences" } ] } ], "bundled": true }