Download OpenAPI specification:Download
REST Services for managing MIS data.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Retrieve filter information available for the passed data source.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
| fieldKey | string Nullable |
| dataSourceName | string Nullable |
| dataSourceId | integer <int32> Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "fieldKey": "string",
- "dataSourceName": "string",
- "dataSourceId": 0
}{- "results": [
- "string"
]
}Retrieve data for the passed data source.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The request DTO
| startRow | integer <int32> |
| endRow | integer <int32> |
| rowGroupCols | Array of objects (ColumnVO) Nullable |
| valueCols | Array of objects (ColumnVO) Nullable |
| pivotCols | Array of objects (ColumnVO) Nullable |
| pivotMode | boolean |
| groupKeys | Array of strings Nullable |
| filterModel | object Nullable |
| sortModel | Array of objects (SortModel) Nullable |
| dataSourceName | string Nullable |
| dataSourceId | integer <int32> Nullable |
| allRows | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "startRow": 0,
- "endRow": 0,
- "rowGroupCols": [
- {
- "id": "string",
- "displayName": "string",
- "field": "string",
- "aggFunc": "string"
}
], - "valueCols": [
- {
- "id": "string",
- "displayName": "string",
- "field": "string",
- "aggFunc": "string"
}
], - "pivotCols": [
- {
- "id": "string",
- "displayName": "string",
- "field": "string",
- "aggFunc": "string"
}
], - "pivotMode": true,
- "groupKeys": [
- "string"
], - "filterModel": {
- "property1": {
- "filterType": "string",
- "type": "string",
- "values": [
- "string"
], - "dateFrom": "2025-05-09T12:06:29Z",
- "dateTo": "2025-05-09T12:06:29Z",
- "filter": 0,
- "filterTo": 0,
- "operator": "string",
- "condition1": { },
- "condition2": { }
}, - "property2": {
- "filterType": "string",
- "type": "string",
- "values": [
- "string"
], - "dateFrom": "2025-05-09T12:06:29Z",
- "dateTo": "2025-05-09T12:06:29Z",
- "filter": 0,
- "filterTo": 0,
- "operator": "string",
- "condition1": { },
- "condition2": { }
}
}, - "sortModel": [
- {
- "colId": "string",
- "sort": "string"
}
], - "dataSourceName": "string",
- "dataSourceId": 0,
- "allRows": true
}{- "data": [
- {
- "property1": null,
- "property2": null
}
], - "lastRow": 0,
- "secondaryColumnFields": [
- "string"
]
}Delete, for the passed data source, a specific scenario.
| dataSourceId required | integer <int32> The data source Id |
| scenarioId required | integer <int32> The scenario Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "success": true
}Retrieve information for the passed scenario and data source combination.
| dataSourceId required | integer <int32> The data source Id |
| scenarioId required | integer <int32> The scenario Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "id": 0,
- "name": "string",
- "columnState": "string",
- "groupState": "string",
- "filterModel": "string",
- "pivotMode": true,
- "createDate": "2025-05-09T12:06:29Z"
}Retrieve the available data sources.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "results": [
- {
- "id": 0,
- "name": "string",
- "tableName": "string"
}
]
}Retrieve information about the data source passed.
| dataSourceId required | integer <int32> The data source Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "id": 0,
- "name": "string",
- "tableName": "string"
}Retrieve the settings of the data source passed.
| dataSourceId required | integer <int32> The data source Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "data": "string"
}Retrieve the scenarios present for the data source passed.
| dataSourceId required | integer <int32> The data source Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "results": [
- {
- "id": 0,
- "name": "string",
- "columnState": "string",
- "groupState": "string",
- "filterModel": "string",
- "pivotMode": true,
- "createDate": "2025-05-09T12:06:29Z"
}
]
}Create, for the data source passed, a new scenario (based on the conditions passed).
| dataSourceId required | integer <int32> The data source Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The scenario DTO
| name | string Nullable |
| columnState | string Nullable |
| groupState | string Nullable |
| filterModel | string Nullable |
| pivotMode | boolean Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "columnState": "string",
- "groupState": "string",
- "filterModel": "string",
- "pivotMode": true
}{- "id": 0
}