{"openapi":"3.0.0","servers":[{"url":"/api/v1","description":"API"}],"paths":{"/suggestions":{"post":{"x-swagger-router-controller":"suggestions/v1/suggestions.controller.v1","x-permission-type":"authenticate","operationId":"getSuggestions","summary":"Return suggestions for an entity","description":"Return **suggestions** for a data source or field.\n","tags":["suggestion"],"responses":{"200":{"description":"List of recommended items","content":{"application/json":{"schema":{"description":"Array of candidates to suggest","type":"object","properties":{"queryMetadata":{"description":"query metadata","type":"object","properties":{"target":{"description":"which items to look for suggestions","type":"array","items":{"type":"string"}},"popular":{"description":"include popular fields or not","type":"boolean"},"total":{"description":"total items which match query metadata","type":"number"},"skip":{"description":"number of skipped items","type":"number"},"count":{"description":"number of returned items","type":"number"}}},"suggestions":{"type":"array","description":"fields to suggest","items":{"type":"object","properties":{"item":{"type":"object","properties":{"_id":{"type":"string"},"table":{"type":"string"},"column":{"type":"string"},"dim":{"type":"string"},"datatype":{"type":"string"},"title":{"type":"string"},"merged":{"type":"boolean"},"fieldType":{"type":"string"},"columnTitle":{"type":"string"},"tableTitle":{"type":"string"}}},"dim":{"type":"string"},"probability":{"type":"number"},"probabilityType":{"type":"string"}}}}}}}}},"401":{"description":"No access allowed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"description":"The properties that define which object to return suggestions for. You can return suggestions for a data source or for a specific field within a data source.","required":true,"content":{"application/json":{"schema":{"description":"Properties to get suggestion items","type":"object","required":["type","datasource","fields"],"properties":{"datasource":{"description":"datasource name","type":"object"},"type":{"description":"define suggestion type [widgets]","type":"string"},"count":{"description":"how many items to return. By default 20","type":"number"},"fields":{"description":"which items to look for suggestions","type":"array","items":{"type":"object"}},"skip":{"description":"number of items to skip. By default 0","type":"number"},"popular":{"description":"include popular fields or not. By default true","type":"boolean"}}}}}}}},"/suggestions/status":{"get":{"x-swagger-router-controller":"suggestions/v1/suggestions.controller.v1","x-permission-type":"admins-only","operationId":"getStatus","summary":"Return status of suggestions","description":"The **suggestions status** used get actual status of suggestions\n","tags":["suggestion"],"responses":{"200":{"description":"Suggestions status","content":{"application/json":{"schema":{"description":"Status of suggestions","type":"object","properties":{"lastExecution":{"description":"Time when was last suggestions refresh.","type":"string"},"jobStatus":{"description":"Define job status.","type":"string"},"jobFrequent":{"description":"Job schedule in cron format.","type":"string"},"executionStatus":{"description":"Executions status of suggestions processes.","type":"boolean"}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Suggestion does not set","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}}},"parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]}},"/suggestions/refresh":{"post":{"x-swagger-router-controller":"suggestions/v1/suggestions.controller.v1","x-permission-type":"admins-only","operationId":"refreshSuggestions","summary":"Refresh suggestions data and ranking","description":"Refresh **suggestions** with actual data and ranking.\n","tags":["suggestion"],"responses":{"200":{"description":"Refresh suggestions status","content":{"application/json":{"schema":{"description":"Status of suggestions","type":"object","properties":{"message":{"description":"Information message.","type":"string"},"suggestionCode":{"description":"Suggestions code.","type":"number"}}}}}},"401":{"description":"No access allowed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"description":"The properties that define which part of suggestions refresh.","required":false,"content":{"application/json":{"schema":{"description":"Properties to refresh suggestions","type":"object","properties":{"data":{"description":"refresh suggestions data or not. By default false.","type":"boolean"},"ranking":{"description":"refresh suggestions ranking or not. By default false.","type":"boolean"}}}}}}}},"/suggestions/refresh/datasource":{"post":{"x-swagger-router-controller":"suggestions/v1/suggestions.controller.v1","x-permission-type":"admins-only","operationId":"refreshSuggestionsByDatasource","summary":"Refresh suggestions data and ranking by Datasource","description":"Refresh **suggestions** with actual data and ranking.\n","tags":["suggestion"],"responses":{"200":{"description":"Refresh suggestions status"},"401":{"description":"No access allowed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"description":"The datasource for which to refresh suggestions. Both \"title\" and \"address\" fields are required","required":true,"content":{"application/json":{"schema":{"description":"Datasource for which to refresh suggestions","type":"object","required":["datasource"],"properties":{"datasource":{"type":"object","required":["title","address"],"properties":{"title":{"type":"string"},"address":{"type":"string"}}}}}}}}}},"/data-exploration/status":{"get":{"x-swagger-router-controller":"/dataExploration/v1/dataExploration.controller.v1","x-permission-type":"admins-only","operationId":"getDataExplorationStatus","summary":"Return status of data exploration","description":"The data exploration status used get actual status of data exploration\n","tags":["data-exploration"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Data exploration status","content":{"application/json":{"schema":{"description":"Status of data exploration","type":"object","properties":{"lastExecution":{"description":"Time when was last data exploration refresh.","type":"string"},"jobStatus":{"description":"Define job status.","type":"string"},"jobFrequent":{"description":"Job schedule in cron format.","type":"string"},"executionStatus":{"description":"Executions status of data exploration processes.","type":"boolean"}}}}}},"401":{"description":"No access allowed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}}}}}},"/data-exploration/refresh":{"post":{"x-swagger-router-controller":"/dataExploration/v1/dataExploration.controller.v1","x-permission-type":"admins-only","operationId":"refreshDataExploration","summary":"Refresh data exploration","description":"Refresh data exploration with actual data.\n","tags":["data-exploration"],"responses":{"200":{"description":"Refresh data exploration status","content":{"application/json":{"schema":{"description":"Trigger refresh of data exploration","type":"object","properties":{"message":{"description":"Information message.","type":"string"},"dataExplorationCode":{"description":"Data exploration code.","type":"number"}}}}}},"401":{"description":"No access allowed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"description":"The properties that define which part of data exploration to refresh.","required":false,"content":{"application/json":{"schema":{"description":"Properties to refresh data exploration","type":"object","properties":{"data":{"description":"refresh data exploration data or not. By default false.","type":"boolean"}}}}}}}},"/data-exploration/refresh/datasource":{"post":{"x-swagger-router-controller":"/dataExploration/v1/dataExploration.controller.v1","x-permission-type":"admins-only","operationId":"refreshDataExplorationByDatasource","summary":"Refresh data exploration by Datasource","description":"Refresh **data exploration** with actual data and ranking.\n","tags":["data-exploration"],"responses":{"200":{"description":"Refresh data exploration datasource"},"401":{"description":"No access allowed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}}}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"allOf":[{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"status":{"type":"integer"},"httpMessage":{"type":"string"}}},{"type":"object","properties":{"resourceType":{"type":"string"},"resourceName":{"type":"string"}}}]}}}}}}},"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"description":"The datasource for which to refresh data exploration.","required":true,"content":{"application/json":{"schema":{"description":"Datasource for which to refresh suggestions","type":"object","required":["datasource"],"properties":{"datasource":{"type":"object","required":["title","address"],"properties":{"title":{"type":"string"},"address":{"type":"string"}}}}}}}}}},"/data-exploration/user-influences":{"get":{"x-swagger-router-controller":"/userInfluences/v1/userInfluences.controller.v1","x-permission-type":"none","x-hide":false,"operationId":"getUserInfluences","summary":"Returns user likes","description":"Returns user influences(watches/likes) on widgets from AI pop-up\n","tags":["data-exploration"],"parameters":[{"in":"header","description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","name":"authorization","required":false,"schema":{"type":"string","pattern":"^Bearer .*"}},{"in":"query","name":"widget","description":"Widget oid","required":true,"schema":{"type":"string","pattern":"^[a-f\\d]{24}$"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"OK"},"403":{"description":"User does not have permission"}}}},"/live_connectors/{provider}/table_schema_details":{"post":{"tags":["live-connectors"],"summary":"Returns a table's schema","description":"The <strong>get table schema details</strong> endpoint returns a detailed schema of the table with columns.","operationId":"getLiveConnectorTableSchemaDetails","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"Table schema","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TableSchema"}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/sql_manual_queries/get","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}/list_schemas":{"post":{"tags":["live-connectors"],"summary":"Returns a list of schemas in a database","description":"The <strong>list table schemas</strong> endpoint returns a list of available schemas in a specified database.","operationId":"getLiveConnectorSchemas","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"List of schemas","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TableSchema"}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/notebooks":{"get":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"put":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_2","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_1","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"delete":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_3","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"options":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_6","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"x-permission-type":"authenticate"},"head":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_5","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"x-permission-type":"authenticate"},"patch":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_4","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors":{"get":{"tags":["live-connectors"],"summary":"Returns the list of available live connector services","description":"The <strong>get live connectors</strong> endpoint returns a list of connectors.","operationId":"getLiveConnectors","parameters":[{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"name":"includeIcon","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"An array of live connectors","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LiveConnector"}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/connection":{"get":{"tags":["connections"],"summary":"Returns a list of connections","description":"The <strong>get connection</strong> endpoint returns a list of configured connections.","operationId":"getAllConnections_1","parameters":[{"name":"sort","in":"query","description":"Field by which the results should be sorted. Ascending by default, descending if prefixed by -","required":false,"schema":{"type":"string"}},{"name":"skip","in":"query","description":"Number of results to skip from the start of the data set. skip is to be used with the limit parameter for paging","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"limit","in":"query","description":"How many results should be returned. limit is to be used with the skip parameter for paging","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"List of connection objects","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataSource"}}}}},"403":{"description":"User does not have permission"}},"x-permission-path":"manage/connections/get","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/connection/{id}":{"get":{"tags":["connections"],"summary":"Returns a connection by its ID","description":"The <strong>get connection by ID</strong> endpoint returns a connection object by ID.","operationId":"getConnectionById","parameters":[{"name":"id","in":"path","description":"The ID of the live connection. You can retrieve this ID through the get /connection endpoint.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Connection object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSource"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Connection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-path":"manage/connections/get","x-permission-type":"general"},"delete":{"tags":["connections"],"summary":"Removes a connection","description":"The <strong>delete connection</strong> endpoint removes a connection by ID.","operationId":"deleteConnection_1","parameters":[{"name":"id","in":"path","description":"The ID of the live connection. You can retrieve this ID through the get /connection endpoint.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"204":{"description":"Connection were removed successfully","content":{"application/json":{"schema":{"type":"string"}}}},"400":{"description":"24004 Connection is in use","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"},"404":{"description":"24002 Connection not found","content":{"application/json":{"schema":{"type":"string"}}}}},"x-permission-path":"manage/connections/remove","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/connectors/{provider}/ui_config":{"get":{"tags":["connectors","live-connectors"],"summary":"Returns object that describes the UI connection manifest","description":"The <strong>get connector ui manifest</strong> endpoint returns connector ui manifest that describes ui render options for controls.","operationId":"getUiConfig","parameters":[{"name":"provider","in":"path","description":"The name of connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Connector ui manifest","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"User does not have permission"},"404":{"description":"UI Manifest not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}/test_connection":{"post":{"tags":["live-connectors"],"summary":"Returns an object with status = OK after a successful connection","description":"Opens a connection through a specified connector to the datasource.","operationId":"liveConnectorTestConnection","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"Connection status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionStatus"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-path":"manage/connections/get","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}/list_table_schemas":{"post":{"tags":["live-connectors"],"summary":"Returns a list of tables in a database","description":"The <strong>list table schemas</strong> endpoint returns a list of available tables in a specified database. Table schemas do not include column details.","operationId":"getLiveConnectorTableSchemas","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"List of table schemas","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TableSchema"}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}/table_preview":{"post":{"tags":["live-connectors"],"summary":"Returns data preview","description":"The <strong>get table preview</strong> endpoint returns a preview of the data in specified table.\nThis endpoint is deprecated. Please use: /connectors/{provider}/table_preview endpoint instead.","operationId":"getLiveConnectorPreview","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"Data preview","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataPreview"}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/connection/recent":{"get":{"tags":["connections"],"summary":"Returns recently used connection objects","description":"The <strong>list connections</strong> endpoint returns list of recently used connections.","operationId":"getRecentConnections","parameters":[{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"List of connection objects","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DataSourceWithDuplicates"}}}}},"403":{"description":"User does not have permission"}},"x-permission-path":"manage/connections/get","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}/count":{"post":{"tags":["live-connectors"],"summary":"Returns count of entries in table","description":"The <strong>get table count</strong> endpoint returns the number of entries in a specified table.","operationId":"getLiveConnectorCount","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"Amount of entries in table","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorCount"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}":{"get":{"tags":["live-connectors"],"summary":"Returns object that describes the connection manifest (parameters)","description":"The <strong>get live connector</strong> endpoint returns connector manifest that describes the parameters.","operationId":"getLiveConnectors_1","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"name":"includeIcon","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"responses":{"200":{"description":"Connector manifest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorManifest"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/settings/translation":{"get":{"tags":["translator-utils-rest-controller"],"summary":"Returns translation settings","operationId":"getTranslationSetting","responses":{"200":{"description":"translation settings.","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not configured yet","content":{"application/json":{"schema":{"type":"string"}}}}},"x-permission-path":"manage/translation/get","x-permission-type":"general","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"x-permission-type":"none","x-unlimited-content-type":"true"},"/notebooks/**":{"get":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_7","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"put":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_9","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"post":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_8","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"delete":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_10","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"options":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_13","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"x-permission-type":"authenticate"},"head":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_12","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}},"x-permission-type":"authenticate"},"patch":{"tags":["notebook-router-controller"],"operationId":"handleAllRequests_11","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"User does not have permission"}},"x-permission-type":"authenticate","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"x-permission-type":"none","x-unlimited-content-type":"true"},"/live_connectors/{provider}/list_databases":{"post":{"tags":["live-connectors"],"summary":"Returns list of databases","description":"The <strong>list databases</strong> endpoint returns a list of available databases in the connected instance.","operationId":"getLiveConnectorDatabases","parameters":[{"name":"provider","in":"path","description":"The name of live connector provider.","required":true,"schema":{"type":"string"}},{"name":"authorization","in":"header","description":"The user’s API token preceded by the keyword Bearer (with space between it and the token). For more information, see API tutorial.","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionParameters"}}},"required":true},"responses":{"200":{"description":"List of databases","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Api not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/servers/next/{server}/build":{"post":{"tags":["build-rest-controller"],"summary":"run build cube","operationId":"build","parameters":[{"name":"server","in":"path","required":true,"schema":{"type":"string"}},{"name":"buildType","in":"query","required":true,"schema":{"type":"string"}},{"name":"rowLimit","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"traceLevel","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","default":"NextECM"}},{"name":"schemaType","in":"query","required":false,"schema":{"type":"string","default":"schema-changes"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcmModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int32"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/next/getContextFromExpression":{"post":{"tags":["build-rest-controller"],"summary":"check auto complete for custom query","operationId":"getContextFromExpression","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableSqlExpressionDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContextElement"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/servers/next/{server}/explain_build":{"post":{"tags":["build-rest-controller"],"summary":"explain build without type","operationId":"explainBuildWithoutType","parameters":[{"name":"server","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcmModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExplainBuildElement"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/servers/next/{server}/explain_build/{buildType}":{"post":{"tags":["build-rest-controller"],"summary":"explain build by build type","operationId":"explainBuild","parameters":[{"name":"server","in":"path","required":true,"schema":{"type":"string"}},{"name":"buildType","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcmModel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExplainBuildElement"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/next/runColumnQuery":{"post":{"tags":["build-rest-controller"],"summary":"check column query validation","operationId":"runColumnQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableSqlExpressionDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Column"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/servers/next/{server}/{dataSourceTitle}/isBuilding":{"get":{"tags":["build-rest-controller"],"summary":"Build contract: checks if there is running build for given data source","operationId":"isBuilding","parameters":[{"name":"server","in":"path","required":true,"schema":{"type":"string"}},{"name":"dataSourceTitle","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/next/runTableQuery":{"post":{"tags":["build-rest-controller"],"summary":"check table query validation","operationId":"runTableQuery","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableSqlExpressionDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaDTO"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/BuildErrorResponse"},{"$ref":"#/components/schemas/TranslationError"}]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildErrorResponse"}}}}},"x-permission-path":"manage/elasticubes/execute_build","x-permission-type":"general","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}]},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/servers/next":{"get":{"tags":["management-rest-controller"],"summary":"Get servers with next ECubes","operationId":"getServersWithNextECubes","parameters":[{"name":"q","in":"query","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"direction","in":"query","required":false,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AllCubesDTO"}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-permission-type":"authenticate"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/elasticubes/servers/next/{server}/{cubeTitle}":{"get":{"tags":["management-rest-controller"],"summary":"Get Ecm Model of a specific elasticube","operationId":"getEcmModel","parameters":[{"name":"server","in":"path","required":true,"schema":{"type":"string"}},{"name":"cubeTitle","in":"path","required":true,"schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagementServiceResponseEcmModel"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-permission-path":"manage/elasticubes/get","x-permission-type":"general"},"x-permission-type":"none","x-unlimited-content-type":"true"},"/formulas":{"get":{"operationId":"FormulaController_getAll","summary":"Get multiple formulas","parameters":[{"name":"datasource","required":false,"in":"query","schema":{"type":"string"}},{"name":"oids","required":false,"in":"query","description":"Relevant formula ids to fetch.","example":["925e8eae-c429-4f02-84da-1b1388ad19b9"],"schema":{"type":"array","items":{"type":"string"}}},{"name":"flat","required":false,"in":"query","description":"Should the formula return as flattened?","schema":{"type":"boolean"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"Successfuly fetched formulas","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormulaResponseDto"}}}}},"403":{"description":"User does not have permission"}},"tags":["formulas"]},"post":{"operationId":"FormulaController_create","summary":"Create a new formula","parameters":[{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormulaPayload"}}}},"responses":{"201":{"description":"Successfuly created a formula","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormulaResponseDto"}}}},"400":{"description":"Payload is invalid - formula was not created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"403":{"description":"User does not have permission"},"409":{"description":"Formula's title is already being used in the relevant datasource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}}},"tags":["formulas"]}},"/formulas/usage":{"get":{"operationId":"FormulaController_getFormulaUsage","summary":"Get multiple formulas usage data","parameters":[{"name":"oids","required":false,"in":"query","description":"Relevant formula ids to fetch.","example":["925e8eae-c429-4f02-84da-1b1388ad19b9"],"schema":{"type":"array","items":{"type":"string"}}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"Successfuly fetched formulas usage data","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FormulaUsageDto"}}}}},"403":{"description":"User does not have permission"},"404":{"description":"Formulas were not found, usage data was not fetched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}}},"tags":["formulas"]}},"/formulas/{formulaId}":{"get":{"operationId":"FormulaController_getByFormulaId","summary":"Get a specific formula by id","parameters":[{"name":"flat","required":false,"in":"query","description":"Should the formula return as flattened?","schema":{"type":"boolean"}},{"name":"Id","required":true,"in":"path","description":"Id of the relevant formula.","example":"925e8eae-c429-4f02-84da-1b1388ad19b9","schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"200":{"description":"Successfuly fetched a formula.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormulaResponseDto"}}}},"403":{"description":"User does not have permission"},"404":{"description":"Formula with given id was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}}},"tags":["formulas"]},"patch":{"operationId":"FormulaController_update","summary":"Update an existing formula","parameters":[{"name":"flat","required":false,"in":"query","description":"Should the formula return as flattened?","schema":{"type":"boolean"}},{"name":"Id","required":true,"in":"path","description":"Id of the relevant formula.","example":"925e8eae-c429-4f02-84da-1b1388ad19b9","schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFormulaPayload"}}}},"responses":{"200":{"description":"Formula was updated successfuly.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormulaResponseDto"}}}},"400":{"description":"Payload is invalid - formula was not updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpExceptionDto"}}}},"403":{"description":"User does not have permission"}},"tags":["formulas"]},"delete":{"operationId":"FormulaController_delete","summary":"Delete a formula","parameters":[{"name":"Id","required":true,"in":"path","description":"Id of the relevant formula.","example":"925e8eae-c429-4f02-84da-1b1388ad19b9","schema":{"type":"string"}},{"in":"header","description":"Used to define the Tenant ID on behalf of whom the operation will be executed","name":"x-tenant-id","required":false,"type":"string"},{"description":"The user's API token preceded by the keyword `Bearer ` (with space between it and the token). For more information, see [API tutorial](http://developer.sisense.com/display/API2/Using+the+REST+API).","in":"header","name":"authorization","pattern":"^Bearer .*","required":false,"type":"string"}],"responses":{"204":{"description":"Formula was successfuly deleted."},"400":{"description":"Formula is being in widgets \\ dashboards \\ other formulas, and therefore cannot be deleted."},"403":{"description":"User does not have permission"}},"tags":["formulas"]}}},"components":{"schemas":{"DependenciesServiceResponseVoid":{"type":"object","properties":{"status":{"type":"string","enum":["OK","PENDING_DELETION","CANNOT_DELETE","NOT_FOUND","INTERNAL_ERROR"]},"value":{"type":"object"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"DependencyDocument":{"type":"object","properties":{"elementId":{"type":"string"},"resourceId":{"type":"string"},"resourceType":{"type":"string"},"dependentResourceId":{"type":"string"},"dependentResourceType":{"type":"string"}}},"ColumnsRef":{"type":"object","properties":{"dataset":{"type":"string"},"table":{"type":"string"},"column":{"type":"string"}}},"Perspective":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"schemaId":{"type":"string"},"datamodelId":{"type":"string","format":"uuid"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/PerspectiveTable"}},"lastUpdated":{"type":"string"},"perspectiveParentOid":{"type":"string","format":"uuid"},"name":{"type":"string"},"tenantId":{"type":"string"},"relations":{"type":"array","items":{"$ref":"#/components/schemas/Relation"}},"fiscalYear":{"type":"string"},"enableDimensionalModeling":{"type":"boolean"},"relationsTables":{"type":"array","items":{"$ref":"#/components/schemas/RelationsTables"}},"blacklistRelations":{"type":"array","items":{"$ref":"#/components/schemas/Relation"}},"default":{"type":"boolean"}}},"PerspectiveColumn":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"displayName":{"type":"string"},"semanticIndex":{"type":"boolean"},"role":{"type":"string","enum":["ATTRIBUTE","MEASURE","MEASURE_AND_ATTRIBUTE"]}}},"PerspectiveTable":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"id":{"type":"string"},"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"displayName":{"type":"string"},"role":{"type":"string","enum":["DIMENSION","FACT"]},"columns":{"type":"array","items":{"$ref":"#/components/schemas/PerspectiveColumn"}}}},"Relation":{"type":"object","properties":{"oid":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnsRef"}}}},"RelationsTables":{"type":"object","properties":{"firstTable":{"type":"string","format":"uuid"},"secondTable":{"type":"string","format":"uuid"},"directionType":{"type":"string","enum":["first2second","second2first","bidirectional"]},"joinType":{"type":"string","enum":["default","inner","left","right","full"]}}},"ValidateDimensionalModelPayload":{"type":"object","properties":{"perspective":{"$ref":"#/components/schemas/Perspective"}}},"ValidatePerspectiveForDMComplianceRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"validateDimensionalModelPayload":{"$ref":"#/components/schemas/ValidateDimensionalModelPayload"}}},"DimensionalModelValidationOutput":{"type":"object","properties":{"extraDetails":{"$ref":"#/components/schemas/ExtraDetails"},"valid":{"type":"boolean"}}},"ExtraDetails":{"type":"object","properties":{"warningType":{"type":"string","enum":["NO_FACT_TABLE","FACT_TABLE_WITHOUT_MEASURE","MULTIPLE_PATHS"]},"factTableWithoutMeasure":{"$ref":"#/components/schemas/Table"},"multiplePaths":{"$ref":"#/components/schemas/MultiplePaths"}}},"MultiplePaths":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Table"},"target":{"$ref":"#/components/schemas/Table"},"paths":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/Relationship"}}}}},"Relationship":{"type":"object","properties":{"from":{"$ref":"#/components/schemas/Table"},"to":{"$ref":"#/components/schemas/Table"}}},"Table":{"type":"object","properties":{"name":{"type":"string"},"oid":{"type":"string","format":"uuid"},"id":{"type":"string"},"type":{"type":"string"},"lastUpdated":{"type":"string"},"hidden":{"type":"boolean"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"buildBehavior":{"$ref":"#/components/schemas/BuildBehavior"},"expression":{"$ref":"#/components/schemas/Expression"},"schemaName":{"type":"string"},"configOptions":{"$ref":"#/components/schemas/ConfigOptions"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/Key"}},"isMaterialized":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"tuple-transformations":{"type":"array","items":{"$ref":"#/components/schemas/TupleTransformation"}},"vTag":{"type":"string"},"customCode":{"$ref":"#/components/schemas/CustomCode"}}},"TranslationServiceResponseDimensionalModelValidationOutput":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/DimensionalModelValidationOutput"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"Column":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"@id":{"type":"string","format":"uuid"},"name":{"type":"string"},"columnType":{"type":"string","enum":["BIGINT","DATETIME","DECIMAL","FLOAT","INT","REAL","TEXT","DOUBLE","NUMERIC","SMALLINT","TINYINT","BOOLEAN","CHAR","DATE","TIMESTAMP_WITH_TIMEZONE","TIME","TIME_WITH_TIMEZONE","UNSUPPORTED"]},"custom":{"$ref":"#/components/schemas/SqlExpression"},"table":{"$ref":"#/components/schemas/TableEntity"},"nestedIn":{"type":"string"},"indexed":{"type":"boolean"},"merged":{"type":"boolean"},"hidden":{"type":"boolean"},"description":{"type":"string"},"displayName":{"type":"string"},"semanticIndex":{"type":"boolean"},"@class":{"type":"string"},"id":{"type":"string"},"type":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"precision":{"type":"integer","format":"int32"},"scale":{"type":"integer","format":"int32"},"oid":{"type":"string"}},"required":["@class"]},"DataSchema":{"type":"object","properties":{"schemaId":{"type":"string"},"parentSchemaId":{"type":"string"},"ecmModelSchemaId":{"type":"string"},"schemaName":{"type":"string"},"datasources":{"type":"array","items":{"$ref":"#/components/schemas/Datasource"}},"tables":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/View"}},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/Relationship"}},"queryAeMode":{"type":"string","enum":["AE_ONLY","LEGACY","NEW_THEN_OLD","OLD_ONLY"]},"customTranslationMode":{"type":"string","enum":["SYSTEM","OT","AE"]},"indexed":{"type":"boolean"},"ecCloud":{"type":"boolean"},"b2D":{"type":"boolean"},"@id":{"type":"string"}}},"Datasource":{"type":"object","properties":{"name":{"type":"string"},"provider":{"$ref":"#/components/schemas/Provider"},"datasourceCatalogName":{"type":"string"},"datasourceSchemaName":{"type":"string"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/Table"}},"@id":{"type":"string","format":"uuid"}}},"Provider":{"type":"object","properties":{"providerId":{"type":"string"},"connectorId":{"type":"string"},"manifest":{"type":"object","additionalProperties":{"type":"object"}},"sqlGeneratingInfo":{"$ref":"#/components/schemas/SqlGeneratingInfo"}}},"SqlExpression":{"type":"object","properties":{"sqlExpressionString":{"type":"string"},"containsOuterJoin":{"type":"boolean"},"@id":{"type":"integer","format":"int32"}}},"SqlGeneratingInfo":{"type":"object","properties":{"identifierQuote":{"type":"string"},"nullOrdering":{"type":"string","enum":["firstDescLastAsc","firstAscLastDesc","firstDescFirstAsc","lastDescLastAsc"]},"unquotedCasingType":{"type":"string","enum":["unchanged","toUpper","toLower"]},"quotedCasingType":{"type":"string","enum":["unchanged","toUpper","toLower"]}}},"TableEntity":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"name":{"type":"string"},"@id":{"type":"string","format":"uuid"},"@class":{"type":"string"}},"required":["@class"]},"TranslateSqlToPhysicalWithDataSchemaRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"sql":{"type":"string"},"rowLimit":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int32"},"translationFlow":{"type":"string","enum":["PREVIEW","GENERATE_CUSTOM_ELEMENTS_SQLS"]}}},"View":{"type":"object","properties":{"name":{"type":"string"},"visible":{"type":"boolean"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"expression":{"type":"string"},"hasAnyRenameOrCustomColumn":{"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"displayName":{"type":"string"},"@id":{"type":"string","format":"uuid"}}},"TranslationServiceResponseObject":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"type":"object"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"TranslateSqlToPhysicalRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"schemaId":{"type":"string"},"sql":{"type":"string"},"server":{"type":"string"},"rowLimit":{"type":"integer","format":"int64"},"offset":{"type":"integer","format":"int32"},"sample":{"type":"integer","format":"int64"},"translationFlow":{"type":"string","enum":["PREVIEW","GENERATE_CUSTOM_ELEMENTS_SQLS"]},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"BuildDestinationParameters":{"type":"object","properties":{"database":{"type":"string"},"schema":{"type":"string"},"resultLimit":{"type":"integer","format":"int64"},"queryTimeout":{"type":"integer","format":"int32"}}},"Connection":{"type":"object","properties":{"provider":{"type":"string"},"schema":{"type":"string"},"resultLimit":{"type":"integer","format":"int64"},"timeout":{"type":"integer","format":"int32"},"parameters":{"$ref":"#/components/schemas/Parameters"},"oid":{"type":"string"},"oauth2":{"$ref":"#/components/schemas/OAuth2"},"base":{"type":"array","items":{"$ref":"#/components/schemas/BaseConnectionParameter"}}}},"Dataset":{"type":"object","properties":{"name":{"type":"string"},"oid":{"type":"string"},"type":{"type":"string"},"lastUpdated":{"type":"string"},"schema":{"$ref":"#/components/schemas/Schema"},"connection":{"$ref":"#/components/schemas/Connection"},"database":{"type":"string"},"schemaName":{"type":"string"}}},"EcmAccelerationParams":{"type":"object","properties":{"parentModelOid":{"type":"string"}}},"EcmModel":{"type":"object","properties":{"oid":{"type":"string"},"tenantId":{"type":"string"},"title":{"type":"string"},"schemaId":{"type":"string"},"server":{"type":"string"},"lastBuildTime":{"type":"string"},"lastBuildAttempt":{"type":"string"},"lastUpdated":{"type":"string"},"fiscal":{"type":"string"},"datasets":{"type":"array","items":{"$ref":"#/components/schemas/Dataset"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/Relation"}},"buildDestination":{"type":"string"},"buildDestinationParameters":{"$ref":"#/components/schemas/BuildDestinationParameters"},"analyticalEngine":{"$ref":"#/components/schemas/EcmModelAnalyticalEngineParams"},"queryAeMode":{"type":"string"},"customTranslationMode":{"type":"string"},"isEcCloud":{"type":"boolean"},"isB2D":{"type":"boolean"},"generateDependenciesMode":{"type":"string"},"modeling-transformations":{"type":"array","items":{"type":"object"}},"acceleration":{"$ref":"#/components/schemas/EcmAccelerationParams"},"modelStatistics":{"$ref":"#/components/schemas/EcmModelStatisticsParams"},"perspectives":{"type":"array","items":{"$ref":"#/components/schemas/Perspective"}},"relationType":{"type":"string"}}},"EcmModelAnalyticalEngineParams":{"type":"object","properties":{"queryAeMode":{"type":"string"},"generateDependenciesMode":{"type":"string"},"customTranslationMode":{"type":"string"}}},"EcmModelStatisticsParams":{"type":"object","properties":{"enableModelStatistics":{"type":"boolean"},"maxTablesPerCollection":{"type":"integer","format":"int32"},"recollectStatsInterval":{"type":"integer","format":"int32"}}},"Parameters":{"type":"object"},"Schema":{"type":"object","properties":{"id":{"type":"string"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/Table"}}}},"TranslateJaqlToDaqlRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"schemaId":{"type":"string"},"jaql":{"type":"string"},"obfuscateDataSecurity":{"type":"boolean"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"ecmModel":{"$ref":"#/components/schemas/EcmModel"}}},"TranslateJaqlToDaqlGetGraphRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaId":{"type":"string"},"jaql":{"type":"string"},"selectedStep":{"type":"string","enum":["JAQL_QUERY_CREATION","DAQL_QUERY_CREATION","DAQL_QUERY_PREPARATION","DAQL_QUERY_MEASURES_GROUPING"]},"obfuscateDataSecurity":{"type":"boolean"},"ecmModel":{"$ref":"#/components/schemas/EcmModel"},"parentDataSchema":{"$ref":"#/components/schemas/DataSchema"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"Additivity":{"type":"object","properties":{"exclude":{"type":"boolean"},"dimensions":{"type":"array","items":{"$ref":"#/components/schemas/Dimension"}}}},"BusinessProcessModel":{"type":"object","properties":{"name":{"type":"string"},"factTable":{"$ref":"#/components/schemas/View"},"facts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Fact"}},"attributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DimensionalAttribute"}},"factDimension":{"$ref":"#/components/schemas/Dimension"}}},"DaqlQuery":{"type":"object","properties":{"id":{"type":"string"},"dimensionalModel":{"$ref":"#/components/schemas/DimensionalModel"},"measureGroup":{"$ref":"#/components/schemas/MeasureGroupObject"},"limit":{"$ref":"#/components/schemas/Limit"},"resultSetColumnsOrder":{"type":"array","items":{"$ref":"#/components/schemas/ElementInteger"}}}},"Dimension":{"type":"object","properties":{"name":{"type":"string"},"underlyingView":{"$ref":"#/components/schemas/View"},"attributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DimensionalAttribute"}},"subDimensions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SubDimension"}},"@id":{"type":"integer","format":"int32"}}},"DimensionalAttribute":{"type":"object","properties":{"name":{"type":"string"},"dataType":{"type":"string","enum":["numeric","text","datetime","SISENSE_OID"]}}},"DimensionalAttributeMatch":{"type":"object","properties":{"origin":{"$ref":"#/components/schemas/DimensionalAttribute"},"target":{"$ref":"#/components/schemas/DimensionalAttribute"}}},"DimensionalModel":{"type":"object","properties":{"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"dimensions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Dimension"}},"businessProcessModels":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BusinessProcessModel"}},"hierarchies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Hierarchy"}},"valid":{"type":"boolean"},"adHocDM":{"type":"boolean"}}},"ElementInteger":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"elementRef":{"type":"integer","format":"int32"},"elementType":{"type":"string","enum":["SLICER","MEASURE"]},"@class":{"type":"string"}},"required":["@class"]},"Fact":{"type":"object","properties":{"attribute":{"$ref":"#/components/schemas/DimensionalAttribute"},"additivity":{"$ref":"#/components/schemas/Additivity"}}},"Hierarchy":{"type":"object","properties":{"name":{"type":"string"},"hierarchyAttributes":{"type":"array","items":{"$ref":"#/components/schemas/DimensionalAttribute"}}}},"Limit":{"type":"object","properties":{"offset":{"type":"integer","format":"int32"},"fetch":{"type":"integer","format":"int32"}}},"MeasureGroupObject":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"measures":{"type":"array","items":{"type":"object"}},"@class":{"type":"string"},"@id":{"type":"integer","format":"int32"}},"required":["@class"]},"SubDimension":{"type":"object","properties":{"name":{"type":"string"},"dimension":{"$ref":"#/components/schemas/Dimension"},"matchingAttributes":{"type":"array","items":{"$ref":"#/components/schemas/DimensionalAttributeMatch"}}}},"TranslateDaqlToSQLRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"daqlQuery":{"$ref":"#/components/schemas/DaqlQuery"},"connectorConfigParamsMap":{"type":"object","additionalProperties":{"type":"string"}},"obfuscateDataSecurity":{"type":"boolean"}}},"DataContext":{"type":"object","properties":{"filterScope":{"type":"string","enum":["UNKNOWN","dynamic","static"]},"dimensionContexts":{"type":"array","items":{"$ref":"#/components/schemas/DimensionContext"},"properties":{"empty":{"type":"boolean"}}}}},"DimensionContext":{"type":"object","properties":{"dimensionName":{"type":"string"},"members":{"type":"array","items":{"type":"string"}},"allMembers":{"type":"boolean"},"policy":{"type":"string","enum":["Whitelist","Blacklist","InQuery","Always"]},"tables":{"type":"string"},"column":{"type":"string"},"table":{"type":"string"},"cubeId":{"type":"string"},"dataSourceId":{"type":"string"},"exclusionary":{"type":"boolean"}}},"TranslateByDataContextRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"schemaId":{"type":"string"},"jaql":{"type":"string"},"obfuscateDataSecurity":{"type":"boolean"},"dataContext":{"$ref":"#/components/schemas/DataContext"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"ecmModel":{"$ref":"#/components/schemas/EcmModel"}}},"ParseFormulaRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"schemaId":{"type":"string"},"query":{"type":"string"},"ecmModel":{"$ref":"#/components/schemas/EcmModel"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"ParseCalculatedDimensionFormulaRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaId":{"type":"string"},"query":{"type":"string"},"ecmModel":{"$ref":"#/components/schemas/EcmModel"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"SqlQueryRowMetaDataRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"customTableQuery":{"$ref":"#/components/schemas/SqlExpression"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"ColumnNameAndType":{"type":"object","properties":{"logicalColumnName":{"type":"string"},"sqlDbType":{"type":"string","enum":["Unsupported","BigInt","Boolean","Char","Timestamp","Decimal","Float","Integer","Real","SmallInt","VarChar","TinyInt","Date","Time","Double","Numeric","TimestampWithTimezone","TimeWithTimezone"]}}},"TranslationServiceResponseListColumnNameAndType":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"type":"array","items":{"$ref":"#/components/schemas/ColumnNameAndType"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"GetQueryPlanAnalyzerRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"relWriterOutputFormatString":{"type":"string"},"showLogicalNames":{"type":"boolean"},"daqlResponse":{"$ref":"#/components/schemas/TranslationServiceResponseTranslationDaqlResponse"},"modelId":{"type":"string"}}},"TranslationDaqlResponse":{"type":"object","properties":{"status":{"type":"string"},"error":{"type":"string"},"translationServiceType":{"type":"string","enum":["TranslationService","NewTranslationService"]},"daqlQuery":{"$ref":"#/components/schemas/DaqlQuery"},"previousFailedResponses":{"type":"array","items":{"$ref":"#/components/schemas/TranslationDaqlResponse"}},"obfuscateDataSecurity":{"type":"boolean"}}},"TranslationServiceResponseTranslationDaqlResponse":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/TranslationDaqlResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"TranslationServiceResponseString":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"type":"string"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"CustomColumnSqlTypeRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"logicalTableName":{"type":"string"},"customColumnExpression":{"$ref":"#/components/schemas/SqlExpression"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"TranslationServiceResponseSqlDbType":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"type":"string","enum":["Unsupported","BigInt","Boolean","Char","Timestamp","Decimal","Float","Integer","Real","SmallInt","VarChar","TinyInt","Date","Time","Double","Numeric","TimestampWithTimezone","TimeWithTimezone"]},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"GetConnectedTablesRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaId":{"type":"string"},"tableName":{"type":"string"},"maxDistance":{"type":"integer","format":"int32"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"TranslationServiceResponseString[]":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"type":"array","items":{"type":"string"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"GenerateSqlWithCommentRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"schemaId":{"type":"string"},"sqlExpression":{"$ref":"#/components/schemas/SqlExpression"},"comment":{"$ref":"#/components/schemas/JSONObject"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"schemaOfNonRootPerspectiveOrDM":{"type":"boolean"}}},"JSONObject":{"type":"object","properties":{"empty":{"type":"boolean"}}},"TranslationServiceResponseSqlExpression":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/SqlExpression"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ColumnFilter":{"type":"object","properties":{"column":{"$ref":"#/components/schemas/Column"},"operator":{"type":"string","enum":["EQUALS","NOT_EQUAL","LARGER","LARGER_EQUAL","SMALLER","SMALLER_EQUAL"]},"comparedValue":{"$ref":"#/components/schemas/ConstantValueObject"}}},"ConstantValueObject":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"value":{"type":"object"},"@class":{"type":"string"}},"required":["@class"]},"GenerateImportTableSqlRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"table":{"$ref":"#/components/schemas/Table"},"sqlTableOperations":{"$ref":"#/components/schemas/SqlTableOperations"}}},"SqlTableOperations":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}},"columnFilter":{"$ref":"#/components/schemas/ColumnFilter"},"limit":{"$ref":"#/components/schemas/Limit"},"count":{"type":"boolean"},"sqlOperationsConfig":{"type":"string","enum":["APPLY_OPERATIONS_AND_OPTIMIZE","APPLY_OPERATIONS","NO_OPERATIONS"]},"scanNamingDepth":{"type":"string","enum":["CATALOG_SCHEMA_TABLE","SCHEMA_TABLE","TABLE"]}}},"TranslationServiceResponseTranslationSqlResponse":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/TranslationSqlResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"TranslationSqlResponse":{"type":"object","properties":{"status":{"type":"string"},"error":{"type":"string"},"translationServiceType":{"type":"string","enum":["TranslationService","NewTranslationService"]},"sqlExpression":{"$ref":"#/components/schemas/SqlExpression"},"sqlFromCache":{"type":"boolean"},"isAeMode":{"type":"boolean"},"translationStrategy":{"type":"string"},"previousFailedResponses":{"type":"array","items":{"$ref":"#/components/schemas/TranslationSqlResponse"}}}},"ColumnRefImp":{"type":"object","properties":{"tableName":{"type":"string"},"columnName":{"type":"string"}}},"CustomColumn":{"type":"object","properties":{"logicalTableName":{"type":"string"},"logicalColumnName":{"type":"string"},"columnGeneratingExpression":{"type":"string"}}},"CustomTable":{"type":"object","properties":{"logicalTableName":{"type":"string"},"tableGeneratingQuery":{"type":"string"}}},"DataColumn":{"type":"object","properties":{"indexed":{"type":"boolean"},"logicalColumnName":{"type":"string"},"logicalColumnType":{"type":"string","enum":["BIGINT","DATETIME","DECIMAL","FLOAT","INT","REAL","TEXT","DOUBLE","NUMERIC","SMALLINT","TINYINT","BOOLEAN","CHAR","DATE","TIMESTAMP_WITH_TIMEZONE","TIME","TIME_WITH_TIMEZONE","UNSUPPORTED"]}}},"DataTable":{"type":"object","properties":{"logicalTableName":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DataColumn"}}}},"DatabaseSchema":{"type":"object","properties":{"schemaId":{"type":"string"},"schemaName":{"type":"string"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/DataTable"}},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/Relationship"}}}},"GenerateDependenciesRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaEtlPayload":{"$ref":"#/components/schemas/SchemaEtlPayload"}}},"SchemaEtlPayload":{"type":"object","properties":{"monetDbSchema":{"$ref":"#/components/schemas/DatabaseSchema"},"customTables":{"type":"array","items":{"$ref":"#/components/schemas/CustomTable"}},"customColumns":{"type":"array","items":{"$ref":"#/components/schemas/CustomColumn"}},"ecmModelOid":{"type":"string"}}},"CustomColumnDependencies":{"type":"object","properties":{"logicalTableName":{"type":"string"},"logicalColumnName":{"type":"string"},"dependencies":{"$ref":"#/components/schemas/CustomElementDependencies"}}},"CustomElementDependencies":{"type":"object","properties":{"baseTables":{"type":"array","items":{"type":"string"}},"customTables":{"type":"array","items":{"type":"string"}},"customCodeTables":{"type":"array","items":{"type":"string"}},"customColumns":{"type":"array","items":{"$ref":"#/components/schemas/ColumnRefImp"}}}},"CustomTableDependencies":{"type":"object","properties":{"logicalTableName":{"type":"string"},"dependencies":{"$ref":"#/components/schemas/CustomElementDependencies"}}},"GenerateDependenciesResponse":{"type":"object","properties":{"customTables":{"type":"array","items":{"$ref":"#/components/schemas/CustomTableDependencies"}},"customColumns":{"type":"array","items":{"$ref":"#/components/schemas/CustomColumnDependencies"}}}},"TranslationServiceResponseGenerateDependenciesResponse":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/GenerateDependenciesResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"GenerateCustomTableQueryRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaName":{"type":"string"},"logicalTableName":{"type":"string"},"tablePhysicalName":{"type":"string"},"customTableQuery":{"$ref":"#/components/schemas/SqlExpression"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"generatedColumns":{"type":"array","items":{"type":"string"},"uniqueItems":true},"queryWrapper":{"type":"string","enum":["NONE","SELECT_INTO","INSERT_INTO","CREATE_TABLE","CREATE_VIEW","CREATE_MATERIALIZED_VIEW"]}}},"GenerateCustomSqlForRecalculateRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"targetSchemaName":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnName":{"type":"string"},"tempColumnName":{"type":"string"},"objectId":{"type":"string"},"dimTableName":{"type":"string"},"dimColumnName":{"type":"array","items":{"type":"string"}},"recalculateType":{"type":"string","enum":["INDEXED_TO_NON_INDEXED","NON_INDEXED_TO_INDEXED"]}}},"GenerateCustomElementsSqlsRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaEtlPayload":{"$ref":"#/components/schemas/SchemaEtlPayload"}}},"GenerateCustomElementsSqlsResponse":{"type":"object","properties":{"customTables":{"type":"array","items":{"$ref":"#/components/schemas/CustomTable"}},"customColumns":{"type":"array","items":{"$ref":"#/components/schemas/CustomColumn"}}}},"TranslationServiceResponseGenerateCustomElementsSqlsResponse":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/GenerateCustomElementsSqlsResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"GenerateCustomColumnsUpdateStatementRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"targetSchemaName":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"},"customColumnExpressions":{"type":"array","items":{"$ref":"#/components/schemas/CustomColumn"}},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"sisenseIdentifier":{"type":"string"}}},"FieldsSearchRequestAE":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"dataSourceType":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"schemaId":{"type":"string"},"query":{"type":"string"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"EcmModelVerificationRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"ecmModel":{"$ref":"#/components/schemas/EcmModel"}}},"EcmQueryValidationResponse":{"type":"object","properties":{"status":{"type":"string"},"error":{"type":"string"},"translationServiceType":{"type":"string","enum":["TranslationService","NewTranslationService"]},"sqlNodeDetectionResult":{"$ref":"#/components/schemas/SqlNodeDetectionResult"}}},"SqlNodeDetectionResult":{"type":"object","properties":{"valid":{"type":"boolean"},"errorMessage":{"type":"string"},"primaryKeyTablesUUID":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"TranslationServiceResponseEcmQueryValidationResponse":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"$ref":"#/components/schemas/EcmQueryValidationResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"CanBeSupportedRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"schemaId":{"type":"string"},"forQueryContext":{"type":"boolean"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"},"schemaOfNonRootPerspectiveOrWithDimensionalModelingEnabled":{"type":"boolean"}}},"ApplyExecutionInstructionAsCommentToSqlRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"queryGuid":{"type":"string"},"m2mThresholdFlag":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"sqlExpression":{"$ref":"#/components/schemas/SqlExpression"}}},"AnalyzeCustomTableDependenciesRequest":{"type":"object","properties":{"configurationParameterMap":{"type":"object","additionalProperties":{"type":"object"}},"customTableQuery":{"$ref":"#/components/schemas/SqlExpression"},"dataSchema":{"$ref":"#/components/schemas/DataSchema"}}},"TranslationServiceResponseListLogicalTableName":{"type":"object","properties":{"status":{"type":"string","enum":["OK","TRANSLATION_ERROR","TRANSLATION_INVALID_REQUEST","FAILED_TO_GENERATE_CUSTOM_ELEMENTS_SQL","FAILED_TO_GENERATE_DEPENDENCIES","CUSTOM_COLUMN_ERROR","CUSTOM_TABLE_ERROR","FAILED_TO_GET_CONTEXT_FROM_EXPRESSION","FAILED_TO_SEARCH_FIELDS","FIELD_SEARCH_TERM_NOT_SUPPORTED","FAILED_PARSING","SQL_OPERATIONS_ERROR","FAILED_TO_RETRIEVE_CONNECTED_TABLES","FAILED_TO_RETRIEVE_GRAPH_IMAGES","TRANSLATION_UNSUPPORTED_FUNCTIONALITY_REQUEST","FAILED_TO_RETRIEVE_CUSTOM_COLUMN_SQL_TYPE","FAILED_TO_RETRIEVE_SQL_QUERY_ROW_META_DATA","FAILED_TO_ANALYZE_CUSTOM_TABLE_DEPENDENCIES","FAILED_TO_GENERATE_IMPORT_TABLE_SQL","FORMULA_CONTAINS_COMPARISON_OPERATORS_IN_FILTER","FAILED_TO_GENERATE_SQL_WITH_COMMENT","FAILED_TO_APPLY_EXECUTION_INSTRUCTION_AS_COMMENT_TO_SQL","FAILED_TO_VALIDATE_PERSPECTIVE_FOR_DM_COMPLIANCE","FAILED_TO_VERIFY_ECM_MODEL","FAILED_TO_GET_QUERY_PLAN_ANALYZER","NOT_IMPLEMENTED"]},"value":{"type":"array","items":{"type":"string"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"Version":{"type":"object","properties":{"version":{"type":"string"},"productBuild":{"type":"string"},"serviceBuild":{"type":"string"},"deployedTime":{"type":"string"},"buildTime":{"type":"string"},"commitId":{"type":"string"}}},"DependenciesServiceResponseListDependencyDocument":{"type":"object","properties":{"status":{"type":"string","enum":["OK","PENDING_DELETION","CANNOT_DELETE","NOT_FOUND","INTERNAL_ERROR"]},"value":{"type":"array","items":{"$ref":"#/components/schemas/DependencyDocument"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ConnectionResponse":{"type":"object","description":"Connection response schema description","properties":{"tenantId":{"description":"Unique tenant identifier","example":"66a249b5bd96eb001b73aed3"},"oid":{"description":"Unique connection identifier","example":"84570e97-bbc4-4e62-a0b3-77cdc8abf340"},"name":{"description":"Connection name","example":"Redshift internal"},"provider":{"description":"Connection provider","example":"RedShift"},"parameters":{"description":"Connection parameters","example":{"UserName":"administrator","DefaultDatabase":"dev","Server":"server.redshift.amazonaws.com","AdditionalParameters":"","UseDynamicSchema":false,"EncryptConnection":false}},"enabled":{"description":"Connection availability","example":true},"created":{"description":"Date when the connection was created","example":"2024-07-29T10:26:10.605+00:00"},"lastModified":{"description":"Date when the connection was last modified","example":"2024-07-29T10:26:10.605+00:00"},"supportedModelTypes":{"description":"List of supported model types for the connection","example":["EXTRACT"]},"ownerId":{"description":"User identifier that owns the connection","example":"66a249b5bd96eb001b73aec6"},"createdByUser":{"description":"Connection was created by a user or generated","example":true},"protectedParameters":{"description":"List of the connection protected parameters","example":["Password"]},"description":{"description":"Description of the connection","example":"Connection to Redshift staging DB used for internal purposes"},"shares":{"description":"List of user that have permission to use the connection","example":[""]},"connectionPermissions":{"description":"List of action permitted for the connection","example":["READ","OWNER"]}}},"ConnectionRequest":{"type":"object","properties":{"name":{"description":"Connection name","example":"Redshift internal"},"provider":{"description":"Connection provider","example":"RedShift"},"parameters":{"description":"Connection parameters","example":{"UserName":"administrator","DefaultDatabase":"dev","Server":"server.redshift.amazonaws.com","AdditionalParameters":"","UseDynamicSchema":false,"EncryptConnection":false}},"supportedModelTypes":{"description":"List of supported model types for the connection","example":["EXTRACT"]},"description":{"description":"Description of the connection","example":"Connection to Redshift staging DB used for internal purposes"},"ownerId":{"description":"User identifier that owns the connection","example":"66a249b5bd96eb001b73aec6"},"createdByUser":{"description":"Connection was created by a user or generated","example":true},"enabled":{"description":"Connection availability","example":true}}},"ConnectionUpdateRequest":{"type":"object","properties":{"name":{"description":"Connection name","example":"Redshift internal"},"provider":{"description":"Connection provider","example":"RedShift"},"parameters":{"description":"Connection parameters","example":{"UserName":"administrator","DefaultDatabase":"dev","Server":"server.redshift.amazonaws.com","AdditionalParameters":"","UseDynamicSchema":false,"EncryptConnection":false}},"supportedModelTypes":{"description":"List of supported model types for the connection","example":["EXTRACT"]},"description":{"description":"Description of the connection","example":"Connection to Redshift staging DB used for internal purposes"}}},"NotebookRequest":{"type":"object","description":"New Notebook object","properties":{"name":{"type":"string"},"notebookPath":{"type":"string"},"manifestPath":{"type":"string"},"notebookType":{"type":"string"}}},"NotebookResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"notebookPath":{"type":"string"},"manifestPath":{"type":"string"},"shares":{"type":"array","items":{"$ref":"#/components/schemas/SharedNotebookResponse"}},"permissions":{"type":"array","items":{"type":"string","enum":["OWNER","CREATE","EDIT","READ","USE","SHARE_USE","SHARE_READ","SHARE_EDIT","DUPLICATE","DELETE"]},"uniqueItems":true},"notebookType":{"type":"string"}}},"Principal":{"type":"object","properties":{"type":{"type":"string","description":"Describe the type of entity.","enum":["USER","GROUP"],"example":"USER"},"id":{"type":"string","description":"Entity unique identifier","example":"66e6dae333ce76002eb0e604"}}},"SharedNotebookResponse":{"type":"object","properties":{"principal":{"$ref":"#/components/schemas/Principal"},"permission":{"type":"string","enum":["OWNER","CREATE","EDIT","READ","USE","SHARE_USE","SHARE_READ","SHARE_EDIT","DUPLICATE","DELETE"]}}},"Error":{"type":"object","properties":{"type":{"type":"string","description":"When applicable, this URI will can be used to identify the specific error and find additional information about it.","example":"https://errors.sisense.dev/http/some-error"},"title":{"type":"string","description":"A short name for the error.","example":"Some error"},"status":{"type":"integer","format":"int32","description":"The HTTP code of the response.","example":400},"sub":{"type":"integer","format":"int32","description":"When applicable, a specific error sub-code.","example":40010},"detail":{"type":"string","description":"A detailed error message.","example":"Some error has occured with your request and this is a detailed message about it"},"instance":{"type":"string","description":"When applicable, a relative URI of affected/offensive resource.","example":"/api/users/12345"},"logref":{"type":"string","description":"When applicable, a reference to the log entry representing the error's occurrence."}},"required":["status","title"]},"TrackingInput":{"type":"object","properties":{"prod":{"type":"string"},"cat":{"type":"string"},"action":{"type":"string"},"isChecked":{"type":"boolean"},"actionTimestamp":{"type":"string","format":"date-time"}}},"EncryptionRequest":{"type":"object","description":"Encryption request object","properties":{"plaintextItems":{"type":"object","additionalProperties":{"type":"string","description":"Key-value pairs, where the value is a base64-encoded data chunk to encrypt, and the key is its ID","example":"{\"password\":\"dGVzdGluZ3Rlc3Rpbmc=\",\"another_secret\":\"Y3JlZGl0IGNhcmQ=\",\"yet_another_secret\":\"UElOIGNvZGU=\"}"},"description":"Key-value pairs, where the value is a base64-encoded data chunk to encrypt, and the key is its ID","example":{"password":"dGVzdGluZ3Rlc3Rpbmc=","another_secret":"Y3JlZGl0IGNhcmQ=","yet_another_secret":"UElOIGNvZGU="}}},"required":["plaintextItems"]},"Encryption Response":{"type":"object","description":"The result of an encryption operation","properties":{"encryptedItems":{"type":"object","additionalProperties":{"type":"string","description":"Key-value pairs, where the value is a result of encrypting a single data chunk, and the key is the id of that chunk","example":"{\"password\":\"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJyN0RFelRld2lCbm02Q1d0anFjWWFRPT0iLCJub25jZSI6InpobGpCK2dPTk9vSnY0VU1sOGU5V0E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=\",\"another_secret\":\"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJwb1ZqM3hFd3BxbFl1T3VrRitidmZBPT0iLCJub25jZSI6Ik1HeTlZbGJTMEM0UVJYOW1ZVFEra1E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=\",\"yet_another_secret\":\"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJaeDhoOU1Eczdlc3RQRDcycGdwbVRBPT0iLCJub25jZSI6Im9EcXU3akpEbFBmaEVMck1QNHM1Nmc9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=\"}"},"description":"Key-value pairs, where the value is a result of encrypting a single data chunk, and the key is the id of that chunk","example":{"password":"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJyN0RFelRld2lCbm02Q1d0anFjWWFRPT0iLCJub25jZSI6InpobGpCK2dPTk9vSnY0VU1sOGU5V0E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=","another_secret":"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJwb1ZqM3hFd3BxbFl1T3VrRitidmZBPT0iLCJub25jZSI6Ik1HeTlZbGJTMEM0UVJYOW1ZVFEra1E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=","yet_another_secret":"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJaeDhoOU1Eczdlc3RQRDcycGdwbVRBPT0iLCJub25jZSI6Im9EcXU3akpEbFBmaEVMck1QNHM1Nmc9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0="}}},"required":["encryptedItems"]},"Decryption Request":{"type":"object","description":"Decryption request object","properties":{"encryptedItems":{"type":"object","additionalProperties":{"type":"string","description":"Key-value pairs, where the value is a result of a previous encryption operation, and the key is its ID","example":"{\"password\":\"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJyN0RFelRld2lCbm02Q1d0anFjWWFRPT0iLCJub25jZSI6InpobGpCK2dPTk9vSnY0VU1sOGU5V0E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=\",\"another_secret\":\"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJwb1ZqM3hFd3BxbFl1T3VrRitidmZBPT0iLCJub25jZSI6Ik1HeTlZbGJTMEM0UVJYOW1ZVFEra1E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=\",\"yet_another_secret\":\"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJaeDhoOU1Eczdlc3RQRDcycGdwbVRBPT0iLCJub25jZSI6Im9EcXU3akpEbFBmaEVMck1QNHM1Nmc9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=\"}"},"description":"Key-value pairs, where the value is a result of a previous encryption operation, and the key is its ID","example":{"password":"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJyN0RFelRld2lCbm02Q1d0anFjWWFRPT0iLCJub25jZSI6InpobGpCK2dPTk9vSnY0VU1sOGU5V0E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=","another_secret":"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJwb1ZqM3hFd3BxbFl1T3VrRitidmZBPT0iLCJub25jZSI6Ik1HeTlZbGJTMEM0UVJYOW1ZVFEra1E9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0=","yet_another_secret":"eyJlbmNyeXB0ZWREYXRhIjp7ImNpcGhlcnRleHQiOiJaeDhoOU1Eczdlc3RQRDcycGdwbVRBPT0iLCJub25jZSI6Im9EcXU3akpEbFBmaEVMck1QNHM1Nmc9PSJ9LCJlbmNyeXB0aW9uTWV0YWRhdGEiOnsicHJvdmlkZXIiOiJMT0NBTCIsImtleUlkIjoiMTIzIiwiZW5jcnlwdGlvblRpbWUiOiIyMDIyLTA0LTI1VDEzOjM4OjEyLjEwNzc3NDI4NloifX0="}}},"required":["encryptedItems"]},"Decryption Response":{"type":"object","description":"The result of a decryption operation","properties":{"plaintextItems":{"type":"object","additionalProperties":{"type":"string","description":"Key-value pairs, where the value is a decrypted and base64-encoded data chunk, and the key is the id of that chunk","example":"{\"password\":\"UElOIGNvZGU=\",\"another_secret\":\"Y3JlZGl0IGNhcmQ=\",\"yet_another_secret\":\"UElOIGNvZGU\"}"},"description":"Key-value pairs, where the value is a decrypted and base64-encoded data chunk, and the key is the id of that chunk","example":{"password":"UElOIGNvZGU=","another_secret":"Y3JlZGl0IGNhcmQ=","yet_another_secret":"UElOIGNvZGU"}}},"required":["plaintextItems"]},"DecryptionCustomRequest":{"type":"object","description":"Custom decryption request object","properties":{"encodedString":{"type":"string"},"key":{"type":"object","properties":{"encoded":{"type":"string","format":"byte"},"format":{"type":"string"},"algorithm":{"type":"string"},"destroyed":{"type":"boolean"}}},"iv":{"type":"object","properties":{"iv":{"type":"string","format":"byte"}}}}},"SharedConnectionResponse":{"type":"object","properties":{"principal":{"$ref":"#/components/schemas/Principal"},"permission":{"type":"string","enum":["OWNER","EDIT","USE","READ"]}}},"PhysicalSqlRequest":{"type":"object","description":"The physical request as json","properties":{"guid":{"type":"string"},"sql":{"type":"string"},"includeHeader":{"type":"boolean"},"includeType":{"type":"boolean"},"queryTimeout":{"type":"integer","format":"int32"}}},"StreamingResponseBody":{"type":"object"},"SqlCommandsRequestParameters":{"type":"object","properties":{"provider":{"type":"string"},"connectionString":{"type":"string"},"sqlQuery":{"type":"string"},"tableName":{"type":"string"},"columnIndexes":{"type":"array","items":{"type":"integer","format":"int32"}},"rows":{"type":"array","items":{"type":"array","items":{"type":"object"}}}}},"ColumnMetaData":{"type":"object","properties":{"name":{"type":"string"},"dataType":{"type":"integer","format":"int32"}}},"IQueryServiceResponseStatus":{"type":"object","properties":{"ok":{"type":"boolean"},"description":{"type":"string"}}},"QueryServiceResponseStatementMetaData":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IQueryServiceResponseStatus"},"value":{"$ref":"#/components/schemas/StatementMetaData"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"SqlMetaData":{"type":"object","properties":{"headers":{"type":"array","items":{"type":"string"}},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/ColumnMetaData"}}}},"StatementMetaData":{"type":"object","properties":{"sqlMetaData":{"$ref":"#/components/schemas/SqlMetaData"},"physicalSql":{"type":"string"},"hostName":{"type":"string"},"port":{"type":"integer","format":"int32"}}},"CustomCode":{"type":"object","description":"customCode object to get the table schema","properties":{"serverUrl":{"type":"string"},"codePath":{"type":"string"},"language":{"type":"string","enum":["Python","R"]},"mode":{"type":"string","enum":["Full","Post","Pre"]},"timeout":{"type":"integer","format":"int32"},"cellsDisable":{"type":"array","items":{"type":"integer","format":"int32"}},"dependsOn":{"type":"array","items":{"$ref":"#/components/schemas/ColumnsRef"}},"additionalParameters":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"ConnectionParameters":{"type":"object","description":"The connection parameters for a specific datasource","properties":{"connection":{"type":"object","description":"Key value pairs of connection properties for specific connector. Values must be strings or array of strings.","example":{"ApiVersion":2,"Server":"string","UserName":"string","Password":"string","DefaultDatabase":"postgres","EncryptConnection":false,"AdditionalParameters":"string","Database":"string"}},"schema":{"type":"string","description":"Database schema"},"table":{"type":"string","description":"Table name"},"limit":{"type":"integer","format":"int32","example":0},"fetchRelations":{"type":"boolean","description":"Used in schema details api. Tells api to return table relations next to columns"},"sql":{"type":"string"}},"required":["connection"]},"ConnectionStatus":{"type":"object","properties":{"status":{"type":"string"}}},"TableColumn":{"type":"object","properties":{"columnName":{"type":"string"},"columnOrder":{"type":"integer","format":"int32","example":0},"dbType":{"type":"integer","format":"int32","example":0},"size":{"type":"integer","format":"int32","example":0},"precision":{"type":"integer","format":"int32","example":0},"scale":{"type":"integer","format":"int32","example":0}}},"TableRelation":{"type":"object","properties":{"fkName":{"type":"string"},"parentSchema":{"type":"string"},"parentTable":{"type":"string"},"parentColumns":{"type":"array","items":{"type":"string"}},"childSchema":{"type":"string"},"childTable":{"type":"string"},"childColumns":{"type":"array","items":{"type":"string"}}}},"TableSchema":{"type":"object","properties":{"catalog":{"type":"string"},"schemaName":{"type":"string"},"tableName":{"type":"string"},"tableType":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/TableColumn"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/TableRelation"}}}},"DataPreview":{"type":"object","properties":{"headers":{"type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"string"}}}},"ConnectorCount":{"type":"object","properties":{"count":{"type":"string"}}},"NotebookParameters":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"codePath":{"type":"string"},"description":{"type":"string"},"group":{"type":"string"},"icon":{"type":"string"},"cellsDisable":{"type":"array","items":{"type":"integer","format":"int32"}},"additionalParameters":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"columns":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"isActive":{"type":"boolean"},"isSystem":{"type":"boolean"},"language":{"type":"string"},"mode":{"type":"string"},"serverUrl":{"type":"string"},"uuid":{"type":"string"},"shares":{"type":"array","items":{"$ref":"#/components/schemas/SharedNotebookResponse"}},"permissions":{"type":"array","items":{"type":"string","enum":["OWNER","CREATE","EDIT","READ","USE","SHARE_USE","SHARE_READ","SHARE_EDIT","DUPLICATE","DELETE"]},"uniqueItems":true},"notebookType":{"type":"string"},"timeout":{"type":"integer","format":"int32"},"isTableDiscoveryEnabled":{"type":"boolean"},"notebookCode":{"type":"object","additionalProperties":{"type":"object"}}}},"DataSource":{"type":"object","properties":{"get_id":{"type":"string"},"owner":{"type":"string"},"provider":{"type":"string"},"timeout":{"type":"integer","format":"int32","example":0},"refreshRate":{"type":"integer","format":"int32","example":0},"timezone":{"type":"string"},"schema":{"type":"string"},"parameters":{"type":"object"}}},"StartCubeResponse":{"type":"object","properties":{"status":{"type":"string"}}},"NotebookShareRequest":{"type":"object","description":"Share permission object","properties":{"principal":{"$ref":"#/components/schemas/Principal"},"permission":{"type":"string","enum":["OWNER","CREATE","EDIT","READ","USE","SHARE_USE","SHARE_READ","SHARE_EDIT","DUPLICATE","DELETE"]}}},"NotebookShareRequests":{"type":"object","description":"Share permission object","properties":{"shares":{"type":"array","items":{"$ref":"#/components/schemas/NotebookShareRequest"}}}},"ConnectionShareRequest":{"type":"object","properties":{"principal":{"$ref":"#/components/schemas/Principal","description":"Description of entity to updated"},"permission":{"type":"string","description":"Type of permission for the connection","enum":["OWNER","EDIT","USE","READ"],"example":"EDIT"}}},"ConnectionShareRequests":{"type":"object","description":"Share permission object","properties":{"shares":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionShareRequest"}}}},"AuthzInfo":{"type":"object","properties":{"principalType":{"type":"string"},"principalId":{"type":"string"},"scope":{"type":"string"},"authzInfoType":{"type":"string","enum":["SYSTEM","USER"]}}},"ConnectionDocument":{"type":"object","properties":{"tenantId":{"type":"string"},"connectionId":{"type":"string"},"name":{"type":"string"},"provider":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"object"}},"protectedParameters":{"type":"object","additionalProperties":{"type":"object"}},"enabled":{"type":"boolean"},"ownerId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"supportedModelTypes":{"type":"array","items":{"type":"string","enum":["LIVE","EXTRACT","WRITE","NOTEBOOK"]}},"createdByUser":{"type":"boolean"},"schema":{"type":"string"},"timeout":{"type":"integer","format":"int32"},"resultLimit":{"type":"integer","format":"int64"},"autoRefresh":{"type":"boolean"},"refreshRate":{"type":"integer","format":"int32"},"description":{"type":"string"},"authz":{"type":"array","items":{"$ref":"#/components/schemas/AuthzInfo"}},"permissions":{"type":"string"},"buildDestination":{"type":"string"},"verificationHash":{"type":"integer","format":"int32"},"managedBySisense":{"type":"boolean"}}},"ConnectionManagementResponseConnectionDocument":{"type":"object","properties":{"status":{"type":"string","enum":["OK","INTERNAL_ERROR","CONNECTION_NOT_FOUND","FAILED_ENCRYPT","FAILED_TO_CREATE","CONNECTION_MUST_HAVE_PARAMETER","NOT_AUTHORIZED","NOT_MODIFIED","PARTIAL_CONTENT","DESCRIPTION_MAX_LENGTH","NAME_VALIDATE_LENGTH","DUPLICATION","PARTIAL_MIGRATION","CONNECTION_ALREADY_EXIST","INVALID_CONNECTION_ID","INVALID_SHARES_ID","REQUEST_NOT_VALID","CONNECTION_HAS_DEPENDENCIES","INVALID_SUGGESTED_OID","REUSE_CONNECTION","DEFAULT_DB_REQUIRED","CANT_BE_MODIFIED"]},"value":{"$ref":"#/components/schemas/ConnectionDocument"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"LiveConnector":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"BaseConnectionParameter":{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"titleTranslationKey":{"type":"string"},"type":{"type":"string"},"icon":{"type":"string"},"required":{"type":"boolean"},"send":{"type":"boolean"},"description":{"type":"string"},"descriptionTranslationKey":{"type":"string"},"pattern":{"type":"string"},"trim":{"type":"boolean"},"min":{"type":"integer","format":"int32","example":0},"max":{"type":"integer","format":"int32","example":0},"multivalue":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"availableIf":{"$ref":"#/components/schemas/Condition"},"default":{"type":"string"}}},"Condition":{"type":"object","properties":{"parameter":{"type":"string"},"hasValue":{"type":"string"}}},"ConnectorManifest":{"type":"object","properties":{"titleCustomization":{"$ref":"#/components/schemas/TitleCustomization"},"connection":{"$ref":"#/components/schemas/Connection"},"Name":{"type":"string"}}},"OAuth2":{"type":"object","properties":{"baseUrl":{"type":"string"},"authorizationEndpoint":{"type":"string"},"accessTokenEndpoint":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"},"scope":{"type":"array","items":{"type":"string"}}}},"Option":{"type":"object","properties":{"title":{"type":"string"},"value":{"type":"string"}}},"TitleCustomization":{"type":"object","properties":{"database":{"$ref":"#/components/schemas/TitleWithTranslationKey"},"table":{"$ref":"#/components/schemas/TitleWithTranslationKey"}}},"TitleWithTranslationKey":{"type":"object","properties":{"title":{"type":"string"},"translationKey":{"type":"string"}}},"DataSourceWithDuplicates":{"type":"object","properties":{"get_id":{"type":"string"},"owner":{"type":"string"},"provider":{"type":"string"},"timeout":{"type":"integer","format":"int32","example":0},"refreshRate":{"type":"integer","format":"int32","example":0},"timezone":{"type":"string"},"schema":{"type":"string"},"parameters":{"type":"object"},"duplicates":{"type":"array","items":{"$ref":"#/components/schemas/Duplicate"}}}},"Duplicate":{"type":"object","properties":{"get_id":{"type":"string"},"timeout":{"type":"integer","format":"int32","example":0},"refreshRate":{"type":"integer","format":"int32","example":0},"timezone":{"type":"string"}}},"BuildErrorResponse":{"type":"object","properties":{"title":{"type":"string"},"reason":{"type":"string"}}},"TranslationError":{"type":"object"},"BuildModel":{"type":"object","properties":{"ecmModel":{"$ref":"#/components/schemas/EcmModel"},"smodel":{"type":"object","additionalProperties":{"type":"object"}}}},"Expression":{"type":"object","properties":{"oid":{"type":"string"},"lastUpdated":{"type":"string"},"expression":{"type":"string"},"isDatabaseDialect":{"type":"boolean"}}},"BuildInfoDTO":{"type":"object","properties":{"oid":{"type":"string"},"datamodelId":{"type":"string"},"buildType":{"type":"string"},"status":{"type":"string"},"datamodelTitle":{"type":"string"},"datamodelType":{"type":"string"},"indexSize":{"type":"string"},"instanceId":{"type":"string"},"schemaLastUpdate":{"type":"string"},"created":{"type":"string","format":"date-time"},"started":{"type":"string","format":"date-time"},"completed":{"type":"string","format":"date-time"},"rowLimit":{"type":"integer","format":"int64"},"source":{"type":"string"}}},"StorageRequest":{"type":"object","description":"Fields to update in the Storage object.","properties":{"name":{"type":"string"},"accessKey":{"type":"string"},"secretKey":{"type":"string"},"iamRole":{"type":"string"},"storageType":{"type":"string"},"bucketName":{"type":"string"},"bucketRegion":{"type":"string"},"storageIntegration":{"type":"string"},"bucketFolder":{"type":"string"}}},"DestinationStorageResponseString":{"type":"object","properties":{"status":{"type":"string","enum":["OK","UPDATED","CREATED","DELETED","STORAGE_NAME_EXISTS","STORAGE_TYPE_EXISTS","INVALID_STORAGE_TYPE","STORAGE_NOT_FOUND","INTERNAL_ERROR"]},"value":{"type":"string"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ColumnCountDistinctStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"}}}]},"ColumnCountNullStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"}}}]},"ColumnDistinctSamplesStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"},"numDistinctSamples":{"type":"integer","format":"int32"}}}]},"ColumnMaxStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"}}}]},"ColumnMinStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"}}}]},"ColumnTopKStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"},"topKCount":{"type":"integer","format":"int32"}}}]},"StatsRequestDTO":{"type":"object","discriminator":{"propertyName":"statsRequestType"},"properties":{"statsRequestType":{"type":"string"}},"required":["statsRequestType"]},"StatsRequestListDTO":{"type":"object","description":"Statistics requests list","properties":{"requests":{"type":"array","description":"requests","example":[{"statsRequestType":"COLUMN_COUNT_DISTINCT","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"b9738d67-b89d-3c78-a746-d4a9cf4a1093","columnId":"bde7d15f-d689-321f-a2ab-9a81a3708524"},{"statsRequestType":"COLUMN_COUNT_NULL","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"b9738d67-b89d-3c78-a746-d4a9cf4a1093","columnId":"bde7d15f-d689-321f-a2ab-9a81a3708524"},{"statsRequestType":"COLUMN_MIN","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"b9738d67-b89d-3c78-a746-d4a9cf4a1093","columnId":"bde7d15f-d689-321f-a2ab-9a81a3708524"},{"statsRequestType":"COLUMN_MAX","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"b9738d67-b89d-3c78-a746-d4a9cf4a1093","columnId":"bde7d15f-d689-321f-a2ab-9a81a3708524"},{"statsRequestType":"COLUMN_TOPK_REPEATING_VALUES","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"b9738d67-b89d-3c78-a746-d4a9cf4a1093","columnId":"bde7d15f-d689-321f-a2ab-9a81a3708524","numDistinctSamples":10},{"statsRequestType":"COLUMN_DISTINCT_SAMPLES","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"b9738d67-b89d-3c78-a746-d4a9cf4a1093","columnId":"bde7d15f-d689-321f-a2ab-9a81a3708524","numDistinctSamples":10},{"statsRequestType":"TABLE_COUNT","modelId":"4a560983-bab8-3505-b595-6f76b909f80d","tableId":"3adbdb3a-c060-338a-a0e6-e6c138ef9873"}],"items":{"oneOf":[{"$ref":"#/components/schemas/ColumnCountDistinctStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnCountNullStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnDistinctSamplesStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnMaxStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnMinStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnTopKStatsRequestDTO"},{"$ref":"#/components/schemas/TableCountStatsRequestDTO"}]}}}},"TableCountStatsRequestDTO":{"allOf":[{"$ref":"#/components/schemas/StatsRequestDTO"},{"type":"object","properties":{"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"}}}]},"RegisterResponseDTO":{"type":"object","properties":{"description":{"type":"string"},"statsRequestListValidationStatus":{"type":"string","enum":["SOME_STATS_REQUESTS_ARE_VALID","ALL_STATS_REQUESTS_ARE_VALID","NO_ONE_IS_VALID"]},"validRegisteredStatsRequests":{"type":"array","items":{"$ref":"#/components/schemas/RegisteredStatRequestDTO"}},"unregisteredInvalidStatsRequestsMessages":{"type":"array","items":{"$ref":"#/components/schemas/StatsRequestStatusMessageDTO"}}}},"RegisteredStatRequestDTO":{"type":"object","properties":{"request":{"oneOf":[{"$ref":"#/components/schemas/ColumnCountDistinctStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnCountNullStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnDistinctSamplesStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnMaxStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnMinStatsRequestDTO"},{"$ref":"#/components/schemas/ColumnTopKStatsRequestDTO"},{"$ref":"#/components/schemas/TableCountStatsRequestDTO"}]},"requestId":{"type":"string"}}},"StatsRequestStatusMessageDTO":{"type":"object","properties":{"statsRequestListDTO":{"$ref":"#/components/schemas/StatsRequestListDTO"},"status":{"type":"string","enum":["INVALID","READY"]},"description":{"type":"string"}}},"PostImportActionsRestFailedResponse":{"allOf":[{"$ref":"#/components/schemas/PostImportActionsRestResponse"},{"type":"object","properties":{"errorMessage":{"type":"string"}}}]},"PostImportActionsRestResponse":{"type":"object","discriminator":{"propertyName":"status"},"properties":{"status":{"type":"string"}},"required":["status"]},"PostImportActionsRestSuccessResponse":{"allOf":[{"$ref":"#/components/schemas/PostImportActionsRestResponse"}]},"ActivationPayload":{"type":"object","properties":{"ecmModel":{"$ref":"#/components/schemas/EcmModel"},"innerPerspective":{"$ref":"#/components/schemas/Perspective"},"perspective":{"$ref":"#/components/schemas/Perspective"}}},"ActivationFailedResponse":{"allOf":[{"$ref":"#/components/schemas/ActivationResponse"},{"type":"object","properties":{"errorMessage":{"type":"string"}}}]},"ActivationResponse":{"type":"object","discriminator":{"propertyName":"status"},"properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"string"}},"required":["status"]},"ActivationSuccessResponse":{"allOf":[{"$ref":"#/components/schemas/ActivationResponse"}]},"DimModelRecommendation":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"perspectiveOid":{"type":"string","format":"uuid"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/DimModelRecommendationTable"}},"relations":{"type":"array","items":{"$ref":"#/components/schemas/DimModelRecommendationRelation"}}}},"DimModelRecommendationColumn":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"role":{"type":"string","enum":["ATTRIBUTE","MEASURE"]}}},"DimModelRecommendationRelation":{"type":"object","properties":{"table0oid":{"type":"string","format":"uuid"},"column0oid":{"type":"string","format":"uuid"},"table1oid":{"type":"string","format":"uuid"},"column1oid":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["ONE_TO_ONE","ONE_TO_MANY","MANY_TO_ONE","MANY_TO_MANY"]}}},"DimModelRecommendationTable":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/DimModelRecommendationColumn"}},"role":{"type":"string","enum":["DIMENSION","FACT","BOTH"]}}},"BuildScheduleDTO":{"type":"object","description":"All Times in UTC","properties":{"cronString":{"type":"string"},"buildType":{"type":"string","enum":["ACCUMULATE","FULL","SCHEMA_CHANGES"]},"scheduleType":{"type":"string","enum":["Interval","DaysOfWeek"]},"intervalSeconds":{"type":"integer","format":"int64"},"daysOfWeek":{"type":"array","items":{"type":"string","enum":["SUN","MON","TUE","WED","THU","FRI","SAT"]}},"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"isSkipBuildEnabled":{"type":"boolean"}},"required":["buildType","scheduleType"]},"ExplainBuildElement":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["table","column"]}}},"ContextDTO":{"type":"object","properties":{"tables":{"type":"array","items":{"$ref":"#/components/schemas/Table"}},"tableName":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"},"isDatabaseDialect":{"type":"boolean"},"buildDestination":{"type":"string"},"dataModelId":{"type":"string"}}},"TableSqlExpressionDTO":{"type":"object","properties":{"expression":{"type":"string"},"context":{"$ref":"#/components/schemas/ContextDTO"},"row":{"type":"integer","format":"int32"},"column":{"type":"integer","format":"int32"}}},"SchemaDTO":{"type":"object","properties":{"expression":{"$ref":"#/components/schemas/Expression"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/Column"}}}},"ContextElement":{"type":"object","properties":{"type":{"type":"string","enum":["Columns","Tables"]},"value":{"type":"string"}}},"DestinationStorageResponseDocument":{"type":"object","properties":{"storageType":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"}}},"ColumnCountDistinctStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"}}}]},"ColumnCountNullStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"}}}]},"ColumnDistinctSamplesStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"},"numDistinctSamples":{"type":"integer","format":"int32"}}}]},"ColumnMaxStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"}}}]},"ColumnMinStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"}}}]},"ColumnTopKStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"},"columnPhysicalName":{"type":"string"},"topKCount":{"type":"integer","format":"int32"}}}]},"StatsBigDecimalValueDTO":{"allOf":[{"$ref":"#/components/schemas/StatsValueDTO"},{"type":"object","properties":{"statsValue":{"type":"number"}}}]},"StatsDistinctSamplesValueDTO":{"allOf":[{"$ref":"#/components/schemas/StatsValueDTO"},{"type":"object","properties":{"statsValue":{"type":"array","items":{"type":"string"}}}}]},"StatsEmptyValueDTO":{"allOf":[{"$ref":"#/components/schemas/StatsValueDTO"}]},"StatsResponseAndValueDTO":{"type":"object","properties":{"statsResponseDTO":{"oneOf":[{"$ref":"#/components/schemas/ColumnCountDistinctStatsResponseDTO"},{"$ref":"#/components/schemas/ColumnCountNullStatsResponseDTO"},{"$ref":"#/components/schemas/ColumnDistinctSamplesStatsResponseDTO"},{"$ref":"#/components/schemas/ColumnMaxStatsResponseDTO"},{"$ref":"#/components/schemas/ColumnMinStatsResponseDTO"},{"$ref":"#/components/schemas/ColumnTopKStatsResponseDTO"},{"$ref":"#/components/schemas/TableCountStatsResponseDTO"}]},"statsValueDTO":{"oneOf":[{"$ref":"#/components/schemas/StatsBigDecimalValueDTO"},{"$ref":"#/components/schemas/StatsDistinctSamplesValueDTO"},{"$ref":"#/components/schemas/StatsEmptyValueDTO"},{"$ref":"#/components/schemas/StatsTopKValueDTO"}]}}},"StatsResponseAndValueListDTO":{"type":"object","description":"Statistics responses and values list","properties":{"responses":{"type":"array","description":"responses","example":[{"statsResponseDTO":{"statsResponseType":"COLUMN_COUNT_DISTINCT","modelId":"ca0b974e-44d1-4185-be58-2ef01cf29ce5","dataSourceTitle":"Sample ECommerce","tableId":"f18d3792-9f5c-4bee-92be-99138221b18f","tableLogicalName":"Category","tablePhysicalName":"aCategory","columnId":"306bd7b8-c223-4038-b0cc-a3711e38549f","columnLogicalName":"Category ID","columnPhysicalName":"aCategoryIAAaID"},"statsValueDTO":{"@class":"com.sisense.model.statistics.api.v2.model.StatsBigDecimalValueDTO","timeUpdated":"2023-01-22T12:02:50","statsValue":28}},{"statsResponseDTO":{"statsResponseType":"TABLE_COUNT","modelId":"ca0b974e-44d1-4185-be58-2ef01cf29ce5","dataSourceTitle":"Sample ECommerce","tableId":"ca03ed27-20d3-494e-9879-3d5d591997c2","tableLogicalName":"Brand","tablePhysicalName":"aBrand"},"statsValueDTO":{"@class":"com.sisense.model.statistics.api.v2.model.StatsBigDecimalValueDTO","timeUpdated":"2023-01-22T12:02:50","statsValue":2427}},{"statsResponseDTO":{"statsRequestType":"COLUMN_DISTINCT_SAMPLES","modelId":"77aa2a21-0ec0-431e-b16c-b5b403117901","dataSourceTitle":"Sample ECommerce","tableId":"704c7b31-19fa-49d4-a0f2-b48cc03c5570","tableLogicalName":"Brand","tablePhysicalName":"aBrand","columnId":"f932a766-efca-4a9d-85b0-261a4a30478d","columnLogicalName":"Brand ID","columnPhysicalName":"aBrandIAAaID","numDistinctSamples":10},"statsValueDTO":{"@class":"com.sisense.model.statistics.api.v2.model.StatsDistinctSamplesValueDTO","timeUpdated":"2023-10-01T13:13:22","statsValue":["1","2","3","4","5","6","7","8","9","10"]}},{"statsResponseDTO":{"statsResponseType":"COLUMN_TOPK_REPEATING_VALUES","modelId":"ca0b974e-44d1-4185-be58-2ef01cf29ce5","dataSourceTitle":"Sample ECommerce","tableId":"ec399c2e-da77-46db-a957-619ad7237b8a","tableLogicalName":"Commerce","tablePhysicalName":"aCommerce","columnId":"b2dea4d8-001b-4e47-bf91-8b9453aa158d","columnLogicalName":"Brand ID","columnPhysicalName":"aBrandIAAaID","topKCount":10},"statsValueDTO":{"@class":"com.sisense.model.statistics.api.v2.model.StatsTopKValueDTO","timeUpdated":"2023-01-22T12:02:50","statsValue":{"3":82739,"4":72271,"5":24216,"7":19888,"10":55047,"12":19966,"13":21017,"16":29942,"17":24429,"18":23046}}}],"items":{"$ref":"#/components/schemas/StatsResponseAndValueDTO"}}}},"StatsResponseDTO":{"type":"object","discriminator":{"propertyName":"statsRequestType"},"properties":{"tableLogicalName":{"type":"string"},"modelId":{"type":"string","format":"uuid"},"tableId":{"type":"string","format":"uuid"},"columnId":{"type":"string","format":"uuid"},"columnLogicalName":{"type":"string"},"statsRequestType":{"type":"string"}},"required":["statsRequestType"]},"StatsTopKValueDTO":{"allOf":[{"$ref":"#/components/schemas/StatsValueDTO"},{"type":"object","properties":{"statsValue":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}}]},"StatsValueDTO":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"timeUpdated":{"type":"string"},"statsValue":{"type":"object"},"@class":{"type":"string"}},"required":["@class"]},"TableCountStatsResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatsResponseDTO"},{"type":"object","properties":{"dataSourceTitle":{"type":"string"},"tablePhysicalName":{"type":"string"}}}]},"RegisteredStatsResponseListDTO":{"type":"object","properties":{"registeredRequests":{"type":"array","description":"registeredRequests","example":[{"StatsRequestDTO":{"modelId":"ca0b974e-44d1-4185-be58-2ef01cf29ce5","tableId":"f18d3792-9f5c-4bee-92be-99138221b18f","columnId":"306bd7b8-c223-4038-b0cc-a3711e38549f"},"requestId":"f18d3792-9f5c-4bee-92be-99138221b5h9"}],"items":{"$ref":"#/components/schemas/RegisteredStatRequestDTO"}}}},"StatsDefinitionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["column","table"]},"parameters":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/StatsDefinitionParameterDTO"},{"$ref":"#/components/schemas/TopKStatsDefinitionParameterDTO"}]}},"hidden":{"type":"boolean"}}},"StatsDefinitionParameterDTO":{"type":"object","discriminator":{"propertyName":"@class"},"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["numeric","text","datetime","UUID"]},"@class":{"type":"string"}},"required":["@class"]},"TopKStatsDefinitionParameterDTO":{"allOf":[{"$ref":"#/components/schemas/StatsDefinitionParameterDTO"},{"type":"object","properties":{"default":{"type":"integer","format":"int32"}}}]},"BuildMetaData":{"type":"object","properties":{"oid":{"type":"string","format":"uuid"},"tenantId":{"type":"string"},"skipBuildsCounter":{"type":"integer","format":"int32"},"tablesRowCount":{"type":"object","additionalProperties":{"type":"object","properties":{"opaque":{"type":"integer","format":"int64"},"acquire":{"type":"integer","format":"int64"},"release":{"type":"integer","format":"int64","writeOnly":true},"andIncrement":{"type":"integer","format":"int64"},"andDecrement":{"type":"integer","format":"int64"},"plain":{"type":"integer","format":"int64"}}}},"duration":{"type":"integer","format":"int64"}}},"AISuccessDataDTO":{"type":"object","properties":{"modelOid":{"type":"string","format":"uuid"},"relations":{"type":"array","items":{"$ref":"#/components/schemas/UndirectedRelationDTO"}}}},"RelationColumnsSuggestion":{"type":"object","properties":{"column0oid":{"type":"string","format":"uuid"},"column1oid":{"type":"string","format":"uuid"},"relationData":{"$ref":"#/components/schemas/RelationDataDTO"}}},"RelationDataDTO":{"type":"object","properties":{"smartExplanation":{"type":"string"},"explanationCodes":{"type":"array","items":{"type":"string"}},"explanations":{"type":"array","items":{"type":"string"}},"confidenceLevel":{"type":"string","enum":["high","medium","low","unknown"]}}},"StatusFailedResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatusResponseDTO"},{"type":"object","properties":{"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}}]},"StatusNotStartedResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatusResponseDTO"}]},"StatusProcessingResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatusResponseDTO"}]},"StatusResponseDTO":{"type":"object","discriminator":{"propertyName":"status"},"properties":{"requestId":{"type":"string","format":"uuid"},"status":{"type":"string"}},"required":["status"]},"StatusSuccessResponseDTO":{"allOf":[{"$ref":"#/components/schemas/StatusResponseDTO"},{"type":"object","properties":{"aiData":{"$ref":"#/components/schemas/AISuccessDataDTO"}}}]},"UndirectedRelationDTO":{"type":"object","properties":{"table0oid":{"type":"string","format":"uuid"},"table1oid":{"type":"string","format":"uuid"},"relationColumnsSuggestions":{"type":"array","items":{"$ref":"#/components/schemas/RelationColumnsSuggestion"}}}},"string":{"type":"object","properties":{"buildId":{"type":"string"}}},"TaskId":{"type":"object","properties":{"name":{"type":"string"}}},"WorkplanNodeStatus":{"type":"object","properties":{"nodeId":{"type":"string","description":"Task node ID","example":"node-id-1"},"nodeState":{"type":"string","description":"Task node's status","enum":["INIT","READY","RUNNING","COMPLETED","FAILED","CANCELLED"],"example":"FAILED"},"startTime":{"type":"string","description":"Task start time (set only if task already started)","example":"2018-07-08T16:29:30.044Z"},"endTime":{"type":"string","description":"Task end time (set only if task already ended)","example":"2018-07-08T17:09:30.044Z"},"errorMessage":{"type":"string","description":"Error message (set only in case of failure)","example":"Failed to connect to database"},"nodeCustomAttributes":{"type":"object","additionalProperties":{"type":"string","description":"Custom attributes per workplan type. Notice the attributes can be different according to the specific workplan","example":"{\"buildTaskType\":\"CUSTOM_COLUMN\",\"tableName\":\"Patients\",\"logicalColumnName\":\"Full name\"}"},"description":"Custom attributes per workplan type. Notice the attributes can be different according to the specific workplan","example":{"buildTaskType":"CUSTOM_COLUMN","tableName":"Patients","logicalColumnName":"Full name"}}},"required":["endTime","errorMessage","nodeId","nodeState","startTime"]},"WorkplanNodeUpdateMessage":{"type":"object","properties":{"workplanId":{"type":"string","description":"Workplan's unique ID","example":"workplan-id-abcde"},"timestamp":{"type":"string","description":"Message timestamp","example":"2018-07-08T16:29:36.036Z"},"type":{"type":"string","description":"Message type","enum":["WORKPLAN_EXPLAIN_GRAPH","WORKPLAN_EXPLAIN_UPDATE"]},"elementType":{"type":"string","enum":["WORKPLAN","NODE"]},"updateType":{"type":"string","enum":["READY","PENDING","START","PROGRESS","END"]},"nodeStatus":{"$ref":"#/components/schemas/WorkplanNodeStatus","description":"Workplan node's status"}},"required":["elementType","nodeStatus","timestamp","type","updateType","workplanId"]},"WorkplanState":{"type":"object","properties":{"exception":{"type":"object","properties":{"stackTrace":{"type":"array","items":{"type":"object","properties":{"classLoaderName":{"type":"string"},"moduleName":{"type":"string"},"moduleVersion":{"type":"string"},"methodName":{"type":"string"},"fileName":{"type":"string"},"lineNumber":{"type":"integer","format":"int32"},"nativeMethod":{"type":"boolean"},"className":{"type":"string"}}}},"message":{"type":"string"},"localizedMessage":{"type":"string"}}},"cancelMessage":{"type":"string"},"state":{"type":"string","enum":["Init","Running","Finalizing","Completed","Failed","DimTablesValidationFailed","Cancelled"]},"cancelled":{"type":"boolean"},"completed":{"type":"boolean"},"failed":{"type":"boolean"},"dimTablesValidationFailed":{"type":"boolean"},"finalizing":{"type":"boolean"},"successful":{"type":"boolean"}}},"WorkplanStatus":{"type":"object","properties":{"workplanState":{"$ref":"#/components/schemas/WorkplanState","description":"Workplan status","example":"FAILED"},"startTime":{"type":"string","description":"Workplan start time (set only if workplan already started)","example":"2018-07-08T16:29:30.044Z"},"endTime":{"type":"string","description":"Workplan end time (set only if workplan already ended)","example":"2018-07-08T17:09:30.044Z"},"errorMessage":{"type":"string","description":"Error message (set only in case of failure)","example":"Failed to connect to datasource"},"workplanCustomAttributes":{"type":"object","additionalProperties":{"type":"string"},"description":"Custom attributes per workplan type. Notice the attributes can be different according to the specific workplan","example":{"ecmModelId":"ecm-model-id-11111","etltModelId":"etlt-model-id-22222","buildType":"full"}}},"required":["endTime","errorMessage","startTime","workplanState"]},"WorkplanUpdateMessage":{"type":"object","properties":{"workplanId":{"type":"string","description":"Workplan's unique ID","example":"workplan-id-abcde"},"timestamp":{"type":"string","description":"Message timestamp","example":"2018-07-08T16:29:36.036Z"},"type":{"type":"string","description":"Message type","enum":["WORKPLAN_EXPLAIN_GRAPH","WORKPLAN_EXPLAIN_UPDATE"]},"elementType":{"type":"string","enum":["WORKPLAN","NODE"]},"updateType":{"type":"string","enum":["READY","PENDING","START","PROGRESS","END"]},"workplanStatus":{"$ref":"#/components/schemas/WorkplanStatus","description":"Workplan status"}},"required":["elementType","timestamp","type","updateType","workplanId","workplanStatus"]},"WorkplanEdge":{"type":"object","properties":{"edgeId":{"type":"string","description":"Edge ID","example":"edge-id-a"},"sourceNodeId":{"type":"string","description":"Node ID of the source task node (the required node that target node depends on)","example":"node-id-1"},"targetNodeId":{"type":"string","description":"Node ID of the target task node (later node that should run after source node fulfilled)","example":"node-id-2"}},"required":["edgeId","sourceNodeId","targetNodeId"]},"WorkplanGraph":{"type":"object","properties":{"nodes":{"type":"array","description":"Workplan graph's nodes list","items":{"$ref":"#/components/schemas/WorkplanNodeStatus"}},"edges":{"type":"array","description":"Workplan graph's edges list","items":{"$ref":"#/components/schemas/WorkplanEdge"}}},"required":["edges","nodes"]},"WorkplanGraphMessage":{"type":"object","properties":{"workplanId":{"type":"string","description":"Workplan's unique ID","example":"workplan-id-abcde"},"timestamp":{"type":"string","description":"Message timestamp","example":"2018-07-08T16:29:36.036Z"},"type":{"type":"string","description":"Message type","enum":["WORKPLAN_EXPLAIN_GRAPH","WORKPLAN_EXPLAIN_UPDATE"]},"workplanStatus":{"$ref":"#/components/schemas/WorkplanStatus","description":"Workplan status"},"graph":{"$ref":"#/components/schemas/WorkplanGraph","description":"Workplan graph, represents the tasks' nodes and the edges (dependencies) between them"}},"required":["graph","timestamp","type","workplanId","workplanStatus"]},"BuildServiceResponseInteger":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IBuildServiceResponseStatus"},"value":{"type":"integer","format":"int32"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"IBuildServiceResponseStatus":{"type":"object","properties":{"ok":{"type":"boolean"},"description":{"type":"string"}}},"ResetFailedResponse":{"allOf":[{"$ref":"#/components/schemas/ResetResponseDTO"},{"type":"object","properties":{"errorMessage":{"type":"string"}}}]},"ResetResponseDTO":{"type":"object","discriminator":{"propertyName":"status"},"properties":{"status":{"type":"string"}},"required":["status"]},"ResetSuccessResponse":{"allOf":[{"$ref":"#/components/schemas/ResetResponseDTO"},{"type":"object","properties":{"message":{"type":"string"}}}]},"NodeUpdateParams":{"type":"object","description":"Node update params","properties":{"nodeRoles":{"type":"array","items":{"type":"string","enum":["infra","app","build","query"]},"uniqueItems":true}}},"DeploymentServiceResponseVoid":{"type":"object","properties":{"status":{"type":"string","enum":["OK","INTERNAL_ERROR","NODE_NOT_FOUND","NODE_ALREADY_EXISTS","UNAUTHORIZED","POD_NOT_FOUND"]},"value":{"type":"object"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"OnBoardRequest":{"type":"object","properties":{"userName":{"type":"string"},"userPassword":{"type":"string"},"domain":{"type":"string"}}},"OnBoardResponse":{"type":"object","properties":{"tenantId":{"type":"string"},"defaultTenantAdminId":{"type":"string"},"errorMessage":{"type":"string"}}},"OffBoardRequest":{"type":"object","properties":{"domain":{"type":"string"}}},"AsyncImportRequest":{"type":"object","properties":{"dataSourceId":{"type":"string"},"dataSourceTitle":{"type":"string"},"s3Config":{"$ref":"#/components/schemas/S3Config"},"sourceOperation":{"type":"string","enum":["CLI","SAMPLE","REST"]},"local":{"$ref":"#/components/schemas/LocalImportConfig"},"streamImportConfig":{"$ref":"#/components/schemas/StreamImportConfig"},"fileName":{"type":"string"},"startOnImport":{"type":"boolean"},"overwrite":{"type":"boolean"},"regenerateEcmOidsIfNeeded":{"type":"boolean"}}},"LocalImportConfig":{"type":"object","properties":{"path":{"type":"string"}}},"S3Config":{"type":"object","properties":{"accessKey":{"type":"string"},"secretKey":{"type":"string"},"bucketName":{"type":"string"},"objectName":{"type":"string"},"region":{"type":"string"}}},"StreamImportConfig":{"type":"object","properties":{"inputStream":{"type":"object"}}},"AsyncImportResponse":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"dataSourceId":{"type":"string"},"status":{"type":"string","enum":["IDLE","RUNNING","CANCELLED","FAILED","FINISHED","UNKNOWN"]},"local":{"$ref":"#/components/schemas/LocalImportConfig"},"startTime":{"type":"string","format":"date-time"},"finishTime":{"type":"string","format":"date-time"},"overwrite":{"type":"boolean"},"errorMessage":{"type":"string"}}},"IManagementServiceResponseStatus":{"type":"object","properties":{"ok":{"type":"boolean"},"description":{"type":"string"}}},"ManagementServiceResponseAsyncImportResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"$ref":"#/components/schemas/AsyncImportResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"AsyncExportRequest":{"type":"object","properties":{"dataSourceId":{"type":"string"},"dataSourceTitle":{"type":"string"},"s3Config":{"$ref":"#/components/schemas/S3Config"},"sourceOperation":{"type":"string","enum":["CLI","SAMPLE","REST"]},"local":{"$ref":"#/components/schemas/LocalExportConfig"}}},"LocalExportConfig":{"type":"object","properties":{"path":{"type":"string"},"conflictBehaviour":{"type":"string","enum":["REPLACE","RENAME","FAIL"]}}},"AsyncExportResponse":{"type":"object","properties":{"id":{"type":"string"},"dataSourceId":{"type":"string"},"status":{"type":"string","enum":["IDLE","RUNNING","CANCELLED","FAILED","FINISHED","UNKNOWN"]},"local":{"$ref":"#/components/schemas/LocalExportConfig"}}},"ManagementServiceResponseAsyncExportResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"$ref":"#/components/schemas/AsyncExportResponse"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"Node":{"type":"object","properties":{"hostName":{"type":"string"},"nodeRoles":{"type":"array","example":["infra"],"items":{"type":"string","enum":["infra","app","build","query"]},"uniqueItems":true},"oid":{"type":"string","example":"node1"}}},"AccumulativeConfig":{"type":"object","properties":{"column":{"type":"string"},"type":{"type":"string"}}},"Arguments":{"type":"object","properties":{"expression":{"$ref":"#/components/schemas/Expression"},"indexed":{"type":"boolean"},"id":{"type":"string"},"column":{"type":"string"},"name":{"type":"string"},"type":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"precision":{"type":"integer","format":"int32"},"scale":{"type":"integer","format":"int32"},"oid":{"type":"string"},"hidden":{"type":"boolean"},"description":{"type":"string"}}},"BuildBehavior":{"type":"object","properties":{"type":{"type":"string"},"accumulativeConfig":{"$ref":"#/components/schemas/AccumulativeConfig"}}},"ConfigOptions":{"type":"object","properties":{"Table":{"type":"string"},"files":{"type":"array","items":{"type":"string"}},"delimiter":{"type":"string"},"culture":{"type":"string"},"hasHeader":{"type":"boolean"},"fieldsInFirstRow":{"type":"boolean"},"ignoreMissingColumns":{"type":"boolean"},"staticRange":{"type":"string"},"stringQuote":{"type":"string"},"ignoreFirstRows":{"type":"integer","format":"int32"},"ignoreLastRows":{"type":"integer","format":"int32"},"folder":{"type":"string"},"query":{"type":"string"},"excludeIfBegins":{"type":"string"},"excludeIfContains":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"ProfileIds":{"type":"array","items":{"type":"string"},"writeOnly":true},"ProfileNames":{"type":"array","items":{"type":"string"},"writeOnly":true},"ManagedAccounts":{"type":"array","items":{"type":"string"},"writeOnly":true},"columnsDateTimePatterns":{"type":"string"},"importQuery":{"type":"string"},"previewQuery":{"type":"string"},"accumulateQuery":{"type":"string"},"trustServerCertificate":{"type":"boolean"},"encrypt":{"type":"boolean"},"managedAccounts":{"type":"string"},"profileNames":{"type":"string"},"profileIds":{"type":"string"},"PrivateKey":{"type":"string"},"Protocol":{"type":"string"},"AuthorityCertificate":{"type":"string"},"ClientCertificate":{"type":"string"}}},"Key":{"type":"object","properties":{"oid":{"type":"string"},"columns":{"type":"array","items":{"type":"string"}}}},"TupleTransformation":{"type":"object","properties":{"type":{"type":"string"},"lastUpdated":{"type":"string"},"arguments":{"$ref":"#/components/schemas/Arguments"}}},"ManagementServiceResponseWithoutValue":{"type":"object","properties":{"status":{"type":"string","enum":["OK","CUBE_NOT_FOUND","PATH_DOES_NOT_EXIST","ALREADY_ATTACHED","FAILED_TO_START_CUBE","MISSING_DATA_GROUP","MISSING_MODEL","NOT_VALID","NOT_FOUND","FAILED_TO_DETACH","FAILED_TO_STOP","CUBE_STATUS_ERROR","CUBE_ALREADY_STOPPED","STOP_CUBE_ERROR","NO_SUCH_CUBE","CUBE_UNSTOPPABLE_TYPE","CUBE_ALREADY_RUNNING","TOO_MANY_CUBES_ALREADY_RUNNING","CUBE_ALREADY_STARTING","START_CUBE_ERROR","CUBE_NOT_REGISTERED","START_CUBE_INTERRUPTED","PROVIDER_ERROR","FAILED_TO_MAKE_DIR","FAILED_TO_WRITE_FILE","BAD_CUBE_NAME","CUBE_IS_BUSY","FAILED_TO_MIGRATE","FILE_MISSING","FILE_TOO_BIG","CUBE_ALREADY_EXISTS","FAILED_TO_SAVE_DATASOURCE","FAILED_TO_RESET_BUILD_STORAGE","FAILED_TO_RESET_FARM","FAILED_TO_RESET_K8S","FAILED_LOADING_CUBE","INTERNAL_ERROR","UNAUTHORIZED","UNKNOWN_SERVICE","INSUFFICIENT_DISK_RESOURCES","TASK_NOT_FOUND","TASK_NOT_RUNNING","BAD_REQUEST","UNSUPPORTED_DATA_SOURCE_TYPE","AWS_ERROR","IMPORT_TASK_CANT_BE_CANCELED","SYSTEM_IN_RESTORE","SYSTEM_IN_BACKUP","SYSTEM_ADD_EC_ACTIVITY_HALTED"],"example":"ERROR"},"error":{"type":"string"}}},"AutoScalerConfiguration":{"type":"object","properties":{"autoScaleEnabled":{"type":"boolean"},"maximumNumberOfEcPods":{"type":"integer","format":"int32"},"minimumNumberOfEcPods":{"type":"integer","format":"int32"},"cooldownMinutesToScaleUp":{"type":"integer","format":"int32"},"cooldownMinutesToScaleDown":{"type":"integer","format":"int32"},"balancedConcurrentQueriesMetricValue":{"type":"integer","format":"int32"}}},"DataGroupDto":{"type":"object","properties":{"queryNodes":{"type":"array","items":{"type":"string"},"uniqueItems":true},"buildNodes":{"type":"array","items":{"type":"string"},"uniqueItems":true},"name":{"type":"string","example":"datagroup-1"},"routingPolicy":{"type":"string","enum":["round-robin"],"example":"round-robin"},"queryQualityOfService":{"$ref":"#/components/schemas/DataGroupQualityOfService"},"queryNodeResourceAllocation":{"$ref":"#/components/schemas/ResourceAllocation"},"buildNodeResourceAllocation":{"$ref":"#/components/schemas/ResourceAllocation"},"indexSize":{"type":"string","enum":["short","long"],"example":"short"},"recyclerEnabled":{"type":"boolean"},"buildConnectorRunningMode":{"type":"string","enum":["system-connectors","internal-connectors"],"example":"internal-connectors"},"buildCustomCodeRunningMode":{"type":"string","enum":["system-custom-code","internal-custom-code"],"example":"internal-custom-code"},"connectorsJvmMemoryLimit":{"type":"integer","format":"int32"},"useLocalStorage":{"type":"boolean"},"useS3Storage":{"type":"boolean"},"queryOnLocal":{"type":"boolean"},"userLabel":{"type":"string"},"stopIdle":{"type":"boolean"},"idleMinutes":{"type":"integer","format":"int32"},"autoScalerConfiguration":{"$ref":"#/components/schemas/AutoScalerConfiguration"},"datamodels":{"type":"array","items":{"$ref":"#/components/schemas/DataSourceForDataGroup"},"uniqueItems":true},"oid":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"default":{"type":"boolean"}}},"DataGroupQualityOfService":{"type":"object","properties":{"replicaScaleMin":{"type":"integer","format":"int32"},"replicaScaleMax":{"type":"integer","format":"int32"},"concurrentQueries":{"type":"integer","format":"int32"},"queryTimeout":{"type":"integer","format":"int32"}}},"DataSourceForDataGroup":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"tenantName":{"type":"string"}}},"ResourceAllocation":{"type":"object","properties":{"requiredCpuCores":{"type":"number","format":"float"},"limitCpuCores":{"type":"number","format":"float"},"requiredRamSizeInMB":{"type":"integer","format":"int32"},"limitRamSizeInMB":{"type":"integer","format":"int32"},"coresUsagePercentage":{"type":"integer","format":"int32"}}},"SysBackupDTO":{"type":"object","description":"System backup params","properties":{"include-farm":{"type":"boolean"},"use-local-storage":{"type":"boolean"},"include-extra-paths":{"type":"boolean"},"extra-paths":{"type":"string"},"retention":{"type":"integer","format":"int32"},"triggered-by":{"type":"string"},"backup-type":{"type":"string","enum":["ALL_ASSETS_BUT_FARMS","MONGO_DB","ZOOKEEPER","DB_FARMS","PLUGINS","EXTRA_PATH","BRANDING","CRON_JOBS"]},"to-s3":{"type":"boolean"},"exclude-paths":{"type":"boolean"},"paths-to-exclude":{"type":"string"}}},"SysBackupExtendedDTO":{"type":"object","properties":{"status":{"type":"string","enum":["pending","running","success","failed","unknown"]},"includeFarm":{"type":"boolean"},"useLocalStorage":{"type":"boolean"},"includeExtraPaths":{"type":"boolean"},"extraPaths":{"type":"string"},"retention":{"type":"integer","format":"int32"},"triggeredBy":{"type":"string"},"backupType":{"type":"string","enum":["ALL_ASSETS_BUT_FARMS","MONGO_DB","ZOOKEEPER","DB_FARMS","PLUGINS","EXTRA_PATH","BRANDING","CRON_JOBS"]}}},"SysBackupServiceReponseSysBackupExtendedDTO":{"type":"object","properties":{"status":{"type":"string","enum":["OK","NOT_IMPLEMENTED","INTERNAL_ERROR","UNAUTHORIZED","BUSY","NO_SUCH_BACKUP","A_CUBE_IS_BUILDING","BACKUP_NOT_RUNNING","FAILED_TO_CANCEL_BACKUP"]},"value":{"$ref":"#/components/schemas/SysBackupExtendedDTO"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"SysScheduleBackupCreateDTO":{"type":"object","properties":{"retention":{"type":"string","example":1},"cronExpression":{"type":"string","example":"*/15 * * * *"},"include-farm":{"type":"boolean","example":false},"use-local-storage":{"type":"boolean","example":false},"to-s3":{"type":"boolean","example":false},"include-extra-paths":{"type":"boolean","example":false},"extra-paths":{"type":"string"},"exclude-paths":{"type":"boolean","example":false},"paths-to-exclude":{"type":"string"}}},"CronUTC":{"type":"object","properties":{"cron":{"type":"string","example":"*/15 * * * *"},"active":{"type":"boolean","example":true}}},"Parameter":{"type":"object","properties":{"key":{"type":"string","example":"key1"},"value":{"type":"string","example":"value1"}}},"RestCommand":{"type":"object","description":"REST command to run when task execute","properties":{"url":{"type":"string","example":"https://api.example.com/resources/"},"method":{"type":"string","enum":["POST","GET","PUT","DELETE","PATCH"]},"headers":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}},"body":{"type":"string"}}},"SysBackupSchedulerTask":{"type":"object","properties":{"type":{"type":"string"},"labels":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"string"},"explicitTime":{"type":"string","example":"2018-24-24T11:30:00Z"},"schedules":{"type":"array","items":{"$ref":"#/components/schemas/CronUTC"}},"active":{"type":"boolean"},"action":{"$ref":"#/components/schemas/TaskAction"}},"required":["action"]},"TaskAction":{"type":"object","properties":{"actionType":{"type":"string","enum":["RestCommand","RabbitRPC"]},"content":{"$ref":"#/components/schemas/RestCommand"}}},"SysBackupServiceReponseVoid":{"type":"object","properties":{"status":{"type":"string","enum":["OK","NOT_IMPLEMENTED","INTERNAL_ERROR","UNAUTHORIZED","BUSY","NO_SUCH_BACKUP","A_CUBE_IS_BUILDING","BACKUP_NOT_RUNNING","FAILED_TO_CANCEL_BACKUP"]},"value":{"type":"object"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ConnectionRequestB2D":{"type":"object","properties":{"name":{"description":"Connection name","example":"Snowflake B2D Viewer"},"provider":{"description":"Connection provider - must match the buildDestination type (e.g., SnowflakeJDBC for snowflake)","enum":["SnowflakeJDBC","RedShift","GoogleBigQuery"],"example":"SnowflakeJDBC"},"parameters":{"description":"Connection parameters - varies by provider type. For Snowflake: connectionString (JDBC URL), Database (target database name), userName, role (VIEWER, WRITER), account, authenticationMethod (privateKeyMethod, privateKeyContentMethod), useModernRSA (true), privateKey or privateKeyContent, passphrase. For writer role: change role to 'WRITER' and userName to 'sisense_b2d_writer_user'.","example":{"privateKey":"/opt/sisense/storage/data/key.p8","account":"<account_identifier>","role":"VIEWER","authenticationMethod":"privateKeyMethod","userName":"sisense_b2d_viewer_user","useModernRSA":true,"connectionString":"jdbc:snowflake://<account_identifier>.snowflakecomputing.com/?warehouse=<warehouse>","Database":"SALES_DATA","passphrase":"yourPassphrase","useKeyPairAuth":true}},"description":{"description":"Connection with viewer/writer permissions for accessing Snowflake Data Warehouse via Build to Destination (B2D)","example":"Connection with viewer permissions for accessing Snowflake Data Warehouse via Build to Destination (B2D)"},"permissions":{"description":"Connection permission level (viewer, writer)","example":"viewer"},"buildDestination":{"description":"Target destination for Build to Destination. Supported values: snowflake, redshift, GoogleBigQuery","example":"snowflake"}}},"DetachParamsDTO":{"type":"object","properties":{"deleteOnDetach":{"type":"boolean"},"orchestratorTask":{"type":"string"},"sync":{"type":"boolean"}}},"InfoRequest":{"type":"object","properties":{"instanceId":{"type":"string"},"physicalName":{"type":"string"}}},"CubeInfoItem":{"type":"object","properties":{"instanceId":{"type":"string"},"tenantId":{"type":"string"},"uri":{"type":"string"},"shadowUri":{"type":"string"},"nextBuildUri":{"type":"string"},"uriDirectorySize":{"type":"integer","format":"int64"},"shadowUriDirectorySize":{"type":"integer","format":"int64"},"nextBuildUriDirectorySize":{"type":"integer","format":"int64"},"hostName":{"type":"string"},"runtimeStatus":{"type":"string","enum":["STOPPED","STOPPING","STARTING","RUNNING","BUILDING","UNKNOWN"]},"cubeOperationStatus":{"type":"string","enum":["NONE","IMPORTING","EXPORTING","DUPLICATING"]},"lastFailureMessage":{"type":"string"},"cubeStatusErrorCode":{"type":"string","enum":["FAILED_TO_STOP","FAILED_TO_START"]},"buildId":{"$ref":"#/components/schemas/string"},"lastBuildTime":{"type":"string","format":"date-time"},"lastBuildAttemptTime":{"type":"string","format":"date-time"},"lastUpdatedTime":{"type":"string","format":"date-time"},"dataSourceId":{"type":"string"},"port":{"type":"integer","format":"int32"},"schemaId":{"type":"string"},"indexSize":{"type":"string","enum":["short","long"]},"concurrentQueries":{"type":"integer","format":"int32"},"queryTimeout":{"type":"integer","format":"int32"},"generation":{"type":"integer","format":"int64"},"dataGroupOid":{"type":"string","format":"uuid"},"dataSourceType":{"type":"string","enum":["MonetDb","Live","RedShift","Snowflake","BigQuery","AzureSynapse"]},"acceleration":{"type":"boolean"},"finalizing":{"type":"boolean"},"lastBuildFailed":{"type":"boolean"},"building":{"type":"boolean"},"name":{"type":"string"},"physicalName":{"type":"string"}}},"InfoResponse":{"type":"object","properties":{"status":{"type":"string","enum":["OK","FAILED"]},"cubes":{"type":"array","items":{"$ref":"#/components/schemas/CubeInfoItem"}}}},"AvailableDatasourcesInfoRequest":{"type":"object","properties":{"physicalName":{"type":"string"}}},"AttachParamsDTO":{"type":"object","properties":{"uri":{"type":"string"},"sync":{"type":"boolean"}}},"AttachCubeResponse":{"type":"object","properties":{"status":{"type":"string"},"instanceId":{"type":"string"},"cubeTitle":{"type":"string"}}},"InstanceInfo":{"type":"object","properties":{"datamodelId":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"podId":{"type":"string","example":"ec-ec2-1b5ef56e-8add-4eb3-b-78948dcfc9-k7gxh"},"sourceId":{"type":"string","example":"aDemo"},"dataSourceTitle":{"type":"string","example":"Demo"},"buildId":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"buildTime":{"type":"string","format":"date-time","example":"2019-07-15T15:17:03Z"},"status":{"type":"string","enum":["pending","running","success","failed","unknown"],"example":"running"},"nodeId":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"creationTime":{"type":"string","example":"2019-07-15T15:17:03Z"},"memoryMb":{"type":"number","format":"double","example":150},"mode":{"type":"string","enum":["build","query"],"example":"build"}}},"DataModel":{"type":"object","properties":{"schemaLastModified":{"type":"string","format":"date-time"},"name":{"type":"string"},"created":{"type":"string","format":"date-time"},"dataGroup":{"type":"string","format":"uuid"},"state":{"$ref":"#/components/schemas/DataModelState"},"buildInfo":{"$ref":"#/components/schemas/DataModelBuildInfo"},"storage":{"$ref":"#/components/schemas/DataModelStorage"}}},"DataModelBuildInfo":{"type":"object","properties":{"lastBuildTime":{"type":"string","format":"date-time"},"buildId":{"type":"string"},"lastBuildSucceeded":{"type":"boolean"}}},"DataModelState":{"type":"object","properties":{"isStarting":{"type":"boolean"},"isBuilding":{"type":"boolean"},"isRunning":{"type":"boolean"},"isStopping":{"type":"boolean"},"isInvalid":{"type":"boolean"},"isLive":{"type":"boolean"}}},"DataModelStorage":{"type":"object","properties":{"dataSize":{"type":"integer","format":"int64"},"dbfarmDirectory":{"type":"string"}}},"ManagementServiceResponseDataModel":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"$ref":"#/components/schemas/DataModel"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ManagementServiceResponseListDataModel":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"type":"array","items":{"$ref":"#/components/schemas/DataModel"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ManagementServiceResponseListAsyncImportResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"type":"array","items":{"$ref":"#/components/schemas/AsyncImportResponse"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ManagementServiceResponseListAsyncExportResponse":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"type":"array","items":{"$ref":"#/components/schemas/AsyncExportResponse"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ConnectionMigrationUpgradeStatusDTO":{"type":"object","properties":{"upgradeStatus":{"type":"string","enum":["PENDING","IN_PROGRESS","SUCCEEDED","COMPLETED","FAILED"]},"featureEnabled":{"type":"boolean"}}},"LogicalDataColumn":{"type":"object","properties":{"oid":{"type":"string"},"logicalColumnName":{"type":"string"},"logicalColumnType":{"type":"string","enum":["BIGINT","DATETIME","DECIMAL","FLOAT","INT","REAL","TEXT","DOUBLE","NUMERIC","SMALLINT","TINYINT","BOOLEAN","CHAR","DATE","TIMESTAMP_WITH_TIMEZONE","TIME","TIME_WITH_TIMEZONE","UNSUPPORTED"]},"expression":{"type":"string"},"dataSourceColumnName":{"type":"string"},"merged":{"type":"boolean"},"isIndexed":{"type":"boolean"},"isHidden":{"type":"boolean"}}},"LogicalDataTable":{"type":"object","properties":{"oid":{"type":"string"},"logicalTableName":{"type":"string"},"dataSourceTableName":{"type":"string"},"schemaName":{"type":"string"},"columns":{"type":"array","items":{"$ref":"#/components/schemas/LogicalDataColumn"}},"tags":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"displayName":{"type":"string"},"isHidden":{"type":"boolean"}}},"LogicalDbSchema":{"type":"object","properties":{"schemaId":{"type":"string"},"schemaName":{"type":"string"},"tables":{"type":"array","items":{"$ref":"#/components/schemas/LogicalDataTable"}},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/LogicalRelationship"}},"unifiedRelationships":{"type":"array","items":{"$ref":"#/components/schemas/LogicalRelationship"}},"queryAeMode":{"type":"string"},"customTranslationMode":{"type":"string"},"ecCloud":{"type":"boolean"},"b2D":{"type":"boolean"}}},"LogicalRelationship":{"type":"object","properties":{"relationshipId":{"type":"string"},"columnRefs":{"type":"array","items":{"$ref":"#/components/schemas/ColumnRefImp"}},"logicalColumnType":{"type":"string","enum":["BIGINT","DATETIME","DECIMAL","FLOAT","INT","REAL","TEXT","DOUBLE","NUMERIC","SMALLINT","TINYINT","BOOLEAN","CHAR","DATE","TIMESTAMP_WITH_TIMEZONE","TIME","TIME_WITH_TIMEZONE","UNSUPPORTED"]}}},"ManagementServiceResponseLogicalDbSchema":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"$ref":"#/components/schemas/LogicalDbSchema"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"DataModelDTO":{"type":"object","properties":{"oid":{"type":"string"},"title":{"type":"string"},"physicalName":{"type":"string"}}},"ManagementServiceResponseListDataModelDTO":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"type":"array","items":{"$ref":"#/components/schemas/DataModelDTO"}},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ConnectorResponseSetString":{"type":"object","properties":{"status":{"type":"string","enum":["OK","QUERY_EXECUTE_TIMEOUT","QUERY_EXECUTE_EXCEPTION","QUERY_CANCEL_FAILED","DATA_SOURCE_CONNECT_FAILED","DATA_SOURCE_GET_CATALOG_FAILED","DATA_SOURCE_GET_SCHEMA_FAILED","DATA_SOURCE_GET_TABLES_FAILED","DATA_SOURCE_GET_TABLE_DETAILS_FAILED","DATA_SOURCE_TABLE_PREVIEW_FAILED","DATA_SOURCE_GET_DRIVER_METADATA_FAILED","DATA_SOURCE_TEST_CONNECTION_FAILED","DATA_SOURCE_GET_NUMBER_OF_ROWS_FAILED","PARAMETERS_MISSING","READ_UI_CONFIG_FAILED","INSTALL_CONNECTOR_FAILED","INSTALL_CONNECTOR_PLUGIN_FAILED","UNINSTALL_CONNECTOR_PLUGIN_FAILED","LIST_CONNECTORS_PLUGINS_FAILED","INTERNAL_ERROR","SNOWFLAKE_WAREHOUSE_NOT_SPECIFIED","NO_FILES_TO_COMPILE","COMPILATION_FAILED","DATA_SOURCE_IS_NOT_WHITELISTED","QUERY_CANCELLED","FAILED_RESOLVE_PARAMETERS","DATA_SOURCE_EXECUTE_COMMAND_FAILED","INSTALL_DIALECT_FAILED","REMOVE_DIALECT_FAILED","UNAUTHORIZED","REMOVE_CONNECTOR_FAILED","UPDATE_CONNECTOR_FAILED","CONNECTOR_NOT_INSTALLED","INTERNAL_SISENSE_ACCESS_DENIED","INVALID_PATH"]},"value":{"type":"array","items":{"type":"string"},"uniqueItems":true},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ConnectorDetailsDTO":{"type":"object","properties":{"className":{"type":"string"},"connectionIcon":{"type":"string"},"customDialect":{"type":"string"},"defaultConnectionString":{"type":"string"},"displayName":{"type":"string"},"driverToUpload":{"type":"string"},"existingDialectToUse":{"type":"string"},"isLiveSupported":{"type":"boolean"},"nodeColor":{"type":"string"},"parameterDelimiter":{"type":"string"},"isEnabledCustomQuery":{"type":"boolean"},"isFetchRelation":{"type":"boolean"},"enableAnalyticalEngine":{"type":"boolean"},"connectionProperties":{"type":"string"},"connectionSetFunctions":{"type":"string"},"statementSetFunctions":{"type":"string"},"sqlQueryDelimiter":{"type":"string"},"connectionStringParameters":{"type":"string"},"isEnabled":{"type":"boolean"},"isVisible":{"type":"boolean"},"useConnectionPool":{"type":"boolean"},"validateConnectionBeforeReuse":{"type":"boolean"}}},"ConnectorResponseConnectorDetailsDTO":{"type":"object","properties":{"status":{"type":"string","enum":["OK","QUERY_EXECUTE_TIMEOUT","QUERY_EXECUTE_EXCEPTION","QUERY_CANCEL_FAILED","DATA_SOURCE_CONNECT_FAILED","DATA_SOURCE_GET_CATALOG_FAILED","DATA_SOURCE_GET_SCHEMA_FAILED","DATA_SOURCE_GET_TABLES_FAILED","DATA_SOURCE_GET_TABLE_DETAILS_FAILED","DATA_SOURCE_TABLE_PREVIEW_FAILED","DATA_SOURCE_GET_DRIVER_METADATA_FAILED","DATA_SOURCE_TEST_CONNECTION_FAILED","DATA_SOURCE_GET_NUMBER_OF_ROWS_FAILED","PARAMETERS_MISSING","READ_UI_CONFIG_FAILED","INSTALL_CONNECTOR_FAILED","INSTALL_CONNECTOR_PLUGIN_FAILED","UNINSTALL_CONNECTOR_PLUGIN_FAILED","LIST_CONNECTORS_PLUGINS_FAILED","INTERNAL_ERROR","SNOWFLAKE_WAREHOUSE_NOT_SPECIFIED","NO_FILES_TO_COMPILE","COMPILATION_FAILED","DATA_SOURCE_IS_NOT_WHITELISTED","QUERY_CANCELLED","FAILED_RESOLVE_PARAMETERS","DATA_SOURCE_EXECUTE_COMMAND_FAILED","INSTALL_DIALECT_FAILED","REMOVE_DIALECT_FAILED","UNAUTHORIZED","REMOVE_CONNECTOR_FAILED","UPDATE_CONNECTOR_FAILED","CONNECTOR_NOT_INSTALLED","INTERNAL_SISENSE_ACCESS_DENIED","INVALID_PATH"]},"value":{"$ref":"#/components/schemas/ConnectorDetailsDTO"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"NodeWithSpec":{"type":"object","properties":{"hostName":{"type":"string"},"nodeRoles":{"type":"array","example":["infra"],"items":{"type":"string","enum":["infra","app","build","query"]},"uniqueItems":true},"oid":{"type":"string","example":"node1"},"amountOfCpu":{"type":"integer","format":"int32"},"amountOfRamInMb":{"type":"integer","format":"int32"},"architecture":{"type":"string"},"containerRuntimeVersion":{"type":"string"},"kernelVersion":{"type":"string"},"kubeProxyVersion":{"type":"string"},"kubeletVersion":{"type":"string"},"operatingSystem":{"type":"string"},"osImage":{"type":"string"},"active":{"type":"boolean"}}},"DeploymentServiceResponseNodeWithSpec":{"type":"object","properties":{"status":{"type":"string","enum":["OK","INTERNAL_ERROR","NODE_NOT_FOUND","NODE_ALREADY_EXISTS","UNAUTHORIZED","POD_NOT_FOUND"]},"value":{"$ref":"#/components/schemas/NodeWithSpec"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"SysBackupInfoDTO":{"type":"object","properties":{"status":{"type":"string","enum":["RUNNING","SUCCEEDED"]},"oid":{"type":"string"},"startedOn":{"type":"string"},"size":{"type":"string"}}},"ACLDTO":{"type":"object","properties":{"permission":{"type":"string"},"type":{"type":"string"},"partyId":{"type":"string"},"belongsToEveryoneGroup":{"type":"boolean"},"party":{"type":"string"}}},"AllCubesDTO":{"type":"object","properties":{"lastBuiltUtc":{"type":"string"},"lastBuildUtc":{"type":"string"},"createdUtc":{"type":"string"},"lastBuildStatus":{"type":"string"},"lastBuildAttemptUtc":{"type":"string"},"sizeInMb":{"type":"number","format":"float"},"server":{"type":"string"},"status":{"type":"array","items":{"type":"string"}},"statusAsInt":{"type":"integer","format":"int32"},"permissionsSummary":{"type":"integer","format":"int32"},"shares":{"type":"array","items":{"$ref":"#/components/schemas/ACLDTO"}},"databaseName":{"type":"string"},"buildType":{"type":"string"},"nextBuildUtc":{"type":"string"},"error":{"type":"string"},"elasticubeSet":{"type":"string"},"dataGroupName":{"type":"string"},"tenantId":{"type":"string"},"_id":{"type":"string"},"title":{"type":"string"}}},"ManagementServiceResponseEcmModel":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"$ref":"#/components/schemas/EcmModel"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"CubeDTO":{"type":"object","properties":{"lastBuiltUtc":{"type":"string"},"createdUtc":{"type":"string"},"sizeInMb":{"type":"number","format":"float"},"status":{"type":"integer","format":"int32"},"permissionsSummary":{"type":"integer","format":"int32"},"shares":{"type":"array","items":{"$ref":"#/components/schemas/ACLDTO"}},"databaseName":{"type":"string"},"buildType":{"type":"string"},"error":{"type":"string"},"elasticubeSet":{"type":"string"},"dataGroupName":{"type":"string"},"tenantName":{"type":"string"},"_id":{"type":"string"},"title":{"type":"string"}}},"ServerDTO":{"type":"object","properties":{"address":{"type":"string"},"cubes":{"type":"array","items":{"$ref":"#/components/schemas/CubeDTO"}},"errorMessage":{"type":"string"},"permissionsSummary":{"type":"string","enum":["NONE","ADMIN_ONLY","EVERYBODY","RESTRICTED"]},"defaultCubePermissions":{"type":"array","items":{"$ref":"#/components/schemas/ACLDTO"}},"identity":{"type":"string"}}},"ServerIdentityDTO":{"type":"object","properties":{"identity":{"type":"string"}}},"DataSourcesDTO":{"type":"object","properties":{"fullname":{"type":"string"},"id":{"type":"string"},"address":{"type":"string"},"database":{"type":"string"},"live":{"type":"boolean"},"title":{"type":"string"}}},"ManagementServiceResponseVoid":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/IManagementServiceResponseStatus"},"value":{"type":"object"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ConnectorResponseVoid":{"type":"object","properties":{"status":{"type":"string","enum":["OK","QUERY_EXECUTE_TIMEOUT","QUERY_EXECUTE_EXCEPTION","QUERY_CANCEL_FAILED","DATA_SOURCE_CONNECT_FAILED","DATA_SOURCE_GET_CATALOG_FAILED","DATA_SOURCE_GET_SCHEMA_FAILED","DATA_SOURCE_GET_TABLES_FAILED","DATA_SOURCE_GET_TABLE_DETAILS_FAILED","DATA_SOURCE_TABLE_PREVIEW_FAILED","DATA_SOURCE_GET_DRIVER_METADATA_FAILED","DATA_SOURCE_TEST_CONNECTION_FAILED","DATA_SOURCE_GET_NUMBER_OF_ROWS_FAILED","PARAMETERS_MISSING","READ_UI_CONFIG_FAILED","INSTALL_CONNECTOR_FAILED","INSTALL_CONNECTOR_PLUGIN_FAILED","UNINSTALL_CONNECTOR_PLUGIN_FAILED","LIST_CONNECTORS_PLUGINS_FAILED","INTERNAL_ERROR","SNOWFLAKE_WAREHOUSE_NOT_SPECIFIED","NO_FILES_TO_COMPILE","COMPILATION_FAILED","DATA_SOURCE_IS_NOT_WHITELISTED","QUERY_CANCELLED","FAILED_RESOLVE_PARAMETERS","DATA_SOURCE_EXECUTE_COMMAND_FAILED","INSTALL_DIALECT_FAILED","REMOVE_DIALECT_FAILED","UNAUTHORIZED","REMOVE_CONNECTOR_FAILED","UPDATE_CONNECTOR_FAILED","CONNECTOR_NOT_INSTALLED","INTERNAL_SISENSE_ACCESS_DENIED","INVALID_PATH"]},"value":{"type":"object"},"error":{"type":"string"},"statusCode":{"type":"integer","format":"int32"}}},"ObjectId":{"type":"object","properties":{}},"FormulaResponseDto":{"type":"object","properties":{"oid":{"type":"string","example":"925e8eae-c429-4f02-84da-1b1388ad19b9","description":"Id of a formula."},"title":{"type":"string","example":"Example","description":"Title of a formula."},"datasourceTitle":{"type":"string","example":"Sample Healthcare","description":"Title of the datasource that the formula was defined in."},"formula":{"type":"string","example":"Avg([10546-FD6]+Count([75652-A54]))","description":"Formula field that includes references and aggregation data."},"context":{"type":"object","example":{"[10546-FD6]":{"formulaRef":"51325a45-57fe-43b0-8c44-8197d4050ada"},"[75652-A54]":{"table":"Admissions","column":"Death","dim":"[Admissions.Death]","datatype":"text","merged":true,"title":"Death"}},"description":"Contains the data that is referenced in formula field."},"description":{"type":"string","example":"An example formula","description":"Description of the formula."},"created":{"format":"date-time","type":"string","example":"2022-03-24T12:38:16.241Z","description":"Timestamp of creation."},"lastUpdated":{"format":"date-time","type":"string","example":"2022-03-24T12:38:16.241Z","description":"Timestamp of last update."},"lastUpdatedUser":{"example":"698b00b0deb36ce8c7f71e61","description":"Last updating user.","allOf":[{"$ref":"#/components/schemas/ObjectId"}]},"owner":{"example":"698b00b0deb36ce8c7f71e61","description":"Owner of the formula.","allOf":[{"$ref":"#/components/schemas/ObjectId"}]}},"required":["oid","title","datasourceTitle","formula","context","description","created","lastUpdated","lastUpdatedUser","owner"]},"CreateFormulaPayload":{"type":"object","properties":{"description":{"type":"string"},"type":{"type":"string"},"title":{"type":"string"},"datasourceTitle":{"type":"string"},"formula":{"type":"string"},"context":{"type":"object"}},"required":["title","datasourceTitle","formula","context"]},"HttpExceptionDto":{"type":"object","properties":{"message":{"type":"string"},"name":{"type":"string"},"statusCode":{"type":"number"},"path":{"type":"string"},"timestamp":{"format":"date-time","type":"string"}},"required":["message","name","statusCode","path","timestamp"]},"WidgetMetadata":{"type":"object","properties":{"oid":{"type":"string"},"title":{"type":"string"},"dashboardid":{"type":"string"},"dashboardTitle":{"type":"string"}},"required":["oid","title","dashboardid","dashboardTitle"]},"DashboardMetadata":{"type":"object","properties":{"dashboardid":{"type":"string"},"dashboardTitle":{"type":"string"}},"required":["dashboardid","dashboardTitle"]},"AlertMetadata":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"FormulaUsageDto":{"type":"object","properties":{"formulaId":{"type":"string","description":"Relevant formula's Id.","example":"925e8eae-c429-4f02-84da-1b1388ad19b9"},"usedByFormulas":{"description":"Array of titles of formulas that reference the formula.","example":["Formula Title 1","Formula Title 2"],"type":"array","items":{"type":"string"}},"usedByWidgets":{"description":"Array of objects that contains metadata of each widget that uses the formula.","example":[{"oid":"6236ef8e9efd3d72dd147957","title":"Some Widget #1","dashboardid":"6236ef8e9efd3d72dd147957","dashboardTitle":"Dashboard example #1"},{"oid":"6236ef8e9efd3d72dd147957","title":"Some Widget #2","dashboardid":"6236ef8e9efd3d72dd147957","dashboardTitle":"Dashboard example #2"}],"allOf":[{"$ref":"#/components/schemas/WidgetMetadata"}]},"usedByDashboards":{"description":"Array of objects that contains metadata of each dashboard that uses the formula.","example":[{"dashboardid":"6236ef8e9efd3d72dd147957","dashboardTitle":"Dashboard example #1"},{"dashboardid":"6236ef8e9efd3d72dd147957","dashboardTitle":"Dashboard example #2"}],"allOf":[{"$ref":"#/components/schemas/DashboardMetadata"}]},"usedByAlerts":{"description":"Array of objects that contains metadata of each alert that uses the formula.","example":[{"name":"Alert example #1"},{"name":"Alert example #2"}],"allOf":[{"$ref":"#/components/schemas/AlertMetadata"}]}},"required":["formulaId","usedByFormulas","usedByWidgets","usedByDashboards","usedByAlerts"]},"UpdateFormulaPayload":{"type":"object","properties":{"description":{"type":"string"},"formula":{"type":"string"},"context":{"type":"object"},"title":{"type":"string"}}}}}}