DFS v26.1
Loading
API docs by Redocly

DFS MIS API (latest)

Download OpenAPI specification:

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.

AgGrid

Retrieve filters

Retrieve filter information available for the passed data source.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request DTO

fieldKey
string or null
dataSourceName
string or null
dataSourceId
integer or null <int32>

Responses

Request samples

Content type
{
  • "fieldKey": "string",
  • "dataSourceName": "string",
  • "dataSourceId": 0
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Retrieve data

Retrieve data for the passed data source.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The request DTO

startRow
integer <int32>
endRow
integer <int32>
Array of objects or null (ColumnVO)
Array of objects or null (ColumnVO)
Array of objects or null (ColumnVO)
pivotMode
boolean
groupKeys
Array of strings or null
object or null
Array of objects or null (SortModel)
dataSourceName
string or null
dataSourceId
integer or null <int32>
allRows
boolean

Responses

Request samples

Content type
{
  • "startRow": 0,
  • "endRow": 0,
  • "rowGroupCols": [
    ],
  • "valueCols": [
    ],
  • "pivotCols": [
    ],
  • "pivotMode": true,
  • "groupKeys": [
    ],
  • "filterModel": {
    },
  • "sortModel": [
    ],
  • "dataSourceName": "string",
  • "dataSourceId": 0,
  • "allRows": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "lastRow": 0,
  • "secondaryColumnFields": [
    ]
}

DataSource

Delete data source scenario

Delete, for the passed data source, a specific scenario.

Authorizations:
Bearer
path Parameters
dataSourceId
required
integer <int32>

The data source Id

scenarioId
required
integer <int32>

The scenario Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Retrieve data source scenario

Retrieve information for the passed scenario and data source combination.

Authorizations:
Bearer
path Parameters
dataSourceId
required
integer <int32>

The data source Id

scenarioId
required
integer <int32>

The scenario Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "columnState": "string",
  • "groupState": "string",
  • "filterModel": "string",
  • "pivotMode": true,
  • "createDate": "2019-08-24T14:15:22Z"
}

Retrieve data sources

Retrieve the available data sources.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Retrieve data source

Retrieve information about the data source passed.

Authorizations:
Bearer
path Parameters
dataSourceId
required
integer <int32>

The data source Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "tableName": "string"
}

Retrieve data source settings

Retrieve the settings of the data source passed.

Authorizations:
Bearer
path Parameters
dataSourceId
required
integer <int32>

The data source Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

Retrieve data source scenarios

Retrieve the scenarios present for the data source passed.

Authorizations:
Bearer
path Parameters
dataSourceId
required
integer <int32>

The data source Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create data source scenario

Create, for the data source passed, a new scenario (based on the conditions passed).

Authorizations:
Bearer
path Parameters
dataSourceId
required
integer <int32>

The data source Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The scenario DTO

name
string or null
columnState
string or null
groupState
string or null
filterModel
string or null
pivotMode
boolean or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "columnState": "string",
  • "groupState": "string",
  • "filterModel": "string",
  • "pivotMode": true
}

Response samples

Content type
application/json
{
  • "id": 0
}