Solution Data API

« Back to REST APIs

The Solution Data API allows to access Solution data. Limited OData Filter is also supported by this API. The API uses GET method to access Solution data.

Request and Response

For Accessing the Solution Data, structure of Request and response will be like:

Date format : YYYY-MM-DDTHH:mm:ss.fff

Decimal : No thousand separator and dot would be decimal separator, like 23232.56

Request Data Contract

Sample Data API does not need a request body. This API requires two parameters for Execution as mentioned below:

  1. AppName: Name of the app where the Solution Data exists. For Global scope this parameter should not be provided.

  2. SolutionDataName: Name of the Solution Data to be accessed.

Sample 1

<Route Prefix>/api/v1/SolutionDataSet?SolutionDataName=SDS&AppName=AbhiApp

Sample 2

<Route Prefix>/api/v1/SolutionDataSet?SolutionDataName=from

Sample 3

<Route Prefix>/api/v1/SolutionDataSet?$filter=MsgFromSAP eq 'aanew'&SolutionDataName=from

Response Data Contract

Solution data will be returned in JSON format.

Response

{
    "@odata.context": "https://cha-en-vst679.wsdt.local:443/svr/api/v1/SolutionDataSet?SolutionDataName=from",
    "value": [
        {
            "SDL_Id": "3caa8405-f46d-4d48-b9d6-2277fd500e6a",
            "SDL_Name": "from",
            "R_H_CreatedDate": "2021-07-07T11:12:36.723",
            "R_H_ModifiedDate": "2021-07-07T11:12:36.723",
            "MsgFromSAP": "aa",
            "R_H_ID": 0,
            "MsgFromSAP1": "aaa"
        },
        {
            "SDL_Id": "3caa8405-f46d-4d48-b9d6-2277fd500e6a",
            "SDL_Name": "from",
            "R_H_CreatedDate": "2021-07-07T11:13:08.84",
            "R_H_ModifiedDate": "2021-07-07T11:13:08.84",
            "MsgFromSAP": "aanew",
            "R_H_ID": 1,
            "MsgFromSAP1": "aaanewww"
        }
    ]
}

For an error, for example if Solution data details are not correct error data is returned to the user:

Error

[
    {
        "ErrorCode": "ReferenceData_Details_Mismatch",
        "Message": "SolutionDataName does not exists.",
        "errorPrameters": null
    }
]