{ "opencollection": "1.0.0", "info": { "name": "BlueConic REST API v2 Audit Events Models API", "version": "100.0" }, "items": [ { "info": { "name": "Models", "type": "folder" }, "items": [ { "info": { "name": "Get all models", "type": "http" }, "http": { "method": "GET", "url": "https://{blueconicHostname}/rest/v2/models", "params": [ { "name": "count", "value": "", "type": "query", "description": "Specifies the number of results to return." }, { "name": "startIndex", "value": "", "type": "query", "description": "Specifies the index of the first item to include in the result." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/rest/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves all models (without the model binaries)." }, { "info": { "name": "Create model", "type": "http" }, "http": { "method": "POST", "url": "https://{blueconicHostname}/rest/v2/models", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/rest/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a model." }, { "info": { "name": "Get one model", "type": "http" }, "http": { "method": "GET", "url": "https://{blueconicHostname}/rest/v2/models/:model", "params": [ { "name": "model", "value": "", "type": "path", "description": "The ID of the model." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/rest/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves a single model (without the model binary)." }, { "info": { "name": "Update model", "type": "http" }, "http": { "method": "PUT", "url": "https://{blueconicHostname}/rest/v2/models/:model", "params": [ { "name": "model", "value": "", "type": "path", "description": "The ID of the model to update." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/rest/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a model by id." }, { "info": { "name": "Delete model", "type": "http" }, "http": { "method": "DELETE", "url": "https://{blueconicHostname}/rest/v2/models/:model", "params": [ { "name": "model", "value": "", "type": "path", "description": "The ID of the model to delete." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/rest/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete a model by id." }, { "info": { "name": "Get model binary", "type": "http" }, "http": { "method": "GET", "url": "https://{blueconicHostname}/rest/v2/models/:model/model", "params": [ { "name": "model", "value": "", "type": "path", "description": "The ID of the model." }, { "name": "etag", "value": "", "type": "query", "description": "The etag of the model. Can be used to do a conditional request, as alternative to using the `If-None-Match` header." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "/rest/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves the model binary if set, HTTP 404 otherwise. The response will contain an `Etag` header with the hash of the model, which can be used to perform a conditional request." } ] } ], "bundled": true }