Catalog Proxy API endpoints
Use the Catalog Proxy API endpoints to retrieve the entities available in the entity catalog. Before you run an endpoint, make sure that you authenticate the API request.
{
"openapi": "3.0.1",
"paths": {
"/opt/api/v1/catalogproxy/tags/types": {
"post": {
"tags": [
"catalog-tags-controller"
],
"description": "Retrieve tag types",
"operationId": "getTagTypes",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagTypesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Retrieve tags types",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagTypes"
}
}
}
},
"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/catalogproxy/tags/search": {
"post": {
"tags": [
"catalog-tags-controller"
],
"description": "Search tag according to search request",
"operationId": "searchTag",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Response of tag search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagSearchResponse"
}
}
}
},
"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/catalogproxy/tags/bytagtype": {
"post": {
"tags": [
"catalog-tags-controller"
],
"description": "Get tags according to tag type",
"operationId": "getTagsByTagType",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagTypeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Response of tag search",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagTypeResponse"
}
}
}
},
"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/catalogproxy/statistics/{structureid}": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getMetricsStatistics",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricsStatisticsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MetricsStatisticsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/perfmetrics/{structureid}": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getFilteredGroupedPerfResCounterList",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GroupedMetricList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/model/{modelid}/tc/{tcid}/{structid}": {
"post": {
"tags": [
"catalog-model-controller"
],
"operationId": "getScenarioEntities",
"parameters": [
{
"name": "modelid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "tcid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "structid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenarioDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/model/{modelid}/tc/{tcid}/{structid}/count": {
"post": {
"tags": [
"catalog-model-controller"
],
"operationId": "getScenarioEntitiesCount",
"parameters": [
{
"name": "modelid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "tcid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "structid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenarioDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/CountResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/model/{modelid}/tc/{tcid}/data": {
"post": {
"tags": [
"catalog-model-controller"
],
"operationId": "getScenarioData",
"parameters": [
{
"name": "modelid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "tcid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScenarioDataRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ScenarioDataResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/metrics/{structureid}": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getFilteredGroupedResCounterList",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GroupedMetricList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/metrics/{structureid}/flat": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getFilteredFlatResCounterList",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MetricList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/metricprofiles/flat": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getFilteredMetricProfileEntriesList",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricProfileRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MetricProfileList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/etl": {
"post": {
"tags": [
"catalog-etl-controller"
],
"description": "Get a list of ETL with information about the task",
"operationId": "getETLs",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETLFilters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "the list of all ETLs matching the filters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETLInfo"
}
}
}
},
"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/catalogproxy/etl/{taskid}/lookups": {
"post": {
"tags": [
"catalog-etl-controller"
],
"description": "Get a list of entities and lookup fields and values for a given ETL",
"operationId": "getETLLookups",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityCatalogNavigationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "the filtered list of lookup fields and values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityCatalogNavigationResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/etl/{taskid}/lastcounters": {
"get": {
"tags": [
"catalog-etl-controller"
],
"description": "Get lastcounters for a given ETL",
"operationId": "getETLLastCounters",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "the last counter list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETLLastcounters"
}
}
}
},
"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"
}
}
}
}
}
},
"post": {
"tags": [
"catalog-etl-controller"
],
"description": "Save lastcounters for a given ETL. Save works in update or insert mode, removing lastcounters no more populated.",
"operationId": "alignETLLastcounters",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETLLastcounters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entitytypes/{structureid}/parentByEntityType": {
"post": {
"tags": [
"catalog-entity-types-controller"
],
"description": "Retrieve parent entity types according to structure",
"operationId": "getParentEntityTypesByEntityType",
"parameters": [
{
"name": "structureid",
"in": "path",
"description": "Structure identifier",
"required": true,
"schema": {
"type": "string"
},
"example": "SYS"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The list of entity type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityTypesResponse"
}
}
}
},
"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/catalogproxy/entities/{structureid}": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchEntities",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResult"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{structureid}/{entityid}": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "entityDetail",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entityid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{structureid}/{entityid}/subresources": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchSubresources",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entityid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubresourcesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SubresourcesResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{structureid}/{entityid}/confhistory": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "getConfHistoryByEntityAndFilters",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entityid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfHistoryRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ConfHistoryResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{structureid}/{entityid}/children/{childrenstructureid}": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchEntitiesChildren",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entityid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "childrenstructureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{structureid}/subresources": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchSubresources_1",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubresourcesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SubresourcesResult"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{structureid}/count": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "getEntitiesCountByEntityTypes",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitiesByTypeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/{entityid}/tags": {
"post": {
"tags": [
"catalog-entities-controller"
],
"description": "Assign tag",
"operationId": "tagsAssignment",
"parameters": [
{
"name": "entityid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagsAssignmentRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Tag assignment done"
},
"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/catalogproxy/entities/search/free": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "retrieveFreeSearchResults",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardFreeSearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DashboardFreeSearchResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/filter": {
"get": {
"tags": [
"catalog-entities-controller"
],
"operationId": "getEntitiesByFilter_1",
"parameters": [
{
"name": "filter",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntitiesByFilterResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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"
]
}
}
},
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "getEntitiesByFilter",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntitiesByFilterRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/domains": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchDomains",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/SYS/children/SYS": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchSystemsChildren",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/MODEL/search": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchModelsWithNameLike",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SearchDomainsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/APP/{rootappid}/flatsearch": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "flatSearchDomainsByRootAppId",
"parameters": [
{
"name": "rootappid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SearchDomainsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/APP/{appid}/children/{childrenstructureid}": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchDomainsChildren",
"parameters": [
{
"name": "appid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "childrenstructureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/APP/{appid}/children/MODEL": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchFirstLevelChildrenModel",
"parameters": [
{
"name": "appid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/APP/flatsearch": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "flatSearchDomains",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SearchDomainsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/entities/APP/children/{childrenstructureid}": {
"post": {
"tags": [
"catalog-entities-controller"
],
"operationId": "searchDomainsChildren_1",
"parameters": [
{
"name": "childrenstructureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ChildrenEntitiesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/confprops": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getConfProperties",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfPropsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfPropsDto"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/confmetrics/{structureid}": {
"post": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getFilteredGroupedConfResCounterList",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MetricListRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GroupedMetricList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/audits/bulk": {
"post": {
"tags": [
"catalog-audit-controller"
],
"description": "Perform auditing of the given set of messages",
"operationId": "audit",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditInfo"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/valtypes": {
"get": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getValtypes",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ValtypeList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/timefilters": {
"get": {
"tags": [
"catalog-time-filters-controller"
],
"description": "Retrieve time filters list according to appid",
"operationId": "getTimeFilter",
"parameters": [
{
"name": "appid",
"in": "query",
"required": false,
"schema": {
"type": "number",
"default": 0
}
}
],
"responses": {
"200": {
"description": "Time filters list according to appid",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimeFilter"
}
}
}
}
},
"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/catalogproxy/metrics/{structureid}/{systypenm}": {
"get": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getMetricsList",
"parameters": [
{
"name": "structureid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "systypenm",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricValTypeDto"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/materializerTasks": {
"get": {
"tags": [
"catalog-materializer-task-controller"
],
"description": "Retrieve all materializer tasks",
"operationId": "getMaterializerTasks",
"responses": {
"200": {
"description": "The list of all materializer tasks",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterializerTask"
}
}
}
},
"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/catalogproxy/indmetrics/{systypename}": {
"get": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "selectInputIndicators",
"parameters": [
{
"name": "systypename",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricValTypeDto"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/etlmodule/{etlmodid}": {
"get": {
"tags": [
"catalog-etl-module-controller"
],
"description": "Extract information for a given ETL module. ETL module identifier is provided as path parameter.",
"operationId": "getETLModuleInfo",
"parameters": [
{
"name": "etlmodid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ETLModuleInfo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/etl/{taskid}": {
"get": {
"tags": [
"catalog-etl-controller"
],
"description": "Extract information for a given ETL. Task identifier is provided as path parameter.",
"operationId": "getETLInfo",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "the list of all ETLs matching the filters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETLInfo"
}
}
}
},
"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/catalogproxy/etl/{taskid}/countByType": {
"get": {
"tags": [
"catalog-etl-controller"
],
"description": "Extract for a given ETL the count of the entities grouped by entity type",
"operationId": "getETLCountByType",
"parameters": [
{
"name": "taskid",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "last_activity_lastex",
"in": "query",
"description": "filter entities with the last activity greater than the provided period (H = hours, D = days, M = months, Y = years) back, excluding current",
"required": false,
"schema": {
"type": "string"
},
"example": "D7"
}
],
"responses": {
"200": {
"description": "the list of all entity types this ETL extracted with their count",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ETLCountByType"
}
}
}
},
"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/catalogproxy/entitytypes/{structureid}": {
"get": {
"tags": [
"catalog-entity-types-controller"
],
"description": "Retrieve entity types according to structure and system type",
"operationId": "getEntityTypes",
"parameters": [
{
"name": "structureid",
"in": "path",
"description": "Structure identifier",
"required": true,
"schema": {
"type": "string"
},
"example": "SYS"
},
{
"name": "systypegroupid",
"in": "query",
"description": "System group identifier",
"required": false,
"schema": {
"type": "number"
},
"example": 1
},
{
"name": "withmetrics",
"in": "query",
"description": "Include or not metrics",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": true
}
],
"responses": {
"200": {
"description": "The list of entity type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityTypesResponse"
}
}
}
},
"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/catalogproxy/entitytypes/{structureid}/{typeid}/parents/{structureidparent}": {
"get": {
"tags": [
"catalog-entity-types-controller"
],
"description": "Retrieve children entity types according to structure, type and parent structure",
"operationId": "getParentEntityTypes",
"parameters": [
{
"name": "structureid",
"in": "path",
"description": "Structure identifier",
"required": true,
"schema": {
"type": "string"
},
"example": "SYS"
},
{
"name": "typeid",
"in": "path",
"description": "Type identifier",
"required": true,
"schema": {
"type": "number"
},
"example": 31
},
{
"name": "structureidparent",
"in": "path",
"description": "Parent structure identifier",
"required": true,
"schema": {
"type": "string"
},
"example": "SYS"
}
],
"responses": {
"200": {
"description": "The list of entity type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityTypesResponse"
}
}
}
},
"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/catalogproxy/entitytypes/{structureid}/{typeid}/children/{structureidchild}": {
"get": {
"tags": [
"catalog-entity-types-controller"
],
"description": "Retrieve children entity types according to structure, type and child structure",
"operationId": "getChildrenEntityTypes",
"parameters": [
{
"name": "structureid",
"in": "path",
"description": "Structure identifier",
"required": true,
"schema": {
"type": "string"
},
"example": "SYS"
},
{
"name": "typeid",
"in": "path",
"description": "Type identifier",
"required": true,
"schema": {
"type": "number"
},
"example": 31
},
{
"name": "structureidchild",
"in": "path",
"description": "Children structure identifier",
"required": true,
"schema": {
"type": "string"
},
"example": "SYS"
}
],
"responses": {
"200": {
"description": "The list of entity type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityTypesResponse"
}
}
}
},
"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/catalogproxy/entityfilters": {
"get": {
"tags": [
"catalog-entities-filters-controller"
],
"description": "retrieve all entity filters",
"operationId": "getEntityFilters",
"parameters": [
{
"name": "includeOOTB",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "the list of all entity filters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityFilter"
}
}
}
},
"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/catalogproxy/datasets": {
"get": {
"tags": [
"catalog-datasets-and-metrics-controller"
],
"operationId": "getDatasetList",
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DatasetList"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
},
"x-exception-class": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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/catalogproxy/analyses/templates/{plottemplid}": {
"get": {
"tags": [
"catalog-analyses-template-controller"
],
"description": "Retrieve analysis template properties according to template id",
"operationId": "getPlotTemplateProperties",
"parameters": [
{
"name": "plottemplid",
"in": "path",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Template properties according to template id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlotTemplateInformation"
}
}
}
},
"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/catalogproxy/analyses/templates/flat": {
"get": {
"tags": [
"catalog-analyses-template-controller"
],
"description": "Retrieve analysis template list according to template type",
"operationId": "getFlatPlotTemplates",
"parameters": [
{
"name": "templatetype",
"in": "query",
"description": "Template type",
"required": true,
"schema": {
"type": "string"
},
"example": "ERTA"
}
],
"responses": {
"200": {
"description": "the list of all analysis templates",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlotTemplateList"
}
}
}
},
"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/catalogproxy/about": {
"get": {
"tags": [
"catalog-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": [
"org.springframework.web.bind.MissingServletRequestParameterException",
"java.lang.IllegalStateException",
"javax.validation.ConstraintViolationException",
"org.springframework.http.converter.HttpMessageNotReadableException",
"org.springframework.web.bind.MethodArgumentNotValidException",
"org.springframework.web.method.annotation.MethodArgumentTypeMismatchException",
"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"
},
"TagTypesRequest": {
"type": "object",
"properties": {
"entity_type_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"TagType": {
"type": "object",
"properties": {
"tagtypeid": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"TagTypes": {
"type": "object",
"properties": {
"tag.types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagType"
}
}
}
},
"TagSearchRequest": {
"type": "object",
"properties": {
"search.string": {
"type": "string"
}
}
},
"Tag": {
"type": "object",
"properties": {
"tagid": {
"type": "string"
},
"tag": {
"type": "string"
}
}
},
"TagSearchResponse": {
"type": "object",
"properties": {
"search.string": {
"type": "string"
},
"tag.types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagTypeWithTags"
}
}
}
},
"TagTypeWithTags": {
"type": "object",
"properties": {
"tagtypeid": {
"type": "string"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
},
"TagTypeRequest": {
"type": "object",
"properties": {
"tagtypeid": {
"type": "string"
},
"entitytype": {
"type": "string"
}
}
},
"TagTypeResponse": {
"type": "object",
"properties": {
"tagtypeid": {
"type": "string"
},
"entitytype": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MetricsStatisticsRequest": {
"type": "object",
"properties": {
"resname": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MetricStatistic": {
"type": "object",
"properties": {
"statid": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"statistic_type": {
"type": "string"
},
"ownership": {
"type": "number"
}
}
},
"MetricsStatisticsResponse": {
"type": "object",
"properties": {
"metricStatisticMap": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricStatistic"
}
}
}
}
},
"MetricListRequest": {
"type": "object",
"properties": {
"valtypeid": {
"type": "integer",
"format": "int32"
},
"entityid": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"entitytypeid": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"numericonly": {
"type": "boolean"
},
"resnames": {
"type": "array",
"items": {
"type": "string"
}
},
"byonly": {
"type": "boolean"
},
"excludeby": {
"type": "boolean"
},
"extended": {
"type": "boolean"
}
}
},
"GroupedMetricList": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"structureid": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricGroup"
}
}
}
},
"MetricGroup": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceCounterEntry"
}
}
}
},
"ResourceCounterEntry": {
"type": "object",
"properties": {
"resname": {
"type": "string"
},
"name": {
"type": "string"
},
"unit": {
"type": "string"
},
"valtypeid": {
"type": "integer",
"format": "int32"
},
"datasetid": {
"type": "integer",
"format": "int32"
},
"metriclevel": {
"type": "integer",
"format": "int32"
},
"alias": {
"type": "array",
"items": {
"type": "string"
}
},
"relevance": {
"type": "integer",
"format": "int32"
},
"restype": {
"type": "string"
},
"custom": {
"type": "boolean"
}
}
},
"Filters": {
"type": "object",
"properties": {
"sysid": {
"type": "array",
"items": {
"type": "number"
}
},
"wkldid": {
"type": "array",
"items": {
"type": "number"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"appid": {
"type": "array",
"items": {
"type": "number"
}
},
"search.string": {
"type": "string"
}
}
},
"ModelResult": {
"type": "object",
"properties": {
"execution": {
"type": "string",
"enum": [
"AUTO",
"FORCE"
]
},
"path": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"EXISTS",
"GENERATED"
]
}
}
},
"Pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"total_records": {
"type": "integer",
"format": "int32"
},
"has_more_data": {
"type": "boolean"
}
}
},
"ScenarioDataRequest": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"result": {
"$ref": "#/components/schemas/ModelResult"
}
}
},
"BreadcrumbPart": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"structureid": {
"type": "string"
}
}
},
"ConfMetricResult": {
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"metricname": {
"type": "string"
},
"submetricname": {
"type": "string"
},
"locationid": {
"type": "number"
},
"locationname": {
"type": "string"
},
"unit": {
"type": "string"
},
"value": {
"type": "object"
}
}
},
"ContainedElementsResult": {
"type": "object",
"properties": {
"systypegroup": {
"type": "string"
},
"instances": {
"type": "number"
}
}
},
"Entities": {
"type": "object",
"properties": {
"APP": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResult"
}
},
"SYS": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResult"
}
},
"WKLD": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResult"
}
},
"MODEL": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResult"
}
},
"FOLD": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityResult"
}
}
}
},
"EntityResult": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"structureid": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"agentos": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EntityType"
},
"confmetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfMetricResult"
}
},
"containedelements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContainedElementsResult"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagResult"
}
},
"recommendations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecommendationResult"
}
},
"monitoringstatus": {
"$ref": "#/components/schemas/MonitoringStatus"
},
"scenarios": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Scenario"
}
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"breadcrumb": {
"type": "array",
"properties": {
"empty": {
"type": "boolean"
}
},
"items": {
"$ref": "#/components/schemas/BreadcrumbPart"
}
},
"status_id": {
"type": "number"
},
"haschildren": {
"type": "boolean"
},
"children": {
"$ref": "#/components/schemas/Entities"
},
"hasvirtualnode": {
"type": "boolean"
}
}
},
"EntityType": {
"required": [
"description",
"id",
"name",
"typenm"
],
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "Entity type identifier",
"example": 47
},
"name": {
"type": "string",
"description": "Entity type name",
"example": "Virtual Application - VMware vApp"
},
"description": {
"type": "string",
"description": "Entity type description",
"example": "a VMware vApp Guest Application"
},
"typenm": {
"type": "string",
"description": "Type of entity",
"example": "gapp:vapp"
}
},
"description": "Entity type object",
"example": "\"entitytypes\": [\n {\n \"id\": 47,\n \"name\": \"Virtual Application - VMware vApp\",\n \"description\": \"a VMware vApp Guest Application\",\n \"typenm\": \"gapp:vapp\"\n },\n {\n \"id\": 38,\n \"name\": \"Virtual Cluster - VMware\",\n \"description\": \"a VMware virtual cluster\",\n \"typenm\": \"vhc:vmw\"\n }]"
},
"MonitoringStatus": {
"type": "object",
"properties": {
"monitored": {
"type": "boolean"
},
"monitoringinformation": {
"type": "object",
"properties": {
"empty": {
"type": "boolean"
}
},
"additionalProperties": {
"type": "string"
}
}
}
},
"RecommendationResult": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"resources": {
"type": "string"
},
"priority": {
"type": "number"
},
"description": {
"type": "string"
},
"recommendation": {
"type": "string"
},
"alertid": {
"type": "number"
},
"alertname": {
"type": "string"
},
"alerttypeid": {
"type": "number"
},
"alerttype": {
"type": "string"
},
"alertcategory": {
"type": "string"
},
"alertseverity": {
"type": "string"
},
"alertseverityindex": {
"type": "number"
},
"alertcolor": {
"type": "string"
},
"templateid": {
"type": "number"
},
"templatename": {
"type": "string"
},
"availablemetricscodes": {
"type": "string"
},
"aggressivenesslevel": {
"type": "string"
},
"smalldescription": {
"type": "string"
}
}
},
"Scenario": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"status_id": {
"type": "number"
},
"rundate": {
"type": "string",
"format": "date-time"
},
"last_refresh_message": {
"type": "string"
}
}
},
"TagResult": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type_id": {
"type": "string"
},
"type_name": {
"type": "string"
}
}
},
"CountResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"filters": {
"$ref": "#/components/schemas/Filters"
}
}
},
"Axis": {
"type": "object",
"properties": {
"max_y": {
"type": "number",
"format": "double"
},
"min_y": {
"type": "number",
"format": "double"
},
"requested_max_x": {
"type": "object"
},
"max_y_right": {
"type": "number",
"format": "double"
},
"min_y_right": {
"type": "number",
"format": "double"
},
"requested_min_x": {
"type": "object"
},
"time_res_min_in_seconds": {
"type": "integer",
"format": "int32"
}
}
},
"ChartResult": {
"type": "object",
"properties": {
"datafields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
}
},
"axis": {
"$ref": "#/components/schemas/Axis"
},
"labels": {
"$ref": "#/components/schemas/Labels"
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"guides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Guide"
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"Event": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"title": {
"type": "string"
},
"ts": {
"type": "string",
"format": "date-time"
},
"resolutionts": {
"type": "string",
"format": "date-time"
},
"event_type_id": {
"type": "number"
},
"event_type_title": {
"type": "string"
},
"event_type_color": {
"type": "string"
}
}
},
"Guide": {
"type": "object",
"properties": {
"axis": {
"type": "string"
},
"value": {
"type": "object"
},
"tovalue": {
"type": "object"
},
"fillcolor": {
"type": "string"
},
"linestyle": {
"type": "integer",
"format": "int32"
}
}
},
"Labels": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"subtitle": {
"type": "string"
},
"xaxis": {
"type": "object"
},
"yaxis": {
"type": "string"
},
"yaxis_right": {
"type": "string"
}
}
},
"ScenarioDataResponse": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"status_id": {
"type": "number"
},
"rundate": {
"type": "string",
"format": "date-time"
},
"last_refresh_message": {
"type": "string"
},
"extendedname": {
"type": "string"
},
"charts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChartResult"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"filters": {
"$ref": "#/components/schemas/Filters"
},
"entities_involved": {
"type": "array",
"items": {
"type": "string"
}
},
"time_filter_label": {
"type": "string"
},
"result": {
"$ref": "#/components/schemas/ModelResult"
}
}
},
"Series": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"metric": {
"type": "string"
},
"label": {
"type": "string"
},
"subobject": {
"type": "string"
},
"location": {
"type": "string"
},
"unit": {
"type": "string"
},
"statistic": {
"type": "string"
},
"datatype": {
"type": "string"
},
"meaning": {
"type": "string",
"enum": [
"CATEGORY",
"TS",
"METRIC",
"RANGE",
"FORECAST",
"PREDICTION_BAND_UPPER",
"PREDICTION_BAND_LOWER",
"GOOD_THRESHOLD",
"WARN_THRESHOLD",
"SPEC_THRESHOLD"
]
},
"rendering_options": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"series_id": {
"type": "integer",
"format": "int64"
},
"entity_id": {
"type": "number"
},
"structure_id": {
"type": "string"
},
"related_to": {
"type": "string"
}
}
},
"MetricList": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"structureid": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceCounterEntry"
}
},
"formulas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceCounterEntry"
}
}
}
},
"MetricProfileRequest": {
"type": "object",
"properties": {
"metric_profile_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"MetricProfile": {
"type": "object",
"properties": {
"metric_profile_id": {
"type": "integer",
"format": "int32"
},
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricProfileEntry"
}
}
}
},
"MetricProfileEntry": {
"type": "object",
"properties": {
"structureid": {
"type": "string"
},
"entitytypeid": {
"type": "integer",
"format": "int32"
},
"resname": {
"type": "string"
},
"metriclevel": {
"type": "integer",
"format": "int32"
}
}
},
"MetricProfileList": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"metric_profiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetricProfile"
}
}
}
},
"ETLFilters": {
"type": "object",
"properties": {
"taskid_filter": {
"type": "array",
"description": "filter by a list of task identifiers",
"example": [
37,
101
],
"items": {
"type": "integer",
"description": "filter by a list of task identifiers",
"format": "int32"
}
},
"task_type_id_filter": {
"type": "array",
"description": "filter by a list of task type identifiers",
"example": [
300
],
"items": {
"type": "integer",
"description": "filter by a list of task type identifiers",
"format": "int32"
}
},
"srcid_filter": {
"type": "array",
"description": "filter by a list of provider identifiers",
"example": [
99
],
"items": {
"type": "integer",
"description": "filter by a list of provider identifiers",
"format": "int32"
}
},
"etlmodname_filter": {
"type": "array",
"description": "filter by a list of task type name",
"example": [
"VMware - vCenter Extractor Service"
],
"items": {
"type": "string",
"description": "filter by a list of task type name",
"example": "[\"VMware - vCenter Extractor Service\"]"
}
},
"status_filter": {
"type": "array",
"description": "filter by a list of task status (KILLED,RUNNING,WARNING,ENDED,NEW,WAITING)",
"example": [
"KILLED"
],
"items": {
"type": "string",
"description": "filter by a list of task status (KILLED,RUNNING,WARNING,ENDED,NEW,WAITING)",
"example": "[\"KILLED\"]"
}
},
"exit_code_filter": {
"type": "array",
"description": "filter by a list of task status (KILLED,FAILED,WARNING,ERROR,OK)",
"example": [
"KILLED"
],
"items": {
"type": "string",
"description": "filter by a list of task status (KILLED,FAILED,WARNING,ERROR,OK)",
"example": "[\"KILLED\"]"
}
},
"environment_filter": {
"type": "array",
"description": "filter by a list of task environment",
"example": [
"PROD"
],
"items": {
"type": "string",
"description": "filter by a list of task environment",
"example": "[\"PROD\"]"
}
}
}
},
"ETLInfo": {
"type": "object",
"properties": {
"taskid": {
"type": "integer",
"description": "The task identifier",
"format": "int32",
"example": 37
},
"task_name": {
"type": "string",
"description": "The task name",
"example": "VMware - vCenter Extractor Service - vw-pun-bcm-dv37"
},
"description": {
"type": "string",
"description": "The task description",
"example": "VMware - vCenter of Pune"
},
"task_type_id": {
"type": "integer",
"description": "The task type identifier",
"format": "int32",
"example": 300
},
"task_type_name": {
"type": "string",
"description": "The task type label",
"example": "Service ETL"
},
"srcid": {
"type": "integer",
"description": "The provider identifier",
"format": "int32",
"example": 73
},
"etlmod_name": {
"type": "string",
"description": "The ETL type name",
"example": "VMware - vCenter Extractor Service"
},
"entity_catalog": {
"type": "integer",
"description": "The ETL entity catalog, 2 its the Default Entity Catalog",
"format": "int32",
"example": 2
},
"status": {
"type": "string",
"description": "The ETL current status (KILLED,RUNNING,WARNING,ENDED,NEW,WAITING)",
"example": "RUNNING"
},
"exit_code": {
"type": "string",
"description": "The ETL last exit code (KILLED,FAILED,WARNING,ERROR,OK)",
"example": "OK"
},
"environment": {
"type": "string",
"description": "The ETL environment",
"example": "PROD"
},
"last_exec": {
"type": "string",
"description": "The ETL last execution date",
"format": "date-time",
"example": "2023-02-14T17:32:28Z"
},
"next_exec": {
"type": "string",
"description": "The ETL next execution date",
"format": "date-time",
"example": "2023-02-14T17:32:28Z"
},
"scheduler_name": {
"type": "string",
"description": "The Scheduler where this ETL has been scheduled",
"example": "ETL Engine on dev-aus-000888.com"
},
"scheduled": {
"type": "boolean",
"description": "True if the ETL is enabled",
"example": true
},
"scheduling_period_sec": {
"type": "integer",
"description": "The frequency period in seconds the ETL is scheduled",
"format": "int32",
"example": 86400000
}
}
},
"EntityCatalogNavigationRequest": {
"required": [
"pagination"
],
"type": "object",
"properties": {
"provider_id": {
"type": "integer",
"format": "int32"
},
"entity_id_filter": {
"type": "array",
"items": {
"type": "number"
}
},
"entity_name_filter": {
"type": "array",
"items": {
"type": "string"
}
},
"entity_type_filter": {
"type": "array",
"items": {
"type": "string"
}
},
"lookup_sequences_filter": {
"$ref": "#/components/schemas/LookupSequencesFilter"
},
"sorting": {
"$ref": "#/components/schemas/Sorting"
},
"pagination": {
"$ref": "#/components/schemas/PaginationRequest"
}
}
},
"Lookup": {
"required": [
"key",
"value"
],
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"weak": {
"type": "boolean"
}
}
},
"LookupSequencesFilter": {
"required": [
"sequences"
],
"type": "object",
"properties": {
"sequences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Lookup"
}
}
}
},
"PaginationRequest": {
"required": [
"page",
"size"
],
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
}
}
},
"Sorting": {
"type": "object",
"properties": {
"sort": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string"
}
}
},
"EntityCatalogNavigationResponse": {
"required": [
"pagination"
],
"type": "object",
"properties": {
"entity_catalog_id": {
"type": "integer",
"format": "int32"
},
"provider_id": {
"type": "integer",
"format": "int32"
},
"pagination": {
"$ref": "#/components/schemas/PaginationResult"
},
"lookups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityLookup"
}
}
}
},
"EntityLookup": {
"required": [
"entity_id",
"lookup"
],
"type": "object",
"properties": {
"entity_id": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"pattern": "^(sys|app|wkld)(:{1}[a-z]+){1,}$",
"type": "string"
},
"lookup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityLookupByProvider"
}
}
}
},
"EntityLookupByProvider": {
"required": [
"metadata",
"sequence"
],
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"sequence": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Lookup"
}
}
}
},
"PaginationResult": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32"
},
"size": {
"type": "integer",
"format": "int32"
},
"total_record": {
"type": "integer",
"format": "int32"
},
"has_more_data": {
"type": "boolean"
}
}
},
"ETLLastcounters": {
"type": "object",
"properties": {
"srcid": {
"type": "integer",
"description": "The provider identifier",
"format": "int32",
"example": 37
},
"lastcounters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LastcounterContainer"
}
}
}
},
"LastcounterContainer": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of the last counter",
"example": "AWS Configuration Extractor"
},
"lastcounter": {
"type": "string",
"description": "The last counter value",
"example": "2023-02-14 00:00:00 +0000"
},
"type": {
"type": "string",
"description": "The last counter type",
"example": "OK"
},
"status": {
"type": "string",
"description": "The last counter last status",
"example": "There was some error during last extraction\n"
},
"ts": {
"type": "string",
"description": "The last counter update date",
"format": "date-time",
"example": "2023-02-14T17:32:28Z"
}
}
},
"EntityListRequest": {
"type": "object",
"properties": {
"entityid": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"entitytypeid": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"prefixstructureid": {
"type": "boolean"
}
}
},
"EntityTypesResponse": {
"required": [
"entitytypes"
],
"type": "object",
"properties": {
"entitytypes": {
"type": "array",
"description": "List of entity types",
"example": "\"entitytypes\": [\n {\n \"id\": 47,\n \"name\": \"Virtual Application - VMware vApp\",\n \"description\": \"a VMware vApp Guest Application\",\n \"typenm\": \"gapp:vapp\"\n },\n {\n \"id\": 38,\n \"name\": \"Virtual Cluster - VMware\",\n \"description\": \"a VMware virtual cluster\",\n \"typenm\": \"vhc:vmw\"\n }]",
"items": {
"$ref": "#/components/schemas/EntityType"
}
}
},
"description": "Entity type response object"
},
"ConfMetricFilter": {
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"submetricname": {
"type": "string"
},
"locationid": {
"type": "number"
}
}
},
"ConfMetricSection": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
}
},
"extract": {
"type": "boolean"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfMetricFilter"
}
},
"activitydate": {
"type": "string",
"format": "date-time"
}
}
},
"ContainedElementsSection": {
"type": "object",
"properties": {
"extract": {
"type": "boolean"
},
"filters": {
"type": "array",
"items": {
"type": "object"
}
},
"groupid": {
"type": "number"
},
"depth": {
"type": "number"
}
}
},
"EntityRequest": {
"type": "object",
"properties": {
"entityids": {
"type": "array",
"items": {
"type": "number"
}
},
"confmetrics": {
"$ref": "#/components/schemas/ConfMetricSection"
},
"contents": {
"$ref": "#/components/schemas/ContainedElementsSection"
},
"tags": {
"$ref": "#/components/schemas/SectionTagFilter"
},
"recommendations": {
"$ref": "#/components/schemas/RecommendationSection"
},
"monitoringstatus": {
"type": "boolean"
}
}
},
"RecommendationFilter": {
"type": "object",
"properties": {
"alertid": {
"type": "number"
},
"rmalertstatusid": {
"type": "number"
},
"rmalerttypeid": {
"type": "number"
},
"resources": {
"type": "string"
}
}
},
"RecommendationSection": {
"type": "object",
"properties": {
"extract": {
"type": "boolean"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecommendationFilter"
}
},
"sincedate": {
"type": "string",
"format": "date-time"
},
"todate": {
"type": "string",
"format": "date-time"
}
}
},
"SectionTagFilter": {
"type": "object",
"properties": {
"extract": {
"type": "boolean"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagFilter"
}
}
}
},
"TagFilter": {
"type": "object",
"properties": {
"tagid": {
"type": "number"
},
"tagtypeid": {
"type": "number"
}
}
},
"SubresourcesRequest": {
"required": [
"metrics"
],
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"type": "string"
}
},
"search.string": {
"type": "string"
},
"entityids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"SubresourcesResult": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"structureid": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EntityType"
},
"metrics": {
"type": "array",
"items": {
"type": "string"
}
},
"subresources": {
"type": "array",
"items": {
"type": "string"
}
},
"search.string": {
"type": "string"
}
}
},
"ConfHistoryFilters": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfHistoryMetrics"
}
},
"parentmetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConfHistoryMetrics"
}
},
"parenttypeid": {
"type": "integer",
"format": "int64"
},
"parentsid": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"timefilterlastxdays": {
"type": "string"
},
"globalfilter": {
"type": "string"
},
"sincedate": {
"type": "string"
},
"todate": {
"type": "string"
}
}
},
"ConfHistoryMetrics": {
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"submetric": {
"type": "string"
}
}
},
"ConfHistoryRequest": {
"type": "object",
"properties": {
"filters": {
"$ref": "#/components/schemas/ConfHistoryFilters"
}
}
},
"ColumnMetadata": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"metric": {
"type": "string"
},
"description": {
"type": "string"
},
"meaning": {
"type": "string"
},
"unit": {
"type": "string"
},
"datatype": {
"type": "string"
}
}
},
"ConfHistoryResponse": {
"type": "object",
"properties": {
"structureid": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"parenttypeid": {
"type": "integer",
"format": "int64"
},
"datafields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ColumnMetadata"
}
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
},
"ChildrenEntitiesRequest": {
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/NameLikeFilterOnEntities"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"recursive": {
"type": "boolean"
},
"appid.list": {
"type": "array",
"items": {
"type": "number"
}
},
"filterondescendant": {
"$ref": "#/components/schemas/FilterOnDescendant"
},
"filterondescendants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterOnDescendant"
}
},
"entityids": {
"type": "array",
"items": {
"type": "number"
}
},
"hasparent": {
"type": "boolean"
}
}
},
"FilterOnDescendant": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"statuses": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"structureid": {
"type": "string"
},
"relatedto": {
"type": "string"
},
"includetemplates": {
"type": "boolean"
},
"monitor.ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"NameLikeFilterOnEntities": {
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"statuses": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"structureid": {
"type": "string"
},
"relatedto": {
"type": "string"
},
"includetemplates": {
"type": "boolean"
},
"monitor.ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"search.string": {
"type": "string"
}
}
},
"ChildrenEntitiesResponse": {
"type": "object",
"properties": {
"children": {
"$ref": "#/components/schemas/Entities"
},
"filter": {
"$ref": "#/components/schemas/NameLikeFilterOnEntities"
},
"filterondescendant": {
"$ref": "#/components/schemas/FilterOnDescendant"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"count": {
"type": "integer",
"format": "int32"
},
"recursive": {
"type": "boolean"
},
"parent": {
"$ref": "#/components/schemas/EntityResult"
},
"appid.list": {
"type": "array",
"items": {
"type": "number"
}
},
"filterondescendants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterOnDescendant"
}
},
"entityids": {
"type": "array",
"items": {
"type": "number"
}
},
"hasparent": {
"type": "boolean"
}
}
},
"EntitiesByTypeRequest": {
"type": "object",
"properties": {
"entity_type_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
}
},
"TagAssigments": {
"type": "object",
"properties": {
"to_add": {
"type": "array",
"items": {
"type": "string"
}
},
"to_remove": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"TagsAssignmentRequest": {
"type": "object",
"properties": {
"tags": {
"$ref": "#/components/schemas/TagAssigments"
}
}
},
"DashboardFreeSearchRequest": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"by_query_string": {
"type": "string"
},
"by_sys_types": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"DashboardFreeSearchResponse": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"warning": {
"type": "string"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FreeSearchResult"
}
}
}
},
"FreeSearchResult": {
"type": "object",
"properties": {
"entity_id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"type_id": {
"type": "integer",
"format": "int64"
},
"type_name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchEntTag"
}
}
}
},
"SearchEntTag": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"tag": {
"type": "string"
}
}
},
"EntitiesByFilterRequest": {
"type": "object",
"properties": {
"filter": {
"$ref": "#/components/schemas/EntityByFilter"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
},
"EntityByFilter": {
"type": "object",
"properties": {
"structureid": {
"type": "string"
},
"entityfilter": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"search.string": {
"type": "string"
}
}
},
"SearchDomainsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"children": {
"$ref": "#/components/schemas/Entities"
},
"filterondescendant": {
"$ref": "#/components/schemas/FilterOnDescendant"
},
"filter": {
"$ref": "#/components/schemas/NameLikeFilterOnEntities"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"recursive": {
"type": "boolean"
},
"appid.list": {
"type": "array",
"items": {
"type": "number"
}
},
"filterondescendants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterOnDescendant"
}
},
"entityids": {
"type": "array",
"items": {
"type": "number"
}
},
"hasparent": {
"type": "boolean"
}
}
},
"ConfPropsRequest": {
"required": [
"properties"
],
"type": "object",
"properties": {
"properties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ConfPropsDto": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"AuditInfo": {
"type": "object",
"properties": {
"auditactionid": {
"type": "integer",
"format": "int32"
},
"accountid": {
"type": "integer",
"format": "int32"
},
"ims_user_id": {
"type": "string"
},
"idstring": {
"type": "string"
},
"message": {
"type": "string"
},
"elapsed": {
"type": "integer",
"format": "int32"
},
"componentid": {
"type": "integer",
"format": "int32"
},
"subcomponent": {
"type": "string"
}
}
},
"Valtype": {
"type": "object",
"properties": {
"valtypeid": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"defaulstat": {
"type": "string"
}
}
},
"ValtypeList": {
"type": "object",
"properties": {
"href": {
"type": "string"
},
"valtypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Valtype"
}
}
}
},
"TimeFilter": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"appid": {
"type": "number"
},
"isglobal": {
"type": "boolean"
}
}
},
"MetricValTypeDto": {
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"val_type_id": {
"type": "number"
}
}
},
"MaterializerTask": {
"required": [
"name",
"taskid"
],
"type": "object",
"properties": {
"taskid": {
"type": "integer",
"description": "Numeric id of the materializer task",
"format": "int64",
"example": 1
},
"name": {
"type": "string",
"description": "Name of the materializer task",
"example": "AIX Virtual Farm view - Data Mart Materializer"
}
},
"description": "Contains the materializer task object with id and name of the task"
},
"ETLModuleInfo": {
"type": "object",
"properties": {
"etlmodid": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"statusid": {
"type": "integer",
"format": "int32"
},
"language": {
"type": "string"
},
"filename": {
"type": "string"
},
"etlmodtype": {
"type": "string"
},
"etlmodsubtype": {
"type": "string"
},
"etlmodgroupid": {
"type": "integer",
"format": "int32"
}
}
},
"CountByType": {
"type": "object",
"properties": {
"systype": {
"type": "string",
"description": "The system type identifier",
"example": "sys:gm:azu"
},
"systype_label": {
"type": "string",
"description": "The system type label",
"example": "Virtual Machine - Azure"
},
"count": {
"type": "integer",
"description": "The count if imported entities",
"format": "int64",
"example": 17
}
}
},
"ETLCountByType": {
"type": "object",
"properties": {
"taskid": {
"type": "integer",
"description": "The task identifier",
"format": "int32",
"example": 37
},
"task_name": {
"type": "string",
"description": "The task name",
"example": "VMware - vCenter Extractor Service - vw-pun-bcm-dv37"
},
"description": {
"type": "string",
"description": "The task description",
"example": "VMware - vCenter of Pune"
},
"task_type_id": {
"type": "integer",
"description": "The task type identifier",
"format": "int32",
"example": 300
},
"task_type_name": {
"type": "string",
"description": "The task type label",
"example": "Service ETL"
},
"srcid": {
"type": "integer",
"description": "The provider identifier",
"format": "int32",
"example": 73
},
"etlmod_name": {
"type": "string",
"description": "The ETL type name",
"example": "VMware - vCenter Extractor Service"
},
"entity_catalog": {
"type": "integer",
"description": "The ETL entity catalog, 2 its the Default Entity Catalog",
"format": "int32",
"example": 2
},
"status": {
"type": "string",
"description": "The ETL current status (KILLED,RUNNING,WARNING,ENDED,NEW,WAITING)",
"example": "RUNNING"
},
"exit_code": {
"type": "string",
"description": "The ETL last exit code (KILLED,FAILED,WARNING,ERROR,OK)",
"example": "OK"
},
"environment": {
"type": "string",
"description": "The ETL environment",
"example": "PROD"
},
"last_exec": {
"type": "string",
"description": "The ETL last execution date",
"format": "date-time",
"example": "2023-02-14T17:32:28Z"
},
"next_exec": {
"type": "string",
"description": "The ETL next execution date",
"format": "date-time",
"example": "2023-02-14T17:32:28Z"
},
"scheduler_name": {
"type": "string",
"description": "The Scheduler where this ETL has been scheduled",
"example": "ETL Engine on dev-aus-000888.com"
},
"scheduled": {
"type": "boolean",
"description": "True if the ETL is enabled",
"example": true
},
"scheduling_period_sec": {
"type": "integer",
"description": "The frequency period in seconds the ETL is scheduled",
"format": "int32",
"example": 86400000
},
"imported_entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountByType"
}
}
}
},
"EntityFilter": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Numeric id of the entity filter",
"format": "int64",
"example": 1
},
"name": {
"type": "string",
"description": "Name of the entity filter",
"example": "All entities in container domain"
},
"description": {
"type": "string",
"description": "Description of the entity filter",
"example": "All entities in container domain"
}
},
"description": "Contains the entity filter object with id,name and descritpion"
},
"EntitiesByFilterResponse": {
"type": "object",
"properties": {
"id_by_type": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"Dataset": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"datasetid": {
"type": "integer",
"format": "int32"
},
"structureid": {
"type": "string"
},
"code": {
"type": "string"
},
"description": {
"type": "string"
},
"metadatacolumns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatasetAddCol"
}
}
}
},
"DatasetAddCol": {
"type": "object",
"properties": {
"datasetid": {
"type": "integer",
"format": "int32"
},
"colname": {
"type": "string"
},
"description": {
"type": "string"
},
"meaning": {
"type": "integer",
"format": "int32"
},
"unit": {
"type": "string"
},
"relevance": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string"
}
}
},
"DatasetList": {
"type": "object",
"properties": {
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dataset"
}
}
}
},
"PlotTemplateInformation": {
"required": [
"aggrtemplid",
"plottemplid",
"properties"
],
"type": "object",
"properties": {
"plottemplid": {
"type": "integer",
"description": "Numeric identifier for plot template",
"format": "int64",
"example": 1554
},
"aggrtemplid": {
"type": "integer",
"description": "Numeric identifier for aggregation template",
"format": "int64",
"example": 1554
},
"properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "Template properties",
"example": "\"properties\": {\n \"plot.title\": \"Category - Horizontal Bar Chart\",\n \"plot.tsps.selectable\": \"true\",\n \"aggregation.er.usecategory\": \"true\",\n \"plot.interaction.hiderowscols\": \"true\",\n \"plot.chart.by\": \"SERIES\",\n \"aggregation.idstring\": \"ERTA\",\n \"plot.interaction.chartedit\": \"true\",\n \"plot.interaction.zoom\": \"true\",\n \"plot.rightaxis.mode\": \"K_INL_NONE\",\n \"plot.interaction.table\": \"true\",\n \"plot.interaction.tooltip\": \"true\",\n \"plot.type\": \"CHART:CATEGORY:HORIZONTALBAR\",\n \"plot.subtitle\": \" \",\n \"plot.interaction.csv\": \"true\",\n \"plot.series.label\": \"%NAME%\"\n }"
},
"description": "Template properties",
"example": "\"properties\": {\n \"plot.title\": \"Category - Horizontal Bar Chart\",\n \"plot.tsps.selectable\": \"true\",\n \"aggregation.er.usecategory\": \"true\",\n \"plot.interaction.hiderowscols\": \"true\",\n \"plot.chart.by\": \"SERIES\",\n \"aggregation.idstring\": \"ERTA\",\n \"plot.interaction.chartedit\": \"true\",\n \"plot.interaction.zoom\": \"true\",\n \"plot.rightaxis.mode\": \"K_INL_NONE\",\n \"plot.interaction.table\": \"true\",\n \"plot.interaction.tooltip\": \"true\",\n \"plot.type\": \"CHART:CATEGORY:HORIZONTALBAR\",\n \"plot.subtitle\": \" \",\n \"plot.interaction.csv\": \"true\",\n \"plot.series.label\": \"%NAME%\"\n }"
}
},
"description": "Plot template properties"
},
"PlotTemplate": {
"required": [
"aggrtemplid",
"description",
"group",
"name",
"ownership",
"plottemplateid"
],
"type": "object",
"properties": {
"plottemplateid": {
"type": "integer",
"description": "Numeric identifier for plot template",
"format": "int64",
"example": 1554
},
"aggrtemplid": {
"type": "integer",
"description": "Numeric identifier for aggregation template",
"format": "int64",
"example": 1554
},
"name": {
"type": "string",
"description": "Name of the analysis template",
"example": "Category - Bar Chart"
},
"group": {
"type": "string",
"description": "Group of the analysis template",
"example": "Enterprise Reporting"
},
"description": {
"type": "string",
"description": "Description of the analysis template",
"example": "Enterprise Reporting Category Chart with vertical bars"
},
"ownership": {
"type": "integer",
"description": "Numeric identifier for the ownership of the template",
"format": "int32",
"example": 10
}
},
"description": "Analysis template with template id, aggregation template id, name, group, description and ownership",
"example": "\"templates\": [\n {\n \"plottemplateid\": 1554,\n \"aggrtemplid\": 1554,\n \"name\": \"Category - Bar Chart\",\n \"group\": \"Enterprise Reporting\",\n \"description\": \"Enterprise Reporting Category Chart with vertical bars\",\n \"ownership\": 10\n },\n {\n \"plottemplateid\": 1555,\n \"aggrtemplid\": 1555,\n \"name\": \"Category - Horizontal Bar Chart\",\n \"group\": \"Enterprise Reporting\",\n \"description\": \"Enterprise Reporting Category Chart with horizontal bars\",\n \"ownership\": 10\n }]"
},
"PlotTemplateList": {
"required": [
"templates"
],
"type": "object",
"properties": {
"templates": {
"type": "array",
"description": "List of analysis template",
"example": "\"templates\": [\n {\n \"plottemplateid\": 1554,\n \"aggrtemplid\": 1554,\n \"name\": \"Category - Bar Chart\",\n \"group\": \"Enterprise Reporting\",\n \"description\": \"Enterprise Reporting Category Chart with vertical bars\",\n \"ownership\": 10\n },\n {\n \"plottemplateid\": 1555,\n \"aggrtemplid\": 1555,\n \"name\": \"Category - Horizontal Bar Chart\",\n \"group\": \"Enterprise Reporting\",\n \"description\": \"Enterprise Reporting Category Chart with horizontal bars\",\n \"ownership\": 10\n }]",
"items": {
"$ref": "#/components/schemas/PlotTemplate"
}
}
},
"description": "Contains the analysis template list"
},
"About": {
"type": "object",
"properties": {
"product": {
"type": "string"
},
"component": {
"type": "string"
},
"api_versions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}