{ "opencollection": "1.0.0", "info": { "name": "Benchling AA Sequences Assay Results API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/api/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Assay Results", "type": "folder" }, "items": [ { "info": { "name": "List results", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/assay-results", "params": [ { "name": "schemaId", "value": "", "type": "query", "description": "ID of the assay result schema to filter by" }, { "name": "createdAt.lt", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created before the specified time. e.g. < 2017-04-30.\n" }, { "name": "createdAt.gt", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created after the specified time. e.g. > 2017-04-30.\n" }, { "name": "createdAt.lte", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created on or before the specified time. e.g. <= 2017-04-30.\n" }, { "name": "createdAt.gte", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those created on or after the specified time. e.g. >= 2017-04-30.\n" }, { "name": "minCreatedTime", "value": "", "type": "query", "description": "Filter by results created after this unix timestamp" }, { "name": "maxCreatedTime", "value": "", "type": "query", "description": "Filter by results created before this unix timestamp" }, { "name": "sort", "value": "", "type": "query", "description": "Method by which to order search results. Valid sorts are createdAt (created time, oldest first). Use :asc or :desc to specify ascending or descending order. Default is createdAt:asc.\n" }, { "name": "nextToken", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results to return. Defaults to 50, maximum of 100." }, { "name": "entityIds", "value": "", "type": "query", "description": "Filter by comma-separated list of related Entity IDs, maximum of 20." }, { "name": "storageIds", "value": "", "type": "query", "description": "Filter by comma-separated list of related inventory (container, box, plate, or location) IDs, maximum of 20.\n" }, { "name": "assayRunIds", "value": "", "type": "query", "description": "Filter by comma-separated list of associated AssayRun IDs. At most one of {assayRunIds, automationOutputProcessorId} may be supplied." }, { "name": "automationOutputProcessorId", "value": "", "type": "query", "description": "Filter by Automation Output Processor ID. Either this or schemaId is required; if both are given, the associated schemas must match. At most one of {assayRunIds, automationOutputProcessorId} may be supplied." }, { "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": "modifiedAt.lt", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified before the specified time. e.g. < 2017-04-30.\n" }, { "name": "modifiedAt.gt", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified after the specified time. e.g. > 2017-04-30.\n" }, { "name": "modifiedAt.lte", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified on or before the specified time. e.g. <= 2017-04-30.\n" }, { "name": "modifiedAt.gte", "value": "", "type": "query", "description": "Datetime, in RFC 3339 format. Time zone defaults to UTC. Restricts results to those modified on or after the specified time. e.g. >= 2017-04-30.\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 Assay Results. Use \"ANY_ARCHIVED\" to filter for archived Assay Results regardless of reason. Use \"ANY_ARCHIVED_OR_NOT_ARCHIVED\" to return items for both archived and unarchived.\n" } ] }, "docs": "List results" }, { "info": { "name": "Create 1 or more results.", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/assay-results", "body": { "type": "json", "data": "{}" } }, "docs": "Create 1 or more results.\nIf you are looking to add results to a specific table in a notebook entry, please use the [assay-results bulk-create](#/Assay%20Results/bulkCreateAssayResults) endpoint instead.\n" }, { "info": { "name": "Get a result", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/assay-results/:assay_result_id", "params": [ { "name": "assay_result_id", "value": "", "type": "path" } ] }, "docs": "Get a result" }, { "info": { "name": "Archive 1 or more results.", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/assay-results:archive", "body": { "type": "json", "data": "{}" } }, "docs": "Results that have been added to a Legacy Result or Legacy Run table in a Notebook Entry **cannot** be Archived.\n" }, { "info": { "name": "Bulk create results", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/assay-results:bulk-create", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk create results. Limit of 4000 results per request." }, { "info": { "name": "Gets multiple results specified by a list of IDs.", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/assay-results:bulk-get", "params": [ { "name": "assayResultIds", "value": "", "type": "query", "description": "Comma-separated list of assay result IDs." } ] }, "docs": "Up to 200 IDs can be specified at once." }, { "info": { "name": "Unarchive 1 or more results.", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/assay-results:unarchive", "body": { "type": "json", "data": "{}" } }, "docs": "Unarchive 1 or more results." }, { "info": { "name": "Create a transaction", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/result-transactions" }, "docs": "Transactions allow results to be upload in multiple requests. This endpoint lets you create a transaction. You can then upload results to the transaction, abort the transaction, or commit the transaction.\n" }, { "info": { "name": "Create results in a transaction", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/result-transactions/:transaction_id/results", "params": [ { "name": "transaction_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create results in a transaction" }, { "info": { "name": "Abort a transaction", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/result-transactions/:transaction_id:abort", "params": [ { "name": "transaction_id", "value": "", "type": "path" } ] }, "docs": "Aborting a transaction will discard all uploaded results." }, { "info": { "name": "Commit a transaction", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/result-transactions/:transaction_id:commit", "params": [ { "name": "transaction_id", "value": "", "type": "path" } ] }, "docs": "Committing a transaction will cause all results that have been uploaded to be saved and visible to others." } ] } ], "bundled": true }