{ "opencollection": "1.0.0", "info": { "name": "HighBond API Reference Actions Analyses API", "version": "1.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Analyses", "type": "folder" }, "items": [ { "info": { "name": "List analyses inside a collection\n", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:collection_id/analyses", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "collection_id", "value": "", "type": "path", "description": "The ID of the collection." } ] }, "docs": "Get a list of all analyses inside a collection." }, { "info": { "name": "Create an analysis", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/collections/:collection_id/analyses", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "collection_id", "value": "", "type": "path", "description": "The ID of the collection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new analysis in an existing collection.\n\nLimitations:\n* Your organization can have a maximum of 2,000 analyses.\n" }, { "info": { "name": "Get an analysis", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/analyses/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." } ] }, "docs": "Get information about an analysis." }, { "info": { "name": "Update an analysis", "type": "http" }, "http": { "method": "PUT", "url": "{protocol}://{server}/v1/orgs/:org_id/analyses/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make changes to an analysis, like renaming it. You do not need to update analyses for them to reflect changes in data." }, { "info": { "name": "Delete an analysis", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{server}/v1/orgs/:org_id/analyses/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." } ] }, "docs": "Permanently delete an analysis.\n\n> **Caution —**\nDeleting an analysis also permanently removes tables associated with the analysis.\n" } ] } ], "bundled": true }