Reference Data API

« Back to REST APIs

The Reference Data API allows to Access Data of Reference Data Solutions. Limited OData Filter is also supported by this API. The API uses GET Method to access data.

Request and Response

For Accessing the Reference Data Solutions, structure of Request and Response will be as follows:

Date format : YYYY-MM-DD

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

Request Data Contract:

Reference Data API does not need a request body.

For Execution Reference Data API requires three parameters mentioned below:

  1. AppName: Name of the app where the Reference Data Solution is created.

  2. LibraryName: Name of the library where the Reference Data Solution is created.

  3. RefSolutionName: Name of the Reference Data Solution to be Accessed.

Following sample illustrates the use of API:

Request Data:

Sample 1

{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=refsolution

Sample 2

{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068

Sample 3

{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true

Sample 4

{{Route Prefix}}/api/v1/ReferenceData?AppName=Reference Data&LibraryName=Reference Data Lists&SolutionName=ReferenceiList11Items100&$filter=empid eq 1068 and Bitfield eq true

Response Data Contract:

Response body will depend on the Solution Accessed.

Response Data

"@odata.context": "https://cha-en-vst679.wsdt.local:443/svr/api/v1/ReferenceData?AppName=Reference%20Data&LibraryName=Reference%20Data%20Lists&SolutionName=ReferenceiList11Items100",
    "value": [
        {
            "username": "wsdt\\devuser5",
            "CreatedOn": "2020-01-21",
            "empid": 1059,
            "decimalfield": 666.77,
            "Bitfield": true
        },
        {
            "username": "wsdt\\devuser6",
            "CreatedOn": "2020-01-22",
            "empid": 1060,
            "decimalfield": 667.77,
            "Bitfield": true
        },
        {
            "username": "wsdt\\devuser7",
            "CreatedOn": "2020-01-23",
            "empid": 1061,
            "decimalfield": 668.77,
            "Bitfield": true
        },
        {
            "username": "wsdt\\devuser10",
            "CreatedOn": "2020-01-26",
            "empid": 1064,
            "decimalfield": 671.77,
            "Bitfield": true
        },
        {
            "username": "wsdt\\devuser11",
            "CreatedOn": "2020-01-27",
            "empid": 1065,
            "decimalfield": 672.77,
            "Bitfield": true
        }....

Invalid parameters Response:

Invalid Parameters

[
    {
        "ErrorCode": "Invalid_data",
        "Message": "LibraryName, SolutionName or AppName does not exists.",
        "errorPrameters": null
    }
]