{ "openapi" : "3.0.1", "info" : { "title" : "User Management API", "description" : "Manage users", "version" : "2.0" }, "tags" : [ { "name" : "Action Management API", "description" : "Manage action API to be used in alert and report" }, { "name" : "Authentication Management API", "description" : "Authentication API to be authenticate to management API" }, { "name" : "Category Management API", "description" : "Manage categories" }, { "name" : "Datasource Management API", "description" : "Manage datasources" }, { "name" : "Group Management API", "description" : "Manage user group" }, { "name" : "KPI Management API", "description" : "Manage KPI" }, { "name" : "Natural Language Processing Management API", "description" : "Manage and access NLP functionalities" }, { "name" : "Report Management API", "description" : "Manage reports" }, { "name" : "Role Management API", "description" : "Manage roles" }, { "name" : "User Management API", "description" : "Manage users" } ], "paths" : { "/api/2.0/actions/slacks" : { "get" : { "tags" : [ "Action Management API" ], "summary" : "List accessible Slack actions", "operationId" : "listSlack", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertActionApi" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Action Management API" ], "summary" : "Create a new Slack action", "operationId" : "createSlack", "requestBody" : { "description" : "Slack action information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/actions/teams" : { "get" : { "tags" : [ "Action Management API" ], "summary" : "List accessible Teams actions", "operationId" : "listTeams", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertActionApi" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Action Management API" ], "summary" : "Create a new Teams action", "operationId" : "createTeams", "requestBody" : { "description" : "Teams action information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/actions/webhooks" : { "get" : { "tags" : [ "Action Management API" ], "summary" : "List accessible Webhook actions", "operationId" : "listWebhook", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WebhookActionApi" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Action Management API" ], "summary" : "Create a new Webhook action", "operationId" : "createWebhook", "requestBody" : { "description" : "Webhook action information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookActionApi" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/actions/slacks/{objectId}" : { "get" : { "tags" : [ "Action Management API" ], "summary" : "Retrieve Slack action by ID", "operationId" : "findSlack", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Action ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Action Management API" ], "summary" : "Update existing Slack action", "operationId" : "editSlack", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Action ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Slack action information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/actions/teams/{objectId}" : { "get" : { "tags" : [ "Action Management API" ], "summary" : "Retrieve Teams action by ID", "operationId" : "findTeams", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Action ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Action Management API" ], "summary" : "Update existing Teams action", "operationId" : "editTeams", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Action ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Teams action information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AlertActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/actions/webhooks/{objectId}" : { "get" : { "tags" : [ "Action Management API" ], "summary" : "Retrieve Webhook action by ID", "operationId" : "findWebhook", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Action ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Action Management API" ], "summary" : "Update existing Webhook action", "operationId" : "editWebhook", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Action ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Webhook action information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookActionApi" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookActionApi" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts/{objectId}/shares" : { "get" : { "summary" : "List share information for alert", "operationId" : "listShares", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to retrieve sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "summary" : "Add share information for alert", "operationId" : "addShares", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to add sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "List of share information to be set", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "summary" : "Set share information for alert", "operationId" : "setShares", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to set sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "List of share information to be set", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "summary" : "Clear share information for alert", "operationId" : "deleteShares", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to add sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts" : { "get" : { "summary" : "List accessible alerts", "operationId" : "list", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DatasetAlert" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "summary" : "Create new alert", "operationId" : "create", "requestBody" : { "description" : "Alert information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts/{objectId}" : { "get" : { "summary" : "Retrieve an alert with specific ID", "operationId" : "view", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "summary" : "Update existing alert with input information. If not specified in the input, the existing value will be kept intact", "operationId" : "edit", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Report information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "summary" : "Delete existing report with given ID", "operationId" : "delete", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to be deleted", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts/pause" : { "post" : { "summary" : "Pause alert with specific ID", "operationId" : "pause", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to be paused", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts/preview" : { "post" : { "summary" : "Preview alert widget", "operationId" : "preview", "requestBody" : { "description" : "Alert information to be previewed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Widget" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts/run" : { "post" : { "summary" : "Execute alert", "operationId" : "run", "requestBody" : { "description" : "Alert information to be executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DatasetAlert" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExecutionReport" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/alerts/unpause" : { "post" : { "summary" : "Resume paused alert with specific ID", "operationId" : "unpause", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Alert ID to be un-paused", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/login" : { "post" : { "tags" : [ "Authentication Management API" ], "summary" : "Authentication to Management API", "operationId" : "login", "requestBody" : { "description" : "Authentication info including client ID and client secret", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Credential" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccessToken" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } } } }, "/api/2.0/logout" : { "delete" : { "tags" : [ "Authentication Management API" ], "summary" : "Logout of management API", "description" : "CURL Example:\n\n\tcurl -i -X DELETE \\\n\t\t-H \"Authorization: Bearer \" \\\n\t\t/api/2.0/logout", "operationId" : "logout", "requestBody" : { "description" : "Authentication info including client ID and client secret", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Credential" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } } } }, "/api/2.0/category/assets/add" : { "post" : { "tags" : [ "Category Management API" ], "summary" : "Add asset to existing category", "operationId" : "addAssetToCategory", "requestBody" : { "description" : "Category asset request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryAssetRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/category" : { "get" : { "tags" : [ "Category Management API" ], "summary" : "List accessible categories", "operationId" : "listCategories", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Category Management API" ], "summary" : "Create new category", "operationId" : "createCategory", "requestBody" : { "description" : "Category information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/category/{objectId}" : { "get" : { "tags" : [ "Category Management API" ], "summary" : "Retrieve a category with specific ID", "operationId" : "viewCategory", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Category ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Category Management API" ], "summary" : "Update existing category with input information. If not specified in the input, the existing value will be kept intact", "operationId" : "editCategory", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Category ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Category information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "tags" : [ "Category Management API" ], "summary" : "Delete existing category with given ID", "operationId" : "deleteCategory", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Category ID to be deleted", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/category/assets/remove" : { "post" : { "tags" : [ "Category Management API" ], "summary" : "Remove asset from existing category", "operationId" : "removeAssetFromCategory", "requestBody" : { "description" : "Category asset request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CategoryAssetRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/category/search" : { "get" : { "tags" : [ "Category Management API" ], "summary" : "Search categories", "operationId" : "searchUsers", "parameters" : [ { "name" : "name", "in" : "query", "description" : "Category name", "schema" : { "type" : "string" } }, { "name" : "objectType", "in" : "query", "description" : "Category object type", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "parentId", "in" : "query", "description" : "Category parent ID", "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryTreeItem" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/datasources/{objectId}/shares" : { "get" : { "tags" : [ "Datasource Management API" ], "summary" : "List share information for datasource", "operationId" : "listShares_1", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Datasource ID to retrieve sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Datasource Management API" ], "summary" : "Add share information for datasource", "operationId" : "addShares_1", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Datasource ID to add sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "List of share information to be set", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Datasource Management API" ], "summary" : "Set share information for datasource", "operationId" : "setShares_1", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Datasource ID to set sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "List of share information to be set", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/datasources" : { "get" : { "tags" : [ "Datasource Management API" ], "summary" : "List accessible datasources", "operationId" : "listDatasources", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConnectorDatasource" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "summary" : "Create a new datasource", "operationId" : "createDatasource", "requestBody" : { "description" : "Create a new datasource", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/MongoDBDatasource" }, { "$ref" : "#/components/schemas/MySQLDBDatasource" } ] } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectorDatasource" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/datasources/{objectId}" : { "get" : { "tags" : [ "Datasource Management API" ], "summary" : "Retrieve a datasource with specific ID", "operationId" : "viewDatasource", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Datasource ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/MongoDBDatasource" }, { "$ref" : "#/components/schemas/MySQLDBDatasource" } ] } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/groups" : { "get" : { "tags" : [ "Group Management API" ], "summary" : "List accessible groups", "operationId" : "listGroups", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserGroup" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Group Management API" ], "summary" : "Create new group", "operationId" : "createGroup", "requestBody" : { "description" : "Group information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserGroup" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserGroup" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/groups/{objectId}" : { "get" : { "tags" : [ "Group Management API" ], "summary" : "Retrieve a group with specific ID", "operationId" : "viewGroup", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Group ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserGroup" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Group Management API" ], "summary" : "Update existing group with input information. If not specified in the input, the existing value will be kept intact", "operationId" : "editGroup", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Group ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Group information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserGroup" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserGroup" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "tags" : [ "Group Management API" ], "summary" : "Delete existing group with given ID", "operationId" : "deleteGroup", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Group ID to be deleted", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/groups/{objectId}/assets" : { "get" : { "tags" : [ "Group Management API" ], "summary" : "Retrieve list of assets shared to a group with specific ID.", "operationId" : "listGroupAssets", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Group ID to retrieve list of shared assets", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupAsset" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/groups/{objectId}/autoShares" : { "get" : { "tags" : [ "Group Management API" ], "summary" : "Retrieve list of users with assets automatically shared to a group with specific ID.", "operationId" : "listGroupAutoShares", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Group ID to retrieve list of users", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/groups/{objectId}/users" : { "get" : { "tags" : [ "Group Management API" ], "summary" : "Retrieve list of users in a group with specific group ID.", "operationId" : "listGroupUsers", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Group ID to retrieve list of users", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check all KPIs", "operationId" : "checkAll", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPIAll" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkDashboardLoad" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check dashboard load KPI", "operationId" : "checkDashboardLoad", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkHostedConnector" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check HostedConnector KPI", "operationId" : "checkHostedConnector", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkMessageMQ" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check MessageMQ KPI", "operationId" : "checkMessageMQ", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkMongoDB" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check MongoDB KPI", "operationId" : "checkMongoDB", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkMongoReplicaSetStatus" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check mongo replica set status KPI", "operationId" : "checkMongoReplicaSetStatus", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkMySQL" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check MySQL KPI", "operationId" : "checkMySQL", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkQueryPreview" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check query preview KPI", "operationId" : "checkQueryPreview", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkQuerySaveAndRunNow" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check query save and run KPI", "operationId" : "checkQuerySaveAndRunNow", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/kpi/checkWidgetLoad" : { "get" : { "tags" : [ "KPI Management API" ], "summary" : "Check widget load KPI", "operationId" : "checkWidgetLoad", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/KPI" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/nlp/{objectId}/run" : { "post" : { "tags" : [ "Natural Language Processing Management API" ], "summary" : "Execute NLP query against a dataset", "operationId" : "runQuery", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Dataset ID to apply NLP query on", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "NLP query info to to applied to the specified dataset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NlpQuery" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NlpData" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/nlp/suggestions" : { "post" : { "tags" : [ "Natural Language Processing Management API" ], "summary" : "Get suggestions with matching datasets for an NLP query", "operationId" : "suggestions", "requestBody" : { "description" : "NLP query info to get suggestions for", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NlpQuery" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NlpSuggestion" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/reports/{objectId}/shares" : { "get" : { "tags" : [ "Report Management API" ], "summary" : "List share information for report", "operationId" : "listShares_2", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to retrieve sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Report Management API" ], "summary" : "Add share information for report", "operationId" : "addShares_2", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to add sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "List of share information to be set", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Report Management API" ], "summary" : "Set share information for report", "operationId" : "setShares_2", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to set sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "List of share information to be set", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ShareInfo" } } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "tags" : [ "Report Management API" ], "summary" : "Clear share information for report", "operationId" : "deleteShares_1", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to add sharing information for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/reports" : { "get" : { "tags" : [ "Report Management API" ], "summary" : "List accessible reports", "operationId" : "listReports", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmailReport" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "Report Management API" ], "summary" : "Create new report", "operationId" : "createReport", "requestBody" : { "description" : "Report information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailReport" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailReport" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/reports/{objectId}" : { "get" : { "tags" : [ "Report Management API" ], "summary" : "Retrieve a report with specific ID", "operationId" : "viewReport", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailReport" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "Report Management API" ], "summary" : "Update existing report with input information. If not specified in the input, the existing value will be kept intact", "operationId" : "editReport", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Report information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailReport" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailReport" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "tags" : [ "Report Management API" ], "summary" : "Delete existing report with given ID", "operationId" : "deleteReport", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to be deleted", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/reports/run" : { "post" : { "tags" : [ "Report Management API" ], "summary" : "Execute report", "operationId" : "runReport", "requestBody" : { "description" : "Report information to be executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailReport" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExecutionReport" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/reports/{objectId}/run" : { "post" : { "tags" : [ "Report Management API" ], "summary" : "Execute saved report with optional recipient, subject, and message overrides", "operationId" : "runSavedReport", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Report ID to be executed", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Optional overrides for recipients, subject, and message", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RunReportRequest" } } } }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExecutionReport" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/roles" : { "get" : { "tags" : [ "Role Management API" ], "summary" : "List roles", "operationId" : "listRoles", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Role" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/roles/{objectId}" : { "get" : { "tags" : [ "Role Management API" ], "summary" : "Retrieve a role with specific ID", "operationId" : "viewRole", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "Role ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/users/{objectId}/groups" : { "get" : { "tags" : [ "User Management API" ], "summary" : "Retrieve groups for user with specific ID", "operationId" : "listUserGroups", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "User ID to retrieve groups for", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UserGroup" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "User Management API" ], "summary" : "Add groups for user with specific IDs", "operationId" : "addUserGroups", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "User ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Group IDs to be set", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "User Management API" ], "summary" : "Set groups for user with specific IDs", "operationId" : "setUserGroups", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "User ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "Group IDs to be set", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/users" : { "get" : { "tags" : [ "User Management API" ], "summary" : "List users", "operationId" : "listUsers", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "post" : { "tags" : [ "User Management API" ], "summary" : "Create new user", "operationId" : "createUser", "requestBody" : { "description" : "User information to be created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/users/{objectId}" : { "get" : { "tags" : [ "User Management API" ], "summary" : "Retrieve a user with specific ID", "operationId" : "viewUser", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "User ID to be retrieved", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "put" : { "tags" : [ "User Management API" ], "summary" : "Update user with input information. If not specified in the input, the existing value will be kept intact", "operationId" : "editUser", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "User ID to be updated", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "description" : "User information to be updated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } } }, "400" : { "description" : "Bad request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] }, "delete" : { "tags" : [ "User Management API" ], "summary" : "Delete existing user with given ID", "operationId" : "deleteUser", "parameters" : [ { "name" : "objectId", "in" : "path", "description" : "User ID to be deleted", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/users/search" : { "get" : { "tags" : [ "User Management API" ], "summary" : "Search users", "operationId" : "searchUsers_1", "parameters" : [ { "name" : "username", "in" : "query", "description" : "Username to search by", "schema" : { "type" : "string" } }, { "name" : "name", "in" : "query", "description" : "Name to search by", "schema" : { "type" : "string" } }, { "name" : "phone", "in" : "query", "description" : "Phone to search by", "schema" : { "type" : "string" } }, { "name" : "email", "in" : "query", "description" : "Email to search by", "schema" : { "type" : "string" } }, { "name" : "userType", "in" : "query", "description" : "User type to search by", "schema" : { "type" : "string" }, "example" : "REGULAR, SSO, EXTERNAL" } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/User" } } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } }, "/api/2.0/users/assets/transfer" : { "post" : { "tags" : [ "User Management API" ], "summary" : "Transfers assets from one user to another", "operationId" : "transferAssets", "requestBody" : { "description" : "Transfer request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransferRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "401" : { "description" : "User is not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "403" : { "description" : "User is not allowed to access this resource", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } }, "500" : { "description" : "Error during processing", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiMessage" } } } } }, "security" : [ { "Authorization" : [ ] } ] } } }, "components" : { "schemas" : { "AlertActionApi" : { "required" : [ "name" ], "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Action ID", "format" : "int64", "readOnly" : true }, "userId" : { "type" : "integer", "description" : "Action owner's user ID", "format" : "int64", "readOnly" : true }, "actionType" : { "type" : "string", "description" : "Action type", "readOnly" : true, "example" : "SLACK, TEAMS, WEBHOOK" }, "name" : { "type" : "string", "description" : "Action name" }, "channels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AlertChannel" } }, "message" : { "type" : "string", "description" : "Action message" }, "eachRowOfDataAsMessage" : { "type" : "boolean", "description" : "Whether or not to send a separate message for each row of the data" }, "botAccessToken" : { "type" : "string", "description" : "Service access token" }, "teamId" : { "type" : "string", "description" : "Service team ID" }, "teamName" : { "type" : "string", "description" : "Service team Name used for display purpose" }, "botClientId" : { "type" : "integer", "description" : "Service client ID", "format" : "int64" }, "channel" : { "$ref" : "#/components/schemas/AlertChannel" } }, "description" : "Action API for messaging platform such as Teams and Slack" }, "AlertChannel" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Channel ID" }, "name" : { "type" : "string", "description" : "Channel name" }, "privateChannel" : { "type" : "boolean", "description" : "Whether or not this channel is private" } }, "description" : "Action API channel" }, "ApiMessage" : { "type" : "object", "properties" : { "message" : { "type" : "string", "description" : "Message", "readOnly" : true }, "documentation" : { "type" : "string", "description" : "Link to documentation", "readOnly" : true } }, "description" : "Response status" }, "WebhookActionApi" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Action ID", "format" : "int64", "readOnly" : true }, "userId" : { "type" : "integer", "description" : "Action owner's user ID", "format" : "int64", "readOnly" : true }, "actionType" : { "type" : "string", "description" : "Action type", "readOnly" : true, "example" : "SLACK, TEAMS, WEBHOOK" }, "dataFormat" : { "type" : "string", "description" : "Webhook data format", "enum" : [ "attachment", "json" ] }, "url" : { "type" : "string", "description" : "Webhook request URL" }, "authUrl" : { "type" : "string", "description" : "Webhook authentication URL" }, "authHeaders" : { "type" : "string", "description" : "Webhook authentication headers" }, "webhookHeaders" : { "type" : "string", "description" : "Webhook request headers" }, "customPostBody" : { "type" : "string", "description" : "Webhook request post body" }, "name" : { "type" : "string", "description" : "Webhook action name" } }, "description" : "Action API for Webhook" }, "ShareInfo" : { "required" : [ "accessLevel", "type" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "ID of user or group to be shared to", "format" : "int64" }, "type" : { "type" : "string", "description" : "Share type", "example" : "Users,Groups" }, "accessLevel" : { "type" : "integer", "description" : "Share access level", "format" : "int32" }, "name" : { "type" : "string", "description" : "Username + name or group name to be shared to. When sharing to a user, either id field or the combination of name, externalAuthId, and ssoUser have to be specified" }, "externalAuthId" : { "type" : "integer", "description" : "External authenticate ID to be shared to", "format" : "int64" }, "ssoUser" : { "type" : "boolean", "description" : "Whether or not user is SSO user" }, "access_level" : { "type" : "integer", "format" : "int32", "writeOnly" : true }, "external_auth_id" : { "type" : "integer", "format" : "int64", "writeOnly" : true }, "sso_user" : { "type" : "boolean", "writeOnly" : true } }, "description" : "Sharing information" }, "ActionApiResponse" : { "type" : "object", "properties" : { "ok" : { "type" : "boolean", "description" : "Whether or not the response is a success", "readOnly" : true }, "channel" : { "type" : "string", "description" : "Channel", "readOnly" : true, "enum" : [ "EMAIL", "WEBHOOK", "SLACK", "TEAMS" ] }, "message" : { "type" : "string", "description" : "Action result details message", "readOnly" : true } }, "description" : "Action information", "readOnly" : true }, "AttachmentConfig" : { "type" : "object", "properties" : { "datasetId" : { "type" : "integer", "description" : "Dataset ID to replace the alert's dataset ID for attachment", "format" : "int64" }, "query" : { "type" : "string", "description" : "Additional C9QL to be applied prior to attachment" } }, "description" : "Attachment config" }, "DashboardPdfInfo" : { "type" : "object", "properties" : { "dashboardPdfId" : { "type" : "integer", "description" : "Additional C9QL to be applied prior to attachment", "format" : "int64" } }, "description" : "Dashboard PDF information" }, "DatasetAlert" : { "required" : [ "properties" ], "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Alert ID", "format" : "int64", "readOnly" : true }, "datasetId" : { "type" : "integer", "description" : "Dataset ID", "format" : "int64" }, "lastAlert" : { "type" : "string", "description" : "Last alert date", "format" : "date-time", "readOnly" : true }, "userId" : { "type" : "integer", "description" : "Alert owner's user ID", "format" : "int64", "readOnly" : true }, "status" : { "type" : "integer", "description" : "Alert status", "format" : "int32", "readOnly" : true }, "alertCondition" : { "type" : "string", "description" : "Alert condition for conditional alert type" }, "alertName" : { "type" : "string", "description" : "Alert name" }, "alertType" : { "type" : "integer", "description" : "Alert type", "format" : "int32" }, "accessLevel" : { "type" : "integer", "description" : "Access level of the alert for current user", "format" : "int32", "readOnly" : true }, "autoShared" : { "type" : "boolean", "description" : "Is alert auto-shared on", "readOnly" : true }, "schedule" : { "$ref" : "#/components/schemas/Schedule" }, "realtime" : { "type" : "boolean", "description" : "Whether or not this alert is real-time alert" }, "executionReport" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/ExecutionReport" } }, "firedCount" : { "type" : "integer", "description" : "Number of times this alert has been triggered", "format" : "int64", "readOnly" : true }, "createdBy" : { "type" : "string", "description" : "Alert owner's username", "readOnly" : true }, "deletable" : { "type" : "boolean", "description" : "Whether or not the current user has deletion right to the alert", "readOnly" : true }, "chartId" : { "type" : "integer", "description" : "Widget ID", "format" : "int64" }, "properties" : { "$ref" : "#/components/schemas/DatasetAlertProperties" } }, "description" : "Alert information" }, "DatasetAlertProperties" : { "type" : "object", "properties" : { "emailOutput" : { "$ref" : "#/components/schemas/EmailOutput" }, "webhookOutput" : { "$ref" : "#/components/schemas/WebhookOutput" }, "slackOutput" : { "$ref" : "#/components/schemas/SlackOutput" }, "teamsOutput" : { "$ref" : "#/components/schemas/TeamsOutput" }, "dashboardPdfInfo" : { "$ref" : "#/components/schemas/DashboardPdfInfo" }, "alertIfNoData" : { "type" : "boolean", "description" : "Whether or not to send alert of there is no data returned" }, "skipSameAlert" : { "type" : "boolean", "description" : "Whether or not to send alert if data is the same as previous alert" }, "attachDataset" : { "type" : "boolean", "description" : "Whether or not to attach raw dataset data" }, "attachAlertData" : { "type" : "boolean", "description" : "Whether or not to attach raw dataset data" }, "attachmentConfig" : { "$ref" : "#/components/schemas/AttachmentConfig" }, "anomalyId" : { "type" : "integer", "description" : "Anomaly definition ID", "format" : "int64" }, "anomalyLookBack" : { "type" : "string", "description" : "Anomaly lookback period" }, "frequencyMarker" : { "type" : "string", "description" : "Alert frequency in minutes or \"custom\"" }, "operator" : { "type" : "string", "description" : "Alert/anomaly condition operator" }, "metric" : { "type" : "string", "description" : "Alert/anomaly metric field" }, "dimension" : { "type" : "string", "description" : "Anomaly dimension field" }, "threshold" : { "type" : "string", "description" : "Alert/anomaly threshold value" }, "dateTime" : { "type" : "string", "description" : "Anomaly date/time field" }, "alertContentFilters" : { "type" : "array", "description" : "Alert content filters", "items" : { "$ref" : "#/components/schemas/Filter" } } }, "description" : "Alert properties" }, "EmailOutput" : { "type" : "object", "properties" : { "from" : { "type" : "string", "description" : "Email from" }, "replyTo" : { "type" : "string", "description" : "Email reply to" }, "sendTo" : { "type" : "string", "description" : "Email send to" }, "cc" : { "type" : "string", "description" : "Email cc" }, "bcc" : { "type" : "string", "description" : "Email bcc" }, "emailSubject" : { "type" : "string", "description" : "Email subject" }, "emailBody" : { "type" : "string", "description" : "Email body" } }, "description" : "Email output properties" }, "ExecutionReport" : { "type" : "object", "properties" : { "executionDate" : { "type" : "integer", "description" : "Date in milliseconds", "format" : "int64", "readOnly" : true }, "executionStatus" : { "type" : "string", "description" : "Status", "readOnly" : true, "enum" : [ "UNKNOWN", "RUNNING", "SUCCESS", "FAILURE", "ALERT", "TIMEOUT" ] }, "duration" : { "type" : "integer", "description" : "Duration", "format" : "int64", "readOnly" : true }, "details" : { "type" : "array", "description" : "Details", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/ActionApiResponse" } } }, "description" : "Email execution report", "readOnly" : true }, "Filter" : { "required" : [ "fieldName", "fieldNames" ], "type" : "object", "properties" : { "fieldName" : { "type" : "string", "description" : "Filter field name. Either fieldName or fieldNames has to be not empty" }, "fieldNames" : { "type" : "array", "description" : "Filter field names in case of tree filter. Either fieldName or fieldNames has to be not empty", "items" : { "type" : "string", "description" : "Filter field names in case of tree filter. Either fieldName or fieldNames has to be not empty" } }, "values" : { "type" : "array", "description" : "Filter values", "items" : { "type" : "object", "description" : "Filter values" } }, "operator" : { "type" : "string", "description" : "Filter operator", "example" : "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain" }, "locked" : { "type" : "boolean", "description" : "Whether or not filter is locked (ie: not modifiable)" }, "requireValue" : { "type" : "boolean", "description" : "Whether or not filter requires value to be set" }, "enabled" : { "type" : "boolean", "description" : "Whether or not filter is enabled (default is true)" }, "controlType" : { "type" : "string", "description" : "Filter control type", "example" : "single,picker,slider,range_time_slider" }, "visible" : { "type" : "boolean", "description" : "Whether or not filter is visible (default is true)" }, "hitList" : { "type" : "integer", "description" : "Suggestion values dataset ID", "format" : "int64" }, "hitListLabel" : { "type" : "string", "description" : "Suggestion label field name of the hit list dataset" }, "hitListValue" : { "type" : "string", "description" : "Suggestion value field name of the hit list dataset" }, "filteringResult" : { "type" : "boolean", "description" : "Whether the filter should be applied before (false) or after (true) the widget data has been processed" }, "label" : { "type" : "string", "description" : "Display label for the filter" }, "or" : { "type" : "boolean", "description" : "Whether this filter is OR'd with the previous filter (for SQL parsing)" }, "description" : { "type" : "string", "description" : "Filter description" }, "dateLimit" : { "type" : "string", "description" : "Filter date limit" }, "dateLimitOptions" : { "type" : "string", "description" : "Filter date limit options (restriction and from token)" }, "displayValues" : { "type" : "array", "description" : "Custom display values", "items" : { "type" : "object", "description" : "Custom display values" } }, "plainControlType" : { "type" : "string", "description" : "Control type for plain text field type", "example" : "single,multiple,tree,custom" }, "dynamic" : { "type" : "boolean", "description" : "Whether or not filter's value is automatically selected" }, "inclusiveTime" : { "type" : "boolean", "description" : "Whether time range filter is inclusive (includes exact start/end times, where start time is for Start Date and end time for End Date. UI tooltip: When checked, creates a single continuous time period from Start Date/Time to End Date/Time. When unchecked, applies the time range to each day separately (e.g., 9:00-17:00 every day within the date range).)" } }, "description" : "Filter information" }, "Schedule" : { "required" : [ "frequency", "frequencyType" ], "type" : "object", "properties" : { "frequencyType" : { "type" : "string", "description" : "Frequency type", "example" : "daily,day,days,weekday,weekdays,hour,hourly,hours,minute,minutes,minutely,week,weeks,weekly,month,months,monthly" }, "frequency" : { "type" : "integer", "description" : "Frequency count", "format" : "int32" }, "startTime" : { "type" : "string", "description" : "Start time. This can either be time HH:mm or date time MM/dd/yyyy HH:mm" }, "nextExecutionTime" : { "type" : "integer", "description" : "Next execution time in milliseconds", "format" : "int64", "readOnly" : true } }, "description" : "Schedule information" }, "SlackOutput" : { "type" : "object", "properties" : { "selectedSlacks" : { "type" : "array", "description" : "Slack IDs", "items" : { "type" : "integer", "description" : "Slack IDs", "format" : "int64" } } }, "description" : "Slack output properties" }, "TeamsOutput" : { "type" : "object", "properties" : { "selectedTeams" : { "type" : "array", "description" : "Teams IDs", "items" : { "type" : "integer", "description" : "Teams IDs", "format" : "int64" } } }, "description" : "Teams output properties" }, "WebhookOutput" : { "type" : "object", "properties" : { "selectedWebhooks" : { "type" : "array", "description" : "Webhook IDs", "items" : { "type" : "integer", "description" : "Webhook IDs", "format" : "int64" } } }, "description" : "Webhook output properties" }, "ChartAssociations" : { "type" : "object", "properties" : { "widgetId" : { "type" : "integer", "format" : "int64" }, "drilldowns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Drilldown" } } } }, "ChartPosition" : { "type" : "object", "properties" : { "chartId" : { "type" : "integer", "format" : "int64" }, "width" : { "type" : "integer", "format" : "int32" }, "height" : { "type" : "integer", "format" : "int32" }, "originalScreenWidth" : { "type" : "integer", "format" : "int32" }, "originalScreenHeight" : { "type" : "integer", "format" : "int32" }, "col" : { "type" : "integer", "format" : "int32" }, "row" : { "type" : "integer", "format" : "int32" }, "xpos" : { "type" : "integer", "format" : "int32" }, "ypos" : { "type" : "integer", "format" : "int32" }, "id" : { "type" : "integer", "format" : "int64" }, "size_x" : { "type" : "integer", "format" : "int32" }, "size_y" : { "type" : "integer", "format" : "int32" }, "size_y_original" : { "type" : "integer", "format" : "int32" }, "grain" : { "type" : "integer", "format" : "int32" } } }, "Dashboard" : { "type" : "object", "properties" : { "createdDate" : { "type" : "string", "format" : "date-time" }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "format" : "int64" }, "oid" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "userId" : { "type" : "integer", "format" : "int64" }, "url" : { "type" : "string" }, "secureUrl" : { "type" : "string" }, "urlShareWhitelistDomain" : { "type" : "string" }, "displayOrder" : { "type" : "integer", "format" : "int32" }, "screenAdjust" : { "type" : "boolean" }, "screenWidth" : { "type" : "integer", "format" : "int32" }, "screenHeight" : { "type" : "integer", "format" : "int32" }, "lastModDt" : { "type" : "string", "format" : "date-time" }, "lastAccessDt" : { "type" : "string", "format" : "date-time" }, "locked" : { "type" : "boolean" }, "accessLevel" : { "type" : "integer", "format" : "int32" }, "categoryAccessLevel" : { "type" : "integer", "format" : "int32" }, "autoShared" : { "type" : "boolean" }, "filterSettings" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "urlSharePassword" : { "type" : "string" }, "incognitoId" : { "type" : "integer", "format" : "int64" }, "type" : { "type" : "integer", "format" : "int32" }, "username" : { "type" : "string" }, "defaultFilterSets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterSet" } }, "categories" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "notDefaultFilter" : { "type" : "boolean" }, "properties" : { "$ref" : "#/components/schemas/DashboardProps" }, "my" : { "type" : "boolean" }, "orderedPositions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ChartPosition" } }, "showWidgetList" : { "type" : "boolean" }, "dashboardGroupingOriginId" : { "type" : "object" }, "dashNameAsValidFilename" : { "type" : "string" }, "dashboardGroupingViewOnly" : { "type" : "boolean" }, "propertiesInternally" : { "$ref" : "#/components/schemas/DashboardProps" } } }, "DashboardProps" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "theme" : { "type" : "string" }, "description" : { "type" : "string" }, "header" : { "type" : "string" }, "footer" : { "type" : "string" }, "customCssJs" : { "type" : "string" }, "excludeGridWidgetsFromPdfExport" : { "type" : "boolean" }, "excludeExpandedGridFromPdfExport" : { "type" : "boolean" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "pdfViewportWidth" : { "type" : "integer", "format" : "int32" }, "pdfViewportHeight" : { "type" : "integer", "format" : "int32" }, "pdfExportSettings" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "defaultFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "filterSets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterSet" } }, "defaultFilterSets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FilterSet" } }, "view" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "dashboardGroupingList" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "dashboardGroupingMap" : { "type" : "array", "items" : { "type" : "array", "items" : { "type" : "object" } } } } }, "DisplayType" : { "type" : "object", "properties" : { "format" : { "type" : "string" } } }, "Drilldown" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "value" : { "type" : "object" }, "legend" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int64" }, "type" : { "type" : "string", "enum" : [ "widget", "dashboard", "dashboard_connected" ] }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "c9Query" : { "type" : "string" }, "passingFilters" : { "type" : "boolean" }, "passingDrilldownFilters" : { "type" : "boolean" } } }, "FilterSet" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "format" : "int64" }, "userId" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "accessLevel" : { "type" : "integer", "format" : "int32" }, "userSpecific" : { "type" : "boolean" }, "enabled" : { "type" : "boolean" }, "color" : { "type" : "string" }, "defaultFilters" : { "type" : "boolean" }, "locked" : { "type" : "boolean" }, "visible" : { "type" : "boolean" }, "syncFilters" : { "type" : "boolean" }, "expanded" : { "type" : "boolean" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "transientFilter" : { "type" : "boolean" } } }, "GridBean" : { "type" : "object", "properties" : { "jsonRows" : { "type" : "array", "items" : { "type" : "object" } }, "jsonCols" : { "type" : "array", "items" : { "type" : "object" } }, "colTypes" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "existingId" : { "type" : "boolean" }, "containsGeoData" : { "type" : "string" } } }, "MinMaxInfo" : { "type" : "object", "properties" : { "min" : { "type" : "object" }, "max" : { "type" : "object" } } }, "SimpleField" : { "type" : "object", "properties" : { "fieldName" : { "type" : "string" }, "displayType" : { "$ref" : "#/components/schemas/DisplayType" }, "nestedFields" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleField" } }, "ntz" : { "type" : "boolean" } } }, "User" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "User ID", "format" : "int64", "readOnly" : true }, "username" : { "type" : "string", "description" : "User username" }, "name" : { "type" : "string", "description" : "User name" }, "ssoUser" : { "type" : "boolean", "description" : "Is SSO user" }, "customerId" : { "type" : "integer", "description" : "User customer ID", "format" : "int64", "readOnly" : true }, "autocycle" : { "type" : "boolean", "description" : "Is user eligible for auto-cycle", "readOnly" : true }, "timeZone" : { "type" : "string", "description" : "User timezone" }, "lastLoginDate" : { "type" : "string", "description" : "User last login date time", "format" : "date-time", "readOnly" : true }, "managementClientId" : { "type" : "string", "description" : "Management API client ID", "readOnly" : true }, "managementClientSecret" : { "type" : "string", "description" : "Management API client secret", "readOnly" : true }, "externalAuthType" : { "type" : "integer", "description" : "External authentication type", "format" : "int32", "readOnly" : true }, "userGroups" : { "uniqueItems" : true, "type" : "array", "description" : "Groups", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/UserGroup" } }, "userProperties" : { "$ref" : "#/components/schemas/UserProperties" }, "roles" : { "uniqueItems" : true, "type" : "array", "description" : "User roles", "items" : { "type" : "string", "description" : "User roles" } }, "permissions" : { "uniqueItems" : true, "type" : "array", "description" : "User permissions", "readOnly" : true, "items" : { "type" : "string", "description" : "User permissions", "readOnly" : true } }, "jsonConfig" : { "type" : "string", "description" : "Role JSON config (viz settings, etc.)", "readOnly" : true }, "twoFactorBySms" : { "type" : "boolean", "description" : "Is two factor login by SMS enabled" }, "phone" : { "type" : "string", "description" : "User phone number" }, "twoFactorByEmail" : { "type" : "boolean", "description" : "Is two factor login by EMAIL enabled" }, "email" : { "type" : "string", "description" : "User email" }, "selectedDashInternal" : { "$ref" : "#/components/schemas/Dashboard" } }, "description" : "User information" }, "UserGroup" : { "required" : [ "groupName" ], "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Group ID", "format" : "int64", "readOnly" : true }, "groupName" : { "type" : "string", "description" : "Group name" }, "userName" : { "type" : "string", "description" : "Group owner's username", "readOnly" : true }, "userId" : { "type" : "integer", "description" : "Group owner's user ID", "format" : "int64", "readOnly" : true }, "limitSharing" : { "type" : "boolean", "description" : "If true, this user can only share assets with members of this group" }, "accessLevel" : { "type" : "integer", "description" : "User's access level for this group (0=Admin, 1=Edit, 2=View)", "format" : "int32" }, "contentFilters" : { "type" : "array", "description" : "Group content filters", "items" : { "$ref" : "#/components/schemas/Filter" } } }, "description" : "User group information", "readOnly" : true }, "UserProperties" : { "type" : "object", "properties" : { "adminUserLimit" : { "type" : "integer", "format" : "int32" }, "dashboardSharing" : { "type" : "boolean" }, "elasticStoreLimit" : { "type" : "integer", "format" : "int32" }, "machineLearningAccess" : { "type" : "boolean" }, "managementAPI" : { "type" : "boolean" }, "urlSharePasswordProtect" : { "type" : "boolean" }, "customerSsoGenerateUI" : { "type" : "boolean" }, "ssoUserLimit" : { "type" : "integer", "format" : "int32" }, "triggerNotificationAccess" : { "type" : "boolean" }, "insightEnabled" : { "type" : "boolean" }, "insightIconDefaultEnabled" : { "type" : "boolean" }, "searchBarMode" : { "type" : "string" }, "nlpEnabled" : { "type" : "boolean" }, "botNlpEnabled" : { "type" : "boolean" }, "unstructuredDataNlpEnabled" : { "type" : "boolean" }, "allowCustomerUseNlp" : { "type" : "boolean" }, "allowCustomerUseBotNlp" : { "type" : "boolean" }, "nlpIndexByDefault" : { "type" : "boolean" }, "ldap" : { "type" : "boolean" }, "saml" : { "type" : "boolean" }, "userLimit" : { "type" : "integer", "format" : "int32" }, "widgetCountLimit" : { "type" : "integer", "format" : "int32" }, "viewerUserLimit" : { "type" : "integer", "format" : "int32" }, "nlpVisualizationFirstEnabled" : { "type" : "boolean" }, "appsEnabled" : { "type" : "boolean" }, "appsLimit" : { "type" : "integer", "format" : "int32" }, "forceTwoFactorAuthEnabled" : { "type" : "string" }, "newDashNavEnabled" : { "type" : "boolean" }, "font" : { "type" : "string" }, "selectedDashboardId" : { "type" : "integer", "format" : "int64" }, "defaultDashboardId" : { "type" : "integer", "format" : "int64" }, "sendTimezoneWithQuery" : { "type" : "boolean" }, "directPush" : { "type" : "boolean" }, "writeBack" : { "type" : "boolean" }, "userContentFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "customerContentFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "groupContentFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "sharedContentFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "contentFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "schemaSample" : { "type" : "integer", "format" : "int32" }, "schemaNestedSample" : { "type" : "integer", "format" : "int32" }, "maxChunkSize" : { "type" : "integer", "format" : "int32" }, "maxChunkCount" : { "type" : "integer", "format" : "int32" }, "maxQueryTime" : { "type" : "integer", "format" : "int32" }, "locale" : { "type" : "string" }, "defaultTimeZone" : { "type" : "string" }, "customUserColors" : { "type" : "string" }, "customFieldColors" : { "type" : "string" }, "customerLogo" : { "type" : "string" }, "customerThemes" : { "type" : "string" }, "activeThemeId" : { "type" : "string" }, "dateFormat" : { "type" : "string" }, "defaultDateFormat" : { "type" : "string" }, "customMailServer" : { "type" : "string" }, "defaultCategoryPermission" : { "type" : "integer", "format" : "int32" }, "subAccountAccess" : { "type" : "boolean" }, "systemAdmin" : { "type" : "boolean" }, "logoutUrl" : { "type" : "string" }, "supportEmail" : { "type" : "string" }, "pdfEngine" : { "type" : "string" }, "tunnelPrivateKey" : { "type" : "string" }, "tunnelPublicKey" : { "type" : "string" }, "tunnelKeyPassphrase" : { "type" : "string" }, "limitListingUsersToGroups" : { "type" : "boolean" }, "aiAssistantEnabled" : { "type" : "boolean" }, "aiAgentsEnabled" : { "type" : "boolean" }, "aiAgentsUiToggle" : { "type" : "boolean" }, "agenticBIUseDocs" : { "type" : "string" }, "agenticBIUseDatasets" : { "type" : "string" }, "agenticBIUseWidgets" : { "type" : "string" }, "agenticBIUseDashboards" : { "type" : "string" }, "agenticBIUseReports" : { "type" : "string" }, "agenticBIUseAlerts" : { "type" : "string" }, "agenticBIModel" : { "type" : "string" }, "agenticBISelectedDatasets" : { "type" : "string" }, "agenticBISelectedDocs" : { "type" : "string" }, "onboardingChecklistState" : { "type" : "string" }, "aiProviderSettings" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "customSupportEmail" : { "type" : "string" }, "totalUserLimit" : { "type" : "integer", "format" : "int32" }, "oem" : { "type" : "boolean" }, "hasOpenAIKey" : { "type" : "boolean" }, "hasAnthropicKey" : { "type" : "boolean" }, "hasGeminiKey" : { "type" : "boolean" }, "hasAzureAIKey" : { "type" : "boolean" } }, "description" : "User properties", "readOnly" : true }, "Widget" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Widget ID", "format" : "int64", "readOnly" : true }, "name" : { "type" : "string", "description" : "Widget name" }, "userId" : { "type" : "integer", "description" : "Widget owner's user ID", "format" : "int64", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "Widget owner's customer ID", "format" : "int64", "readOnly" : true }, "datasetId" : { "type" : "integer", "description" : "Dataset ID", "format" : "int64" }, "type" : { "type" : "integer", "description" : "Widget type", "format" : "int32" }, "description" : { "type" : "string", "description" : "Widget description" }, "refreshChartMillis" : { "type" : "integer", "format" : "int32" }, "shareUrl" : { "type" : "string", "description" : "Share URL identifier" }, "secureShareUrl" : { "type" : "string", "description" : "Secure share URL identifier" }, "accessLevel" : { "type" : "integer", "description" : "Access level of the report for current user", "format" : "int32", "readOnly" : true }, "certified" : { "type" : "boolean" }, "autoShared" : { "type" : "boolean", "description" : "Is report auto-shared on", "readOnly" : true }, "urlShareWhitelistDomain" : { "type" : "array", "items" : { "type" : "string" } }, "filterSettings" : { "type" : "string" }, "chartType" : { "type" : "string" }, "alertCount" : { "type" : "integer", "format" : "int64" }, "incognitoId" : { "type" : "integer", "format" : "int64" }, "queryId" : { "type" : "integer", "format" : "int64" }, "queryStr" : { "type" : "string" }, "adhocQuery" : { "type" : "string" }, "categories" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "widgetCache" : { "$ref" : "#/components/schemas/WidgetCacheInfo" }, "associations" : { "$ref" : "#/components/schemas/ChartAssociations" }, "queryModified" : { "type" : "boolean" }, "updateFilters" : { "type" : "boolean" }, "dataFields" : { "type" : "array", "items" : { "type" : "string" } }, "dataFieldsTypes" : { "type" : "object" }, "typeModified" : { "type" : "boolean" }, "lastSyncDate" : { "type" : "string", "format" : "date-time", "readOnly" : true }, "viewOnly" : { "type" : "boolean" }, "truncated" : { "type" : "array", "items" : { "type" : "string" } }, "processedName" : { "type" : "string" }, "processedDescription" : { "type" : "string" }, "processedFootNote" : { "type" : "string" }, "error" : { "type" : "string" }, "pagination" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "pagedDataTransformationWarning" : { "type" : "string" }, "processedChartProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "widgetConfig" : { "$ref" : "#/components/schemas/WidgetConfig" }, "notDefaultFilter" : { "type" : "boolean" }, "minMax" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MinMaxInfo" } }, "chartProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "drilldowns" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Drilldown" } }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "widgetAccessLevel" : { "type" : "integer", "format" : "int32" }, "chartPropertiesNullOrEmpty" : { "type" : "boolean" }, "user" : { "$ref" : "#/components/schemas/User" }, "repeatableWidget" : { "type" : "boolean" }, "drilldownFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "displayableFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "repeatableWidgetFeatureEnabled" : { "type" : "boolean" }, "dataDisplayTypes" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DisplayType" } }, "dbFields" : { "type" : "array", "items" : { "type" : "string" } }, "ignoreVals" : { "type" : "array", "items" : { "type" : "string" } }, "widgetTypeStr" : { "type" : "string" }, "filterFieldDataTypesIncludingNested" : { "type" : "object" }, "filteringResultFields" : { "type" : "object" }, "filterFieldDataTypes" : { "type" : "object" }, "ntzColumns" : { "uniqueItems" : true, "type" : "array", "readOnly" : true, "items" : { "type" : "string" } }, "gridBean" : { "$ref" : "#/components/schemas/GridBean" }, "live" : { "type" : "boolean" }, "fields" : { "type" : "array", "writeOnly" : true, "items" : { "type" : "string" } } }, "description" : "Widget information" }, "WidgetCacheInfo" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "mode" : { "type" : "string" }, "state" : { "type" : "string" }, "refreshing" : { "type" : "boolean" }, "staleReason" : { "type" : "string" }, "lastUpdatedAt" : { "type" : "integer", "format" : "int64" } } }, "WidgetConfig" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "fields" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleField" } }, "macroFields" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/SimpleField" } }, "defaultFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } } } }, "AccessToken" : { "type" : "object", "properties" : { "accessToken" : { "type" : "string", "description" : "Access token", "readOnly" : true }, "expires" : { "type" : "integer", "description" : "Number of seconds to expiration", "format" : "int64", "readOnly" : true }, "tokenType" : { "type" : "string", "description" : "Token type currently only allow bearer", "readOnly" : true } }, "description" : "Authentication token information" }, "Credential" : { "type" : "object", "properties" : { "clientId" : { "type" : "string", "description" : "Management API client ID" }, "clientSecret" : { "type" : "string", "description" : "Management API client secret" } }, "description" : "Management API client ID" }, "CategoryAssetRequest" : { "required" : [ "categoryId", "objectId" ], "type" : "object", "properties" : { "categoryId" : { "type" : "integer", "description" : "Category ID to add asset to or remove asset from.", "format" : "int64" }, "objectId" : { "type" : "integer", "description" : "Asset ID to add to category or remove from category.", "format" : "int64" } } }, "CategoryTreeItem" : { "required" : [ "name", "objectType", "parentId" ], "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Category ID", "format" : "int64", "readOnly" : true }, "name" : { "type" : "string", "description" : "Category name" }, "parentId" : { "type" : "integer", "description" : "Parent category ID", "format" : "int64" }, "objectType" : { "type" : "integer", "description" : "Category object type", "format" : "int32" }, "userId" : { "type" : "integer", "description" : "Category user ID", "format" : "int64", "readOnly" : true }, "customerId" : { "type" : "integer", "description" : "Category customer ID", "format" : "int64", "readOnly" : true }, "accessLevel" : { "type" : "integer", "description" : "Access level", "format" : "int32", "readOnly" : true } }, "description" : "Category information" }, "ConnectorDatasource" : { "required" : [ "name" ], "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "jsonConfig" : { "type" : "object", "description" : "Datasource type specific information", "oneOf" : [ { "$ref" : "#/components/schemas/MongoDBDatasource" }, { "$ref" : "#/components/schemas/MySQLDBDatasource" } ] }, "id" : { "type" : "integer", "description" : "Datasource ID", "format" : "int64", "readOnly" : true }, "name" : { "type" : "string", "description" : "Datasource name" }, "datasource" : { "type" : "string", "description" : "Datasource type" }, "userId" : { "type" : "integer", "description" : "User ID of Datasource owner", "format" : "int64" }, "connectorId" : { "type" : "integer", "description" : "Connector ID of the connector that the datasource is assigned to", "format" : "int64" }, "accessLevel" : { "type" : "integer", "description" : "Access level of the datasource for current user", "format" : "int32", "readOnly" : true }, "acl" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Rule" } }, "username" : { "type" : "string", "description" : "Datasource owner's username", "readOnly" : true }, "proxy" : { "type" : "boolean", "description" : "Whether or not direct query can be allowed on a private agent for this datasource. Note that the private agent needs to have proxy enabled as well." }, "connectSchema" : { "type" : "boolean", "description" : "Whether or not this has schema detection enabled" }, "directQueryOnly" : { "type" : "boolean", "description" : "Whether or not this datasource is only allow direct query" }, "timeZone" : { "type" : "string", "description" : "Timezone" }, "userEmail" : { "type" : "string" } }, "description" : "Datasource information" }, "MongoDBDatasource" : { "required" : [ "datasource", "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Datasource name" }, "datasource" : { "type" : "string", "description" : "Datasource type. Possible values: bigquery, cloud9charts, cloudant, couchbase, datastax, elasticsearch, ga, hana, hive, influxdb, logsene, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, salesforce, redshift, restapi, snowflake, spark, sqlserver, teradata" }, "privateConnector" : { "type" : "string", "description" : "ID of private connector" }, "proxy" : { "type" : "boolean", "description" : "Enable proxy server usage" }, "proxyAddress" : { "type" : "string", "description" : "Proxy server address" }, "dbProperties" : { "type" : "string", "description" : "(datastax, elasticsearch, hana, hive, marklogic, mongo, mysql, oracle, postgresql, presto, redshift, snowflake, spark, sqlserver) Database specific properties in datasource specific format such as headers, query string, etc" }, "userId" : { "type" : "string", "description" : "(cloudant, couchbase, datastax, elasticsearch, hana, hive, influxdb, logsene, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, restapi, snowflake, spark, sqlserver, teradata) User ID" }, "password" : { "type" : "string", "description" : "(cloudant, couchbase, datastax, elasticsearch, hana, hive, influxdb, logsene, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, restapi, snowflake, spark, sqlserver, teradata) User password" }, "host" : { "type" : "string", "description" : "(couchbase, datastax, hana, hive, influxdb, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Database host(s)" }, "dbName" : { "type" : "string", "description" : "(cloudant, couchbase, datastax, hana, hive, influxdb, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Database, Bucket, or Keyspace name" }, "port" : { "type" : "integer", "description" : "(datastax, hana, hive, marklogic, mongo, mysql, oracle, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Database port", "format" : "int32" }, "legacyVersionSupport" : { "type" : "boolean" }, "legacyMode" : { "type" : "boolean" }, "dsDisplayName" : { "type" : "string", "description" : "Datasource full name to display", "readOnly" : true } }, "description" : "MongoDB Datasource information" }, "MySQLDBDatasource" : { "required" : [ "datasource", "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Datasource name" }, "datasource" : { "type" : "string", "description" : "Datasource type. Possible values: bigquery, cloud9charts, cloudant, couchbase, datastax, elasticsearch, ga, hana, hive, influxdb, logsene, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, salesforce, redshift, restapi, snowflake, spark, sqlserver, teradata" }, "privateConnector" : { "type" : "string", "description" : "ID of private connector" }, "proxy" : { "type" : "boolean", "description" : "Enable proxy server usage" }, "proxyAddress" : { "type" : "string", "description" : "Proxy server address" }, "dbProperties" : { "type" : "string", "description" : "(datastax, elasticsearch, hana, hive, marklogic, mongo, mysql, oracle, postgresql, presto, redshift, snowflake, spark, sqlserver) Database specific properties in datasource specific format such as headers, query string, etc" }, "userId" : { "type" : "string", "description" : "(cloudant, couchbase, datastax, elasticsearch, hana, hive, influxdb, logsene, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, restapi, snowflake, spark, sqlserver, teradata) User ID" }, "password" : { "type" : "string", "description" : "(cloudant, couchbase, datastax, elasticsearch, hana, hive, influxdb, logsene, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, restapi, snowflake, spark, sqlserver, teradata) User password" }, "host" : { "type" : "string", "description" : "(couchbase, datastax, hana, hive, influxdb, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Database host(s)" }, "dbName" : { "type" : "string", "description" : "(cloudant, couchbase, datastax, hana, hive, influxdb, marklogic, mongo, mysql, oracle, orientdb, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Database, Bucket, or Keyspace name" }, "port" : { "type" : "integer", "description" : "(datastax, hana, hive, marklogic, mongo, mysql, oracle, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Database port", "format" : "int32" }, "schema" : { "type" : "string", "description" : "(hana, hive, mysql, oracle, phoenix, postgresql, presto, redshift, snowflake, spark, sqlserver, teradata) Schema name" }, "dsDisplayName" : { "type" : "string", "description" : "Datasource full name to display", "readOnly" : true } }, "description" : "MySQL Datasource information" }, "Rule" : { "type" : "object", "properties" : { "type" : { "type" : "integer", "description" : "Type", "format" : "int32" }, "regex" : { "type" : "boolean", "description" : "Whether or not the value is a regular expression or just plain text" }, "value" : { "type" : "string", "description" : "Rule match value" } }, "description" : "Datasource ACL rule" }, "GroupAsset" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Asset name", "readOnly" : true }, "accessLevel" : { "type" : "integer", "description" : "Asset access level", "format" : "int32", "readOnly" : true }, "objectId" : { "type" : "integer", "description" : "Asset ID", "format" : "int64", "readOnly" : true }, "objectType" : { "type" : "integer", "description" : "Asset type", "format" : "int32", "readOnly" : true } }, "description" : "Shared asset information" }, "KPI" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "KPI name", "readOnly" : true }, "status" : { "type" : "string", "description" : "KPI status", "readOnly" : true, "example" : "GREEN, YELLOW, RED", "enum" : [ "GREEN", "YELLOW", "RED" ] }, "time" : { "type" : "integer", "description" : "KPI execution time", "format" : "int64", "readOnly" : true }, "comment" : { "type" : "string", "description" : "KPI comment", "readOnly" : true } }, "description" : "KPI information" }, "KPIAll" : { "type" : "object", "properties" : { "checkMySQL" : { "$ref" : "#/components/schemas/KPI" }, "checkMongoDB" : { "$ref" : "#/components/schemas/KPI" }, "checkMessageMQ" : { "$ref" : "#/components/schemas/KPI" }, "checkHostedConnector" : { "$ref" : "#/components/schemas/KPI" }, "checkQueryPreview" : { "$ref" : "#/components/schemas/KPI" }, "checkQuerySaveAndRunNow" : { "$ref" : "#/components/schemas/KPI" }, "checkDashboardLoad" : { "$ref" : "#/components/schemas/KPI" }, "checkWidgetLoad" : { "$ref" : "#/components/schemas/KPI" }, "checkMongoReplicaSetStatus" : { "$ref" : "#/components/schemas/KPI" } }, "description" : "All KPIs" }, "NlpData" : { "type" : "object", "properties" : { "datasetId" : { "type" : "integer", "description" : "Dataset id for the matching dataset from the NLP query.", "format" : "int64", "readOnly" : true }, "datasetName" : { "type" : "string", "description" : "Dataset id for the matching dataset from the NLP query.", "readOnly" : true }, "data" : { "type" : "array", "readOnly" : true, "items" : { "type" : "object" } } }, "description" : "Data from an NLP query" }, "NlpQuery" : { "type" : "object", "properties" : { "query" : { "type" : "string", "description" : "Query string." } }, "description" : "NLP query." }, "NlpSuggestion" : { "type" : "object", "properties" : { "datasetId" : { "type" : "integer", "description" : "Dataset ID.", "format" : "int64", "readOnly" : true }, "datasetName" : { "type" : "string", "description" : "Dataset name.", "readOnly" : true }, "query" : { "type" : "string", "description" : "Complete search term suggestion match.", "readOnly" : true }, "distance" : { "type" : "number", "description" : "Distance.", "format" : "double", "readOnly" : true } }, "description" : "NLP query suggestions with matching dataset and search term." }, "Attachments" : { "type" : "object", "properties" : { "pdfBuilderDashboards" : { "type" : "array", "description" : "PDF Builder Report dashboards", "items" : { "$ref" : "#/components/schemas/DashboardReport" } } }, "description" : "Email report attachments" }, "DashboardReport" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "Asset ID", "format" : "int64" }, "name" : { "type" : "string", "description" : "Asset name" }, "exportInsights" : { "type" : "boolean", "description" : "Output as Insights text" }, "exportRecommendations" : { "type" : "boolean", "description" : "Export AI Recommendations" }, "aiRecContext" : { "type" : "string", "description" : "AI Recommendations Context" } }, "description" : "Scheduled Reports for Dashboards" }, "DatasetReport" : { "required" : [ "datasetId" ], "type" : "object", "properties" : { "datasetId" : { "type" : "integer", "description" : "Dataset ID", "format" : "int64" }, "name" : { "type" : "string", "description" : "Dataset name" }, "c9SQLFilter" : { "type" : "string", "description" : "C9QL filter" } }, "description" : "Email report dataset information" }, "EmailReport" : { "required" : [ "attachments", "name", "properties", "schedule" ], "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Report ID", "format" : "int64", "readOnly" : true }, "userId" : { "type" : "integer", "description" : "Report owner's user ID", "format" : "int64", "readOnly" : true }, "username" : { "type" : "string", "description" : "Report owner's username", "readOnly" : true }, "status" : { "type" : "integer", "description" : "Report status", "format" : "int32", "readOnly" : true }, "name" : { "type" : "string", "description" : "Report name" }, "text" : { "type" : "string", "description" : "Email body text" }, "autoShared" : { "type" : "boolean", "description" : "Is report auto-shared on", "readOnly" : true }, "schedule" : { "$ref" : "#/components/schemas/Schedule" }, "executionReport" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/ExecutionReport" } }, "accessLevel" : { "type" : "integer", "description" : "Access level of the report for current user", "format" : "int32", "readOnly" : true }, "properties" : { "$ref" : "#/components/schemas/EmailReportProps" }, "attachments" : { "$ref" : "#/components/schemas/Attachments" } }, "description" : "Email report information" }, "EmailReportProps" : { "type" : "object", "properties" : { "datasetReports" : { "type" : "array", "description" : "Report datasets", "items" : { "$ref" : "#/components/schemas/DatasetReport" } }, "dashboards" : { "type" : "array", "description" : "Report dashboards", "items" : { "$ref" : "#/components/schemas/DashboardReport" } }, "widgets" : { "type" : "array", "description" : "Report widgets", "items" : { "$ref" : "#/components/schemas/WidgetReport" } }, "from" : { "type" : "string", "description" : "Email from" }, "replyTo" : { "type" : "string", "description" : "Email reply to" }, "subject" : { "type" : "string", "description" : "Email subject" }, "sendTo" : { "type" : "array", "description" : "Email send to", "items" : { "type" : "string", "description" : "Email send to" } }, "cc" : { "type" : "array", "description" : "Email cc", "items" : { "type" : "string", "description" : "Email cc" } }, "bcc" : { "type" : "array", "description" : "Email bcc", "items" : { "type" : "string", "description" : "Email bcc" } }, "disablePDFAttachments" : { "type" : "boolean", "description" : "Whether or not to exclude PDF attachments" }, "reportAs" : { "type" : "integer", "description" : "Report as user ID", "format" : "int64" }, "reportContentFilters" : { "type" : "array", "description" : "Report content filters", "items" : { "$ref" : "#/components/schemas/Filter" } }, "webhooks" : { "type" : "array", "description" : "Webhook IDs", "items" : { "type" : "integer", "description" : "Webhook IDs", "format" : "int64" } }, "slacks" : { "type" : "array", "description" : "Slack IDs", "items" : { "type" : "integer", "description" : "Slack IDs", "format" : "int64" } }, "teams" : { "type" : "array", "description" : "Team IDs", "items" : { "type" : "integer", "description" : "Team IDs", "format" : "int64" } }, "nlpQuery" : { "type" : "string", "description" : "NLP query" }, "nlpDatasetId" : { "type" : "integer", "description" : "Report NLP context path", "format" : "int64" }, "skipReportIfAttachmentsAreBlank" : { "type" : "boolean", "description" : "Skip Report if no attachments or all attachments are empty" }, "reportContainsWidgetExport" : { "type" : "boolean" } }, "description" : "Email report properties" }, "WidgetReport" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "integer", "description" : "Asset ID", "format" : "int64" }, "name" : { "type" : "string", "description" : "Asset name" }, "associatedDashboardId" : { "type" : "integer", "description" : "Dashboard ID used to apply filters to widget", "format" : "int64" }, "exportPDF" : { "type" : "boolean", "description" : "Output as PDF file" }, "exportCSV" : { "type" : "boolean", "description" : "Output as CSV file" }, "exportExcel" : { "type" : "boolean", "description" : "Output as Excel file" }, "exportInsights" : { "type" : "boolean", "description" : "Output as Insights text" }, "aiEnabled" : { "type" : "boolean", "description" : "AI Insights Enablement" }, "aiContext" : { "type" : "string", "description" : "AI Context" }, "exportRecommendations" : { "type" : "boolean", "description" : "Export AI Recommendations" }, "aiRecContext" : { "type" : "string", "description" : "AI Recommendations Context" }, "skipIfEmpty" : { "type" : "boolean", "description" : "Skip attachment if widget data is empty" } }, "description" : "Scheduled Reports for Widgets" }, "RunReportRequest" : { "type" : "object", "properties" : { "recipients" : { "type" : "array", "items" : { "type" : "string" } }, "cc" : { "type" : "array", "items" : { "type" : "string" } }, "bcc" : { "type" : "array", "items" : { "type" : "string" } }, "subject" : { "type" : "string" }, "message" : { "type" : "string" }, "reportContentFilters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } } } }, "Role" : { "type" : "object", "properties" : { "createdDate" : { "type" : "integer", "description" : "Created date in milliseconds", "format" : "int64", "readOnly" : true }, "lastModDate" : { "type" : "integer", "description" : "Last modified date", "format" : "int64", "readOnly" : true }, "id" : { "type" : "integer", "description" : "Role id", "format" : "int64" }, "name" : { "type" : "string", "description" : "Role name" }, "jsonConfig" : { "type" : "string", "description" : "Role JSON config (viz settings, etc.)" } }, "description" : "User role information" }, "TransferRequest" : { "required" : [ "destinationUserId", "sourceUserId" ], "type" : "object", "properties" : { "sourceUserId" : { "type" : "integer", "description" : "Id of user to transfer assets from.", "format" : "int64" }, "destinationUserId" : { "type" : "integer", "description" : "Id of user to transfer assets to.", "format" : "int64" } } } }, "securitySchemes" : { "Authorization" : { "type" : "http", "in" : "header", "scheme" : "bearer" } } } }