Batch processing of analytic attribute values
Learn more about updating analytic attributes in bulk.
This API operation enables you to update analytic attributes in bulk.
Request
POST {TenantURL}/entities/_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. |
| overwrite | No | If an analytics attribute already has a value, this field indicates whether to update the existing value or keep both values. This field defaults to false. Note: Ensure you check the maxOccurs parameter of the analytic attribute and then set the overwrite parameter accordingly. For more information about the maxOccurs parameter, see topic Configuring Analytical Attributes to Hold Validation Warnings. | |
| 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 - The 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
returnObjectsquery parameter in the request istrueand 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
POST {{tenantURL}}/entities/_analyticsAttributes?overwrite=false
[
{
"uri": "05Jg9gA",
"analyticsAttributes": {
"Email": [
{
"value": {
"Email": [
{
"value": "Email_Address"
}
],
"Rank": [
{
"value": "Email_Rank"
},
{
"value": "Email_Rank_2"
}
]
}
}
]
}
},
{
"uri": "05Jg5Pu",
"analyticsAttributes": {
"Email": [
{
"value": "Email_Address"
}
],
"Rank": [
{
"value": "Email_Rank_3"
},
{
"value": "3"
}
]
}
}
]
Response
[
{
"index": 0,
"object": {
"uri": "entities/05Jg9gA",
"type": "configuration/entityTypes/HCP",
"createdBy": "ayush.jain@reltio.com",
"createdTime": 1701690526278,
"updatedBy": "ayush.jain@reltio.com",
"updatedTime": 1701690526278,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/HCP/attributes/FirstName",
"ov": true,
"value": "FirstName_LF_AAAAA-20231205",
"uri": "entities/05Jg9gA/attributes/FirstName/Z5vMBpK"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/05Jg9gA/crosswalks/Z5vMKLq",
"type": "configuration/sources/Reltio",
"value": "05Jg9gA",
"reltioLoadDate": "2023-12-04T11:48:46.278Z",
"createDate": "2023-12-04T11:48:46.278Z",
"updateDate": "2023-12-04T11:48:46.278Z",
"attributes": [
"entities/05Jg9gA/attributes/FirstName/Z5vMBpK"
],
"singleAttributeUpdateDates": {}
},
{
"uri": "entities/05Jg9gA/crosswalks/Z5vMjvO",
"type": "configuration/sources/ReltioCleanser",
"value": "05Jg9gA",
"reltioLoadDate": "2023-12-04T11:48:46.278Z",
"createDate": "2023-12-04T11:48:46.445Z",
"updateDate": "2023-12-04T11:48:46.445Z",
"attributes": [],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {
"Email": [
{
"value": {
"Email": [
{
"type": "configuration/entityTypes/HCP/analyticsAttributes/Email/analyticsAttributes/Email",
"value": "Email_Address",
"uri": "entities/05Jg9gA/analyticsAttributes/Email/0/Email/0"
}
],
"Rank": [
{
"type": "configuration/entityTypes/HCP/analyticsAttributes/Email/analyticsAttributes/Rank",
"value": "Email_Rank",
"uri": "entities/05Jg9gA/analyticsAttributes/Email/0/Rank/0"
},
{
"type": "configuration/entityTypes/HCP/analyticsAttributes/Email/analyticsAttributes/Rank",
"value": "Email_Rank_2",
"uri": "entities/05Jg9gA/analyticsAttributes/Email/0/Rank/1"
}
]
},
"uri": "entities/05Jg9gA/analyticsAttributes/Email/0"
}
]
},
"label": "FirstName_LF_AAAAA-20231205",
"secondaryLabel": ""
},
"successful": true
},
{
"index": 1,
"object": {
"uri": "entities/05Jg5Pu",
"type": "configuration/entityTypes/HCP",
"createdBy": "ayush.jain@reltio.com",
"createdTime": 1701690526278,
"updatedBy": "ayush.jain@reltio.com",
"updatedTime": 1701690526278,
"attributes": {
"FirstName": [
{
"type": "configuration/entityTypes/HCP/attributes/FirstName",
"ov": true,
"value": "FirstName_LF_AAAAA-20231204",
"uri": "entities/05Jg5Pu/attributes/FirstName/Z5vLz2Y"
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/05Jg5Pu/crosswalks/Z5vMG5a",
"type": "configuration/sources/Reltio",
"value": "05Jg5Pu",
"reltioLoadDate": "2023-12-04T11:48:46.278Z",
"createDate": "2023-12-04T11:48:46.278Z",
"updateDate": "2023-12-04T11:48:46.278Z",
"attributes": [
"entities/05Jg5Pu/attributes/FirstName/Z5vLz2Y"
],
"singleAttributeUpdateDates": {}
},
{
"uri": "entities/05Jg5Pu/crosswalks/Z5vMOc6",
"type": "configuration/sources/ReltioCleanser",
"value": "05Jg5Pu",
"reltioLoadDate": "2023-12-04T11:48:46.278Z",
"createDate": "2023-12-04T11:48:46.441Z",
"updateDate": "2023-12-04T11:48:46.441Z",
"attributes": [],
"singleAttributeUpdateDates": {}
}
],
"analyticsAttributes": {
"Email": [
{
"value": {},
"uri": "entities/05Jg5Pu/analyticsAttributes/Email/0"
}
]
},
"label": "FirstName_LF_AAAAA-20231204",
"secondaryLabel": ""
},
"successful": true
}
]