Update analytic attribute values for an entity
Learn more about updating an analytic attribute.
This API operation enables you to update an existing analytic attribute. If the attribute has existing values, this operation appends the attribute with new values, otherwise it inserts the new values.
Request
PUT {{tenantURL}}/entities/0RDZ28R/_analyticsAttributes
Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization
| Yes | Information about authentication access token in the format "Bearer <accessToken> ". For more information, see Authentication API. |
Query | returnObjects | No | Denotes if the response must contain created entities. This field defaults to true . |
Body | Yes | JSON object specifying the different analytic attributes. |
Response
An array with results for each element of a request, which will contain the following properties:
-
index - An index of the entity object in JSON array of entities to be created. This is mandatory.
-
uri - The URI of the entity object that is created. This is returned only if the object is successfully created.
-
object - The entity object that is updated. This parameter is returned only if the
returnObjects
query parameter in the request istrue
and the object was successfully created.Note: By default, hidden attributes are not included in the response. To include hidden attributes, add the options=sendHidden parameter in the request. -
error - The details of the error when the object is not created, which can be one of the following:
warning
- if the object is created but with some problems.status
- result of the operation, which can be OK or failed.
Example - Request
PUT {{tenantURL}}/entities/0RDZ28R/_analyticsAttributes
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512, Content-Type: application/json
Body:
{
"Riskfactor":{
"value":"43"
},
"Damageprediction":{
"value":"78"
}
}
Response
{
"index": 0,
"object": {
"uri": "entities/0RDZ28R",
"type": "configuration/entityTypes/Ingredient",
"createdBy": "abhradeep.sengupta@reltio.com",
"createdTime": 1717765506087,
"updatedBy": "abhradeep.sengupta@reltio.com",
"updatedTime": 1717765506087,
"attributes": {
"IngredientID": [
{
"type": "configuration/entityTypes/Ingredient/attributes/IngredientID",
"ov": true,
"value": "234",
"uri": "entities/0RDZ28R/attributes/IngredientID/2FdXSJKt"
}
],
"LSID": [
{
"type": "configuration/entityTypes/Ingredient/attributes/LSID",
"ov": true,
"value": "NMK",
"uri": "entities/0RDZ28R/attributes/LSID/2FdXSNb9"
}
],
"IngredientRole": [
{
"type": "configuration/entityTypes/Ingredient/attributes/IngredientRole",
"ov": true,
"value": "P1",
"uri": "entities/0RDZ28R/attributes/IngredientRole/2FdXS6Y7"
}
],
"IngredientRoleCode": [
{
"type": "configuration/entityTypes/Ingredient/attributes/IngredientRoleCode",
"ov": true,
"value": "C3",
"uri": "entities/0RDZ28R/attributes/IngredientRoleCode/2FdXSAoN"
}
],
"RecordStatus": [
{
"type": "configuration/entityTypes/Ingredient/attributes/RecordStatus",
"ov": true,
"value": "Unknown",
"uri": "entities/0RDZ28R/attributes/RecordStatus/2FdXSF4d"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/0RDZ28R/crosswalks/2FdXSRrP",
"type": "configuration/sources/Reltio",
"value": "0RDZ28R",
"reltioLoadDate": "2024-06-07T13:05:06.087Z",
"createDate": "2024-06-07T13:05:06.087Z",
"updateDate": "2024-06-07T13:05:06.087Z",
"attributes": [
"entities/0RDZ28R/attributes/IngredientRoleCode/2FdXSAoN",
"entities/0RDZ28R/attributes/LSID/2FdXSNb9",
"entities/0RDZ28R/attributes/RecordStatus/2FdXSF4d",
"entities/0RDZ28R/attributes/IngredientID/2FdXSJKt",
"entities/0RDZ28R/attributes/IngredientRole/2FdXS6Y7"
],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {
"Damageprediction": [
{
"type": "configuration/entityTypes/Ingredient/analyticsAttributes/Damageprediction",
"value": "78",
"uri": "entities/0RDZ28R/analyticsAttributes/Damageprediction/4QOx4HgS"
}
],
"Riskfactor": [
{
"type": "configuration/entityTypes/Ingredient/analyticsAttributes/Riskfactor",
"value": "43",
"uri": "entities/0RDZ28R/analyticsAttributes/Riskfactor/4QOx4DQC"
}
]
},
"label": "",
"secondaryLabel": "C3 -"
},
"successful": true
}