Use this API to update multiple line entries for multiple data elements of a specific key term having a single identifier in the line entry for all respective contracts.
Prerequisites
To use this API, ensure you have the following
- Access to a Pramata instance (UAT or Production)
- API is enabled for the instance
- 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.
- Access to the required Key Term to perform an Insert/Update operation. To get access, reach out to your Customer Success Manager.
API
Method: POST
API Endpoint: https://[tenantname]-api-[env].pramata.com/services/data/v1/keyterms/[keyterm_api_name]/data_element/[data_element_api_name]/[identifier_value]/update
Production Example: https://demos-api.pramata.com/services/data/v1/keyterms/sk___Signature/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update
UAT Example: https://demos-api-uat.pramata.com/services/data/v1/keyterms/sk___Signature/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update
Input Parameters
- keyterm_api_name (required)
- To get the Key Term API name, refer to Key Term Schema API
- data_element_api_name
- To get the Data Element API name, refer to Key Term Schema API
- Identifier_value
- Use Voyager’s key term details page to get the value.
Example Request
curl --location 'https://demo-api-uat.pramata.com/services/data/v1/keyterms/Insurance_Coverage/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
"data": [
{
"updated_info": {
"Insurance_Coverage__Type": "Anuual",
"Insurance_Coverage__Coverage_Amount": "7500",
"Insurance_Coverage__Currency": "Dollar",
"Insurance_Coverage__Start_Date": "06/14/2023",
"Insurance_Coverage__End_Date": "06/11/2024",
"Insurance_Coverage__Carrier": "JCB"
},
"pramata_numbers": [
"10001"
]
}
]
}'
Limitations:
The pramata_number key input should not be more than 500 pramata numbers.
API Response
Success:
HTTP 204 (No content)
Error:
HTTP 404:
{
"errors": [
{
"status": "404",
"source": {
"pointer": "http://demo-uat.pramata.com/api/v1/keyterms/Insurance_Coverage1/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update"
},
"title": "Invalid Keyterm",
"detail": "No matching Keyterm found in the repository. Please provide the a valid Keyterm"
}
]
}
{
"errors": [
{
"status": "404",
"source": {
"pointer": "http://demo-api-uat/api/v1/keyterms/Insurance_Coverage/data_element/Broker_Name/01t5w00000FV24vAAD/update"
},
"title": "Invalid Data Element",
"detail": "No matching Data Element found in the repository. Please provide the a valid Data Element"
}
]
}
{
"errors": [
{
"status": "404",
"source": {
"pointer": "http://demo-api-uat/api/v1/keyterms/Insurance_Coverage/data_element/Insurance_Coverage__Broker_Name/123/update"
},
"title": "Record Not Found",
"detail": "Term Entry not present for the given External_ID"
}
]
}
{
"errors": [
{
"status": "404",
"source": {
"pointer": "http://demo-api-uat/api/v1/keyterms/Insurance_Coverage/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update"
},
"title": "Record Not Found",
"detail": "Invalid Pramata Numbers [\"100011\"] found in the request"
}
]
}
{
"errors": [
{
"status": "404",
"source": {
"pointer": "http://demo-api-uat/api/v1/keyterms/Insurance_Coverage/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update"
},
"title": "Record Not Found",
"detail": "Invalid Data elements api_name [\"_Coverage__Type\"] found in the request"
}
]
}
HTTP 400:
{
"errors": [
{
"status": "400",
"source": {
"pointer": "http://demo-api-uat/api/v1/keyterms/Insurance_Coverage/data_element/Insurance_Coverage__Broker_Name/01t5w00000FV24vAAD/update"
},
"title": "Bad Request Error",
"detail": "Invalid date value 99/14/2023 for Insurance_Coverage__Start_Date found in the request. Date value should be in mm/dd/yyyy format only"
}
]
}