Datamart API endpoints
Use the Datamart API endpoints to manage the data mart tasks. Before you run an endpoint, make sure that you authenticate the API request.
{
"openapi": "3.0.1",
"info": {
"title": "Datamart API",
"description": "It contains the set of API calls related to data marts.",
"version": "1.1.56"
},
"paths": {
"/opt/api/v1/datamartservice/datamarts/{erid}/summary": {
"get": {
"tags": [
"datamart-summary-controller"
],
"description": "Get summary data mart by erid",
"operationId": "getByErid",
"parameters": [
{
"name": "erid",
"in": "path",
"description": "Unique Id of the Datamart Definition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DatamartSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
},
"put": {
"tags": [
"datamart-summary-controller"
],
"description": "Update the summary data mart definition and,if necessary, invalidate the old data mart and create and materialize a new instance",
"operationId": "update",
"parameters": [
{
"name": "erid",
"in": "path",
"description": "Unique Id of the Datamart Definition",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartSummary"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DatamartSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}/refreshstatus": {
"put": {
"tags": [
"datamart-controller"
],
"description": "Refresh status of the datamart with the specified id",
"operationId": "refreshDatamartStatusById",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Status of the datamart has been refreshed"
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/sqlview/refreshstatus": {
"put": {
"tags": [
"datamart-controller"
],
"description": "Refresh status of all sql viewdatamarts and all of the datamarts using them excluding datamarts that need materialization",
"operationId": "refreshStatusOfAllSqlViewDatamarts",
"responses": {
"200": {
"description": "Status of all sql datamarts has been refreshed"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}": {
"post": {
"tags": [
"datamart-controller"
],
"description": "Datamart response according to the specified datamart id",
"operationId": "getDatamart",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Datamart response according to the specified datamart id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartResponse"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}/filters/{filtername}": {
"post": {
"tags": [
"datamart-controller"
],
"description": "Datamart response according to the specified filter name",
"operationId": "getDatamartFilterValues",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "filtername",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Datamart response according to the specified filter name",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartResponse"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}/data": {
"post": {
"tags": [
"datamart-controller"
],
"description": "Datamart response with data according to the specified datamart id",
"operationId": "getDatamartData",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Datamart response with data according to the specified datamart id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartResponse"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}/aggregatedata": {
"post": {
"tags": [
"datamart-controller"
],
"description": "Datamart response with aggregated data according to the specified datamart id",
"operationId": "getDatamartAggreagatedData",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Datamart response with aggregated data according to the specified datamart id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartResponse"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/summary": {
"post": {
"tags": [
"datamart-summary-controller"
],
"description": "Creates an instance of the summary data mart, assign the data mart to the given materializer task and submit a request of materialization",
"operationId": "create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartSummary"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DatamartSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/summary/validate": {
"post": {
"tags": [
"datamart-summary-controller"
],
"description": "Validate the datamart summary definition specified in the request body",
"operationId": "validate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartSummary"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ValidationMessages"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/summary/build/columns": {
"post": {
"tags": [
"datamart-summary-controller"
],
"description": "Retrieve the list of columns of the data mart based on the requested metrics and the related predefined statistics",
"operationId": "buildColumns",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuildColumnRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatamartColumn"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/refreshstatus": {
"post": {
"tags": [
"datamart-controller"
],
"description": "Refresh status of datamarts with the specified ids",
"operationId": "refreshStatusOfDatamartsByIds",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Status of given datamarts has been refreshed"
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/exports/excel": {
"post": {
"tags": [
"datamart-controller"
],
"description": "Export datamart to excel",
"operationId": "exportToExcel",
"parameters": [
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExcelExportRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/StreamingResponseBody"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
}
},
"/opt/api/v1/datamartservice/datamarts": {
"get": {
"tags": [
"datamart-controller"
],
"description": "The list of datamart definitions according to the specified ownership",
"operationId": "listDatamarts",
"parameters": [
{
"name": "ownership",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The list of datamart definitions according to the specified ownership",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartDefinitionDTO"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}/migrationanalysis": {
"get": {
"tags": [
"datamart-controller"
],
"description": "Analyze the given datamart and suggest actions to solve the issues in case of a migrated datamart",
"operationId": "migrationAnalysis",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Migration analysis response",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MigrationAnalysisResponse"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/{erid}/metadata": {
"get": {
"tags": [
"datamart-controller"
],
"description": "Datamart response with metadata according to the specified datamart id",
"operationId": "getDatamartMetadata",
"parameters": [
{
"name": "erid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Datamart response with metadata according to the specified datamart id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartResponse"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/v1/datamartservice/datamarts/summary/generate": {
"get": {
"tags": [
"datamart-summary-controller"
],
"description": "Populate datamart summary properties starting from the id of a sql datamart",
"operationId": "generateSummaryDatamartFromSqlId",
"parameters": [
{
"name": "byerid",
"in": "query",
"description": "Unique id of sql datamart used to generate summary datamart",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Summary datamart properties starting from the id of a sql datamart",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatamartSummaryFromSql"
}
}
}
},
"400": {
"description": "Invalid input",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"401": {
"description": "Wrong or missing authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"403": {
"description": "The requested resource is not accessible",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "An unexpected error occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
}
},
"/opt/api/datamarts/about": {
"get": {
"tags": [
"datamart-about-controller"
],
"operationId": "about",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/About"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"javax.validation.ConstraintViolationException",
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"java.lang.IllegalArgumentException"
]
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.servlet.NoHandlerFoundException",
"com.bmc.bco.dataprv.common.exception.ResourceNotFoundException"
]
},
"405": {
"description": "Method Not Allowed",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.HttpRequestMethodNotSupportedException"
]
},
"500": {
"description": "Internal Server Error",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"java.lang.Exception"
]
}
}
}
}
},
"components": {
"schemas": {
"ApiError": {
"required": [
"errorCode",
"message",
"status"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of error response",
"enum": [
"ERROR",
"WARNING"
]
},
"errorCode": {
"type": "string",
"description": "The code of error response"
},
"message": {
"type": "string",
"description": "The message of error response"
},
"errorDetails": {
"$ref": "#/components/schemas/ErrorDetails"
}
},
"description": "Default error response for API"
},
"ErrorDetails": {
"type": "object",
"properties": {
"datamart_name": {
"type": "string",
"description": "Name of the datamart"
},
"datamart_id": {
"type": "integer",
"description": "Id of the datamart",
"format": "int64"
}
},
"description": "Api error details"
},
"DatamartColumn": {
"required": [
"label",
"name",
"type"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Column name of the table in the DB"
},
"label": {
"type": "string",
"description": "Column label"
},
"description": {
"type": "string",
"description": "Column description"
},
"statistic": {
"$ref": "#/components/schemas/DatamartStatistic"
},
"statistics": {
"type": "array",
"description": "Multiple Statistic data",
"items": {
"type": "string",
"description": "Multiple Statistic data"
}
},
"type": {
"type": "string",
"description": "Column type",
"readOnly": true,
"enum": [
"RESOURCE",
"GENERIC",
"THRESHOLD",
"GENERIC_DOMAIN",
"METADATA",
"FORECAST_RESULTS",
"SUPPORTED_GROWTH",
"TAG",
"TS",
"RESOURCE,GENERIC"
]
},
"related_to": {
"type": "string",
"description": "It represents the relation between two columns id -> name. It is used to identify which is the column that contains the name for the id",
"readOnly": true
},
"resname": {
"type": "string",
"description": "Resource name (aka metric)",
"readOnly": true
},
"tagtype": {
"type": "string",
"description": "Tag type"
},
"parent_entity_type_name": {
"type": "string",
"description": "Parent entity type name"
},
"parent_relationship_id": {
"type": "integer",
"description": "Parent-child relationship id (aka parentshiptypeid)",
"format": "int32"
},
"include_threshold_column": {
"type": "boolean",
"description": "Flag to include additional threshold columns (only applicable to column type = RESOURCE)"
},
"include_metadata": {
"type": "array",
"description": "Indicator metadata names (only applicable to column type = RESOURCE)",
"items": {
"type": "string",
"description": "Indicator metadata names (only applicable to column type = RESOURCE)"
}
},
"sort_order": {
"type": "integer",
"description": "Column sorting preference for data retrieval",
"format": "int32"
},
"sub_resname": {
"type": "string",
"description": "Sub Resource Name",
"format": "string"
},
"sub_resnames": {
"type": "array",
"description": "Sub Resource Names",
"items": {
"type": "string",
"description": "Sub Resource Names"
}
},
"sort_direction": {
"type": "string",
"description": "Column sorting direction",
"format": "string",
"enum": [
"ASC,DESC"
]
},
"ref_resource_name": {
"type": "string",
"description": "Reference ByMetric Name column (applicable for indicator column)"
},
"parent_child_relationships": {
"type": "array",
"description": "Parent-child relationships",
"items": {
"$ref": "#/components/schemas/ParentChildRelationship"
}
},
"include_statistic_ts": {
"type": "boolean",
"description": "Flag to include an additional column storing time of computed statistic (applicable for min/max/pct* statistics)"
}
},
"description": "Defines the data mart column data"
},
"DatamartMaterializerTask": {
"type": "object",
"properties": {
"taskid": {
"type": "integer",
"description": "Task ID",
"format": "int64"
},
"name": {
"type": "string",
"description": "Task name"
},
"class_name": {
"type": "string",
"description": "Class name"
}
},
"description": "Defines the materialization task associated with the data mart, either taskid or className is mandatory"
},
"DatamartStatistic": {
"type": "object",
"properties": {
"statid": {
"type": "integer",
"description": "Statistic ID - it represents a unique key with the name field. Required if name is null",
"format": "int64"
},
"name": {
"type": "string",
"description": "Statistic name - it represents a unique key with the statid field. Required if statid is null"
}
},
"description": "Defines the statistic to extract"
},
"DatamartSummary": {
"required": [
"columns",
"entitytypenames",
"materializertask",
"name",
"resnames",
"structureid",
"timefilter"
],
"type": "object",
"properties": {
"erid": {
"type": "integer",
"description": "Unique Id of the Datamart Definition (not required in case of creation of a new data mart)",
"format": "int64",
"readOnly": true,
"example": 1000
},
"name": {
"type": "string",
"description": "Data mart name",
"example": "Virtual Clusters Overview"
},
"description": {
"type": "string",
"description": "Data mart description",
"example": "Extract data for all virtual clusters"
},
"identifier": {
"type": "string",
"description": "Identifier of the data mart. It represents the name of the SQL view that can be used to query the data mart. It must start with 'ER_V_'\n The field is optional, if it's not specified the API will return a predefined value based on the name of the data mart",
"readOnly": true,
"example": "ER_V_VIRTUAL_CLUSTER_EXPLORER"
},
"structureid": {
"type": "string",
"description": "It represents the structure of the entities to include in the datamart: SYS = System, WKLD = Business driver",
"example": "SYS",
"enum": [
"WKLD,SYS"
]
},
"entitytypeids": {
"type": "array",
"description": "List of entity type IDs",
"example": [
2,
6,
8,
9
],
"items": {
"type": "integer",
"description": "List of entity type IDs",
"format": "int32"
}
},
"entityfilterid": {
"type": "integer",
"description": "ID of entity filter",
"format": "int32"
},
"appids": {
"type": "array",
"description": "List of entity domains IDs",
"items": {
"type": "integer",
"description": "List of entity domains IDs",
"format": "int32"
}
},
"resnames": {
"type": "array",
"description": "List of resource names (aka metrics)",
"example": [
"CPU_NUM",
"CPU_UTIL",
"MEM_ALLOCATION"
],
"items": {
"type": "string",
"description": "List of resource names (aka metrics)",
"example": "[\"CPU_NUM\",\"CPU_UTIL\",\"MEM_ALLOCATION\"]"
}
},
"tagtypes": {
"type": "array",
"description": "List of tag type",
"example": [
"Owner",
"Environment"
],
"items": {
"type": "string",
"description": "List of tag type",
"example": "[\"Owner\",\"Environment\"]"
}
},
"timefilter": {
"$ref": "#/components/schemas/DatamartTimefilter"
},
"columns": {
"type": "array",
"description": "List of columns of the data mart",
"items": {
"$ref": "#/components/schemas/DatamartColumn"
}
},
"materializertask": {
"$ref": "#/components/schemas/DatamartMaterializerTask"
},
"parent": {
"$ref": "#/components/schemas/Parent"
},
"entitytypenames": {
"type": "array",
"description": "List of entity type names",
"example": [
"sys:asmc:ora",
"sys:az:os",
"sys:asg:aws"
],
"items": {
"type": "string",
"description": "List of entity type names",
"example": "[\"sys:asmc:ora\",\"sys:az:os\",\"sys:asg:aws\"]"
}
},
"domain": {
"$ref": "#/components/schemas/Domain"
},
"namespace": {
"type": "string",
"description": "Virtual node namespace"
},
"contextids": {
"type": "array",
"description": "List of context ids (e.g. golden model scenario ids)",
"example": [
"9",
"10",
"11"
],
"items": {
"type": "string",
"description": "List of context ids (e.g. golden model scenario ids)",
"example": "[\"9\",\"10\",\"11\"]"
}
},
"migration.fromerid": {
"type": "integer",
"description": "Optional sql datamart id from which the summary datamart has been generated",
"format": "int64"
},
"entitystatus": {
"type": "array",
"description": "List of the status of the entities to filter",
"example": [
1,
2
],
"items": {
"type": "integer",
"description": "List of the status of the entities to filter",
"format": "int32"
}
}
},
"description": "Contains the data mart definition"
},
"DatamartTimefilter": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Time filter type: GLOBAL = based on a global time filter, SINCE_TO = based on a period defined with a from and to, LASTEX = based on last hours|days|months|years, ROLL = based on roll periods",
"format": "string",
"example": "LASTEX",
"enum": [
"GLOBAL",
"SINCE_TO",
"LASTEX",
"ROLL",
"GLOBAL,SINCE_TO,LASTEX,ROLL"
]
},
"globalfilterid": {
"type": "integer",
"description": "Global time filter ID - required when type = GLOBAL",
"format": "int64",
"example": 1000
},
"since": {
"type": "string",
"description": "Start date of the Time range option (YYYY-MM-DD) - required when type = SINCE_TO",
"example": "2019-12-25"
},
"to": {
"type": "string",
"description": "End date of the Time range option (YYYY-MM-DD) - required when type = SINCE_TO",
"example": "2019-12-25"
},
"lastex": {
"$ref": "#/components/schemas/LastexTimefilter"
},
"label": {
"type": "string",
"description": "Time filter label",
"example": "Last 180 days"
},
"resolution": {
"type": "string",
"description": "Time filter resolution",
"example": "AUTOMATIC|RAW|DETAIL|HOUR|WEEK|MONTH"
}
},
"description": "Defines the time filter to use in the data mart"
},
"Domain": {
"type": "object",
"properties": {
"include_parent": {
"type": "boolean",
"description": "Flag to include immediate parent domain information"
},
"include_root_business_service": {
"type": "boolean",
"description": "Flag to include top most business service domain information"
},
"include_root_application": {
"type": "boolean",
"description": "Flag to include top most application domain information"
},
"include_root_parent": {
"type": "boolean",
"description": "Flag to include root parent domain information"
},
"parent_tags": {
"type": "array",
"description": "List of Immediate parent domain tag types",
"items": {
"type": "string",
"description": "List of Immediate parent domain tag types"
}
},
"root_parent_tags": {
"type": "array",
"description": "List of Root parent domain tag types",
"items": {
"type": "string",
"description": "List of Root parent domain tag types"
}
},
"root_application_tags": {
"type": "array",
"description": "List of Root application domain tag types",
"items": {
"type": "string",
"description": "List of Root application domain tag types"
}
},
"root_business_service_tags": {
"type": "array",
"description": "List of Root business service domain tag types",
"items": {
"type": "string",
"description": "List of Root business service domain tag types"
}
},
"root_business_service_tag.macro": {
"type": "string",
"description": "Root business service domain tag type macro"
},
"root_application_tag.macro": {
"type": "string",
"description": "Root application domain tag type macro"
},
"root_parent_tag.macro": {
"type": "string",
"description": "Root parent domain tag type macro"
},
"parent_tag.macro": {
"type": "string",
"description": "Parent domain tag type macro"
}
},
"description": "Defines domain extraction information"
},
"LastexTimefilter": {
"required": [
"period",
"quantity"
],
"type": "object",
"properties": {
"period": {
"type": "string",
"description": "Type of last period. H = hours, D = days, M = months, Y = years",
"format": "string",
"example": "D",
"enum": [
"H",
"D",
"M",
"Y",
"H,D,M,Y"
]
},
"quantity": {
"type": "integer",
"description": "The quantity of the period ",
"format": "int32",
"example": 30
},
"include_current": {
"type": "boolean",
"description": "Indicates if the time filter includes the current date: true, false",
"example": false
}
},
"description": "Defines the Last period options"
},
"Parent": {
"type": "object",
"properties": {
"typeids": {
"type": "array",
"description": "List of Parent entity type IDs",
"items": {
"type": "integer",
"description": "List of Parent entity type IDs",
"format": "int32"
}
},
"resnames": {
"type": "array",
"description": "List of Parent entity resource names (aka metrics)",
"items": {
"type": "string",
"description": "List of Parent entity resource names (aka metrics)"
}
},
"relationshipid": {
"type": "integer",
"description": "It represents the parent->child relationshipid (aka parentshiptypeid)",
"format": "int32"
},
"typenames": {
"type": "array",
"description": "List of Parent entity type names",
"items": {
"type": "string",
"description": "List of Parent entity type names"
}
},
"parent_child_relationships": {
"type": "array",
"description": "Map of Parent child relationships",
"items": {
"$ref": "#/components/schemas/ParentChildRelationship"
}
}
},
"description": "Defines the (parent entities or relationshipid(aka parentshiptypeid)) and its resnames which also needs to extract in datamart"
},
"ParentChildRelationship": {
"type": "object",
"properties": {
"parent_entity_type_name": {
"type": "string",
"description": "Parent entity type name"
},
"child_entity_type_name": {
"type": "string",
"description": "Child entity type name"
}
},
"description": "Defines parent child relationships"
},
"DatamartRequest": {
"type": "object",
"properties": {
"raw_options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestFilter"
}
},
"options": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestAggregation"
}
},
"group_by": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"RequestAggregation": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"operation": {
"type": "string",
"enum": [
"avg",
"sum",
"min",
"max",
"count"
]
},
"displayAs": {
"type": "string"
}
}
},
"RequestFilter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"condition": {
"type": "string"
},
"value": {
"type": "object"
},
"values": {
"type": "array",
"items": {
"type": "object"
}
},
"note": {
"type": "string"
}
}
},
"DatamartColumnMetadata": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"meaning": {
"type": "string",
"enum": [
"BREADCRUMB",
"TAG",
"TS",
"VALUE",
"SYSID",
"SYSNAME",
"SYSTYPEID",
"SYSTYPENAME",
"WKLDID",
"WKLDNAME",
"WKLDTYPEID",
"WKLDTYPENAME",
"ENTSTATUS",
"APPID",
"APPNAME",
"APPTYPEID",
"APPTYPENAME",
"THRESHOLD_GOOD",
"THRESHOLD_WARN",
"SUBRESOURCE",
"MODELID",
"SCENARIOID",
"NONE"
]
},
"unit": {
"type": "string"
},
"resource": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"datatype": {
"type": "string",
"enum": [
"NUMBER",
"VARCHAR",
"TIMESTAMP",
"DATE",
"BOOLEAN",
"VARCHAR_ARRAY"
]
},
"relatedto": {
"$ref": "#/components/schemas/DatamartColumnMetadata"
}
}
},
"DatamartFilterMetadata": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"filtertype": {
"type": "string",
"enum": [
"list-of-value",
"by-entity-type",
"rbac-filter",
"domain-filter",
"tags-filter",
"cloud-tags-filter",
"time-filter-fixed",
"time-filter",
"lastxdays-time-filter"
]
},
"entitystructureid": {
"type": "string"
},
"entitytypeid": {
"type": "array",
"items": {
"type": "string"
}
},
"entity_type_id_semi_col_separated": {
"type": "string"
},
"relatedto": {
"$ref": "#/components/schemas/DatamartFilterMetadata"
}
}
},
"DatamartMainMetadata": {
"type": "object",
"properties": {
"percentage.upperbound": {
"type": "integer",
"format": "int32"
},
"main.entity": {
"type": "string"
}
}
},
"DatamartPagination": {
"type": "object",
"properties": {
"has.more.data": {
"type": "boolean"
},
"page_number": {
"type": "integer",
"format": "int32"
},
"page_size": {
"type": "integer",
"format": "int32"
}
}
},
"DatamartResponse": {
"type": "object",
"properties": {
"data.format": {
"type": "string",
"enum": [
"EXTENDED",
"ARRAY",
"FILTERS"
]
},
"metadata": {
"$ref": "#/components/schemas/DatamartMainMetadata"
},
"datafields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatamartColumnMetadata"
}
},
"filtermetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatamartFilterMetadata"
}
},
"standardfiltermetadata": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/DatamartFilterMetadata"
}
},
"pagination": {
"$ref": "#/components/schemas/DatamartPagination"
},
"sorting": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestFilter"
}
},
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestFilter"
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"data.array": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"name": {
"type": "string"
},
"aggregations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestAggregation"
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"group_by": {
"type": "array",
"items": {
"type": "string"
}
},
"defaultsortedcolumns": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"BaseValidationMessage": {
"type": "object",
"description": "Summary Datamart validation message"
},
"ValidationMessages": {
"type": "object",
"properties": {
"validation_messages": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BaseValidationMessage"
}
}
}
},
"description": "Summary Datamart validation messages"
},
"BuildColumnRequest": {
"required": [
"resnames",
"structureid"
],
"type": "object",
"properties": {
"structureid": {
"type": "string",
"description": "ID of structure used for the data mart wizard",
"enum": [
"WKLD,SYS"
]
},
"resnames": {
"type": "array",
"description": "List of resource names (aka metrics)",
"items": {
"type": "string",
"description": "List of resource names (aka metrics)"
}
},
"tagtypes": {
"type": "array",
"description": "List of tag types",
"items": {
"type": "string",
"description": "List of tag types"
}
},
"parent": {
"$ref": "#/components/schemas/Parent"
}
},
"description": "Structure and metrics data object"
},
"RefreshStatusRequest": {
"type": "object",
"properties": {
"er_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"DataFieldCustomMappingFormat": {
"required": [
"label",
"name",
"renderer"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DataFieldFormat"
},
{
"type": "object",
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Mapping"
}
}
}
}
]
},
"DataFieldFormat": {
"required": [
"label",
"name",
"renderer"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"name": {
"type": "string"
},
"renderer": {
"type": "string",
"enum": [
"text",
"number",
"customMapping",
"timestamp",
"recommSummary"
]
}
},
"discriminator": {
"propertyName": "renderer"
}
},
"DataFieldNumberFormat": {
"required": [
"label",
"name",
"renderer"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DataFieldFormat"
},
{
"type": "object",
"properties": {
"numberFormat": {
"$ref": "#/components/schemas/NumberFormat"
}
}
}
]
},
"DataFieldTimestamp": {
"required": [
"label",
"name",
"renderer"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/DataFieldFormat"
},
{
"type": "object",
"properties": {
"dateFormat": {
"$ref": "#/components/schemas/DateFormat"
}
}
}
]
},
"DatamartExcelExportConfiguration": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestFilter"
}
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"martFormat": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DataFieldFormat"
},
{
"$ref": "#/components/schemas/DataFieldCustomMappingFormat"
},
{
"$ref": "#/components/schemas/DataFieldNumberFormat"
},
{
"$ref": "#/components/schemas/DataFieldTimestamp"
}
]
}
}
}
},
"DateFormat": {
"type": "object",
"properties": {
"format": {
"type": "string"
}
}
},
"ExcelExportRequest": {
"type": "object",
"properties": {
"footer": {
"$ref": "#/components/schemas/Footer"
},
"marts": {
"type": "object",
"properties": {
"involved_datamarts": {
"type": "array",
"items": {
"type": "number"
}
},
"empty": {
"type": "boolean"
}
},
"additionalProperties": {
"$ref": "#/components/schemas/DatamartExcelExportConfiguration"
}
}
}
},
"Footer": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"content": {
"type": "string"
}
}
},
"Mapping": {
"type": "object",
"properties": {
"match": {
"type": "string"
},
"mappedTo": {
"type": "string"
}
}
},
"NumberFormat": {
"type": "object",
"properties": {
"inUnit": {
"type": "string"
},
"outUnit": {
"type": "string"
},
"useInteger": {
"type": "boolean"
},
"exportFullPrecision": {
"type": "boolean"
},
"percentageUpperbound": {
"type": "integer",
"format": "int32"
}
}
},
"Sorting": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
}
},
"StreamingResponseBody": {
"type": "object"
},
"DatamartDefinitionDTO": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"datamarts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatamartEntryDTO"
}
}
}
},
"DatamartEntryDTO": {
"type": "object",
"properties": {
"erid": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"physname": {
"type": "string"
},
"description": {
"type": "string"
},
"ertypeid": {
"type": "string"
},
"ownership": {
"type": "integer",
"format": "int32"
},
"creationdate": {
"type": "string",
"format": "date-time"
},
"updatedate": {
"type": "string",
"format": "date-time"
},
"statusid": {
"type": "integer",
"format": "int32"
},
"lastRefreshDate": {
"type": "string",
"format": "date-time"
}
}
},
"DatamartExtractedInformation": {
"type": "object",
"properties": {
"structureid": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "string"
}
},
"generic_columns": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DependentDatamartResponse": {
"type": "object",
"properties": {
"erid": {
"type": "number"
},
"name": {
"type": "string"
},
"statusid": {
"type": "integer",
"format": "int32"
}
}
},
"ErrorReason": {
"type": "object",
"properties": {
"unsupported_objects": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MigrationAnalysisResponse": {
"type": "object",
"properties": {
"erid": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"statusid": {
"type": "integer",
"format": "int32"
},
"ertypeid": {
"type": "string"
},
"ownership": {
"type": "integer",
"format": "int32"
},
"physical_name": {
"type": "string"
},
"error_reason": {
"$ref": "#/components/schemas/ErrorReason"
},
"depends_on_datamarts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependentDatamartResponse"
}
},
"datamart_extracted_information": {
"$ref": "#/components/schemas/DatamartExtractedInformation"
},
"suggest_entity_filter": {
"type": "boolean"
},
"proposed_summary_datamart": {
"$ref": "#/components/schemas/ProposedSummaryDatamart"
},
"proposed_entity_filter": {
"$ref": "#/components/schemas/ProposedEntityFilter"
}
}
},
"ProposedEntityFilter": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
}
}
},
"ProposedSummaryDatamart": {
"type": "object",
"properties": {
"erid": {
"type": "number"
},
"name": {
"type": "string"
},
"physical_name": {
"type": "string"
}
}
},
"DatamartSummaryFromSql": {
"type": "object",
"properties": {
"summary_datamart": {
"$ref": "#/components/schemas/DatamartSummary"
}
},
"description": "Contains the data mart definition generated starting from sql datamart"
},
"About": {
"type": "object",
"properties": {
"product": {
"type": "string"
},
"component": {
"type": "string"
},
"api_versions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}