Loading

DFS MIS API (latest)

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.

AgGrid

<no summary>

Authorizations:
header Parameters
Accept-Language
string

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

Request Body schema:
fieldKey
string Nullable
dataSourceName
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/ag-grid/filter
https://example-host/v1.0/ag-grid/filter

Request samples

Content type
Copy
Expand all Collapse all
{
  • "fieldKey": "string",
  • "dataSourceName": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ]
}

<no summary>

Authorizations:
header Parameters
Accept-Language
string

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

Request Body schema:
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
allRows
boolean

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/ag-grid/rows
https://example-host/v1.0/ag-grid/rows

Request samples

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

Response samples

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

DataSource

<no summary>

Authorizations:
path Parameters
dataSourceId
required
integer <int32>
scenarioId
required
integer <int32>
header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/data-sources/{dataSourceId}/scenarios/{scenarioId}
https://example-host/v1.0/data-sources/{dataSourceId}/scenarios/{scenarioId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "success": true
}

GetScenario

Authorizations:
path Parameters
dataSourceId
required
integer <int32>
scenarioId
required
integer <int32>
header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/data-sources/{dataSourceId}/scenarios/{scenarioId}
https://example-host/v1.0/data-sources/{dataSourceId}/scenarios/{scenarioId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "columnState": "string",
  • "groupState": "string",
  • "filterModel": "string",
  • "pivotMode": true,
  • "createDate": "2024-09-25T13:31:17Z"
}

<no summary>

Authorizations:
header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/data-sources
https://example-host/v1.0/data-sources

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ]
}

<no summary>

Authorizations:
path Parameters
dataSourceId
required
integer <int32>
header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/data-sources/{dataSourceId}
https://example-host/v1.0/data-sources/{dataSourceId}

Response samples

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

<no summary>

Authorizations:
path Parameters
dataSourceId
required
integer <int32>
header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/data-sources/{dataSourceId}/settings
https://example-host/v1.0/data-sources/{dataSourceId}/settings

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "data": "string"
}

<no summary>

Authorizations:
path Parameters
dataSourceId
required
integer <int32>
header Parameters
Accept-Language
string

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/data-sources/{dataSourceId}/scenarios
https://example-host/v1.0/data-sources/{dataSourceId}/scenarios

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ]
}

<no summary>

Authorizations:
path Parameters
dataSourceId
required
integer <int32>
header Parameters
Accept-Language
string

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

Request Body schema:
name
string Nullable
columnState
string Nullable
groupState
string Nullable
filterModel
string Nullable
pivotMode
boolean Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/data-sources/{dataSourceId}/scenarios
https://example-host/v1.0/data-sources/{dataSourceId}/scenarios

Request samples

Content type
Copy
Expand all Collapse all
{
  • "name": "string",
  • "columnState": "string",
  • "groupState": "string",
  • "filterModel": "string",
  • "pivotMode": true
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0
}