Overview
This API allows you to retrieve a list of Pramata Numbers by specifying the api_name and a corresponding search value. It enables users to efficiently search and obtain relevant Pramata Numbers based on specific criteria.
Prerequisites
To use this API , ensure you have the following:
- Access to a Pramata instance (UAT or Production)
- Access to Pramata API Developer Portal (API client credentials are shared in the API portal). To get access, reach out to your Customer Success Manager.
Use the GET method to retrieve all Pramata numbers related to data element value by using api_name and search value.
API
https://[tenantname]-api-[env].pramata.com/services/data/v1/documents/keyterm/data_elements/[api_name]/[identifier_value]/search
Example: https://demos-api-uat.pramata.com/services/data/v1/documents/keyterm/data_elements/sk___Doc_Source__Doc_Reference_Id/0015g00000xhDzuAAE/search
In the above API endpoint, the following must be modified:
- [tenantname]----> Name of the tenant
- [env] ----> uat or leave it blank for production environment
-
[api_name] ----> The API name of the Search field used within Pramata, refer the Keyterm Schema API.
Example:demo-api-uat.pramata.com/demo-api.pramata.com - [identifier_value] ----> The value of the search field
Example Request
curl --location 'https://demos-api-uat.pramata.com/services/data/v1/documents/keyterm/data_elements/sk___External_Account_Mapping__Account_ID/0015g00000xhDzuAAE/search' \
--header 'Authorization: Bearer DJZv8zGIkAQ8G97M95C1lTatASEOvf3a'
API Response
{
"data": {
"sk___External_Account_Mapping__Account_ID": "0015g00000xhDzuAAE",
"pramata_numbers": [
"10000"
]
}
}