Reference Data APIs

This section lists and explains the Reference Data APIs. This feature is included in all three stacks namely K8, Azure and AWS. Reference data API is supported for the databases namely MONGO, POSTGRESQL, DYNAMO, MYSQL and MSSQL.

CREATE REFERENCE DATA RECORD

This API is used to create reference data record based on type and code.

POST/reference/{type}/{refcode}

Sample URL

http://<<host>>:<<port>>/<<MS war Name>>/api/v1.0.0/reference/Country/IN

Request

{
    "value": "IN",
    "description": "India"
}

Sample Response

{
    "value": "IN",
    "description": "India"
}

UPDATE REFERENCE DATA RECORD API

This API is used to update reference data record based on type and code.

PUT/reference/{type}/{refcode}

Sample URL

http://<<host>>:<<port>>/<<MS war Name>>/api/v1.0.0/reference/Country/IN

Request

{
    "value": "IN",
    "description": "NewIndia"
}

Sample Response

{
    "value": "IN",
    "description": "NewIndia"
}

GET REFERENCE DATA RECORD BY TYPE AND CODE API

This API is used to retrieve reference data record based on type and code.

GET/reference/{type}/{refcode}

Sample URL

http://<<host>>:<<port>>/<<MS war Name>>/api/v1.0.0/reference/Country/IN

Response

{
    "value": "IN",
    "description": "NewIndia"
}

GET REFERENCE DATA BY TYPE API

This API is used to retrieve reference data record based on type.

GET/reference/{type}

Sample URL

http://<<host>>:<<port>>/<<MS war Name>>/api/v1.0.0/reference/Country

Response

{
“Items”: [
{
    "value": "IN",
    "description": "NewIndia"
},
{
    "value": "UAE",
    "description": "Unite Arab Emirates"
}
]
}

DELETE REFERENCE DATA RECORD API

This API is used to delete reference data record based on type and code.

DELETE/reference/{type}/{refcode}

Sample URL

http://<<host>>:<<port>>/<<MS war Name>>/api/v1.0.0/reference/Country/IN

Response

{
    "value": "IN",
    "description": "Delete Successful"
}

Dark Mode

Expand/Collapse

In this topic