Update Attribute
Perform update of attribute value representing some source system.
This operation performs an update of attribute value representing some source system.
Note: If existing attribute value is from source A, this value cannot be overridden by
value from source B. In this case, the value from source B is added to existing
attribute values.
Request
PUT /{attribute value URI}| Parameter | Required | Details | |
|---|---|---|---|
| Headers | Authorization |
Yes | Information about authentication access token in format Bearer
<accessToken> (see details in Authentication API). |
Source-System |
Yes-if Source-System is not 'Reltio' |
Source system that this request is representing. Example: |
|
| Query | crosswalkValue |
No |
ID of an entity object providing this attribute in the source system. Example: an entity comes from Facebook and its identifier in Facebook
is |
crosswalkSourceTable |
SourceTable of an entity object providing this
attribute in the source system. |
||
returnObjects |
Specifies if response should contain created entities. Note: Default value is
true. |
||
| Body | Yes |
JSON object representing attribute value. |
Response
JSON objects with:
URI: URI of attribute that was updated/created.-
object: attribute value that was updated/created. This parameter is returned if thereturnObjectsquery parameter in the request is notfalseand object was created successfully. -
error: if an object cannot be updated for some reason. Contains details of the problem. Returns only if an object was not updated.- Possible Errors:
warning: if object is updated but there were some problems.status: result of operation; possible values are"OK"or"failed".
Simple Attribute, Same Source System
Same for Enum, Lookup
Request
PUT /entities/12/attributes/Name/1?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"value":"Johnathan"
}PUT /entities/12/attributes/Name/1?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"URI":"entities/12/attributes/Name/1",
"object":{
"URI":"entities/12/attributes/Name/1",
"type":"configuration/entityTypes/Individual/attributes/Name",
"value":"Johnathan"
},
"status":"OK"
}Simple Attribute, Different Source System
Request
PUT /entities/12/attributes/Name/1?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"value":"Jack"
}Response
PUT /entities/12/attributes/Name/1?crosswalkValue=ABC.id1
Headers:Source-System:configuration/sources/ABC,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"URI":"entities/12/attributes/Name/3",
"object":{
"URI":"entities/12/attributes/Name/3",
"type":"configuration/entityTypes/Individual/attributes/Name",
"value":"Jack"
},
"status":"OK",
"warning":{
"code":"XXXXX01",
"message":"Cannot update '/entities/12/attributes/Name/1'
representing source system 'configuration/sources/ABC' with
crosswalk value 'ABC.id1'.
Another attribute was created."
}
}Nested Attribute
Request
PUT
/entities/12/attributes/Education/5?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"value":{ }
}Response
PUT
/entities/12/attributes/Education/5?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"URI":"entities/12/attributes/Education/5",
"object":{
"URI":"entities/12/attributes/Education/5",
"type":"configuration/entityTypes/Individual/attributes/Education",
"value":{
"University":[
{
"URI":"entities/e1/attributes/Education/5/University/9",
"type":"configuration/entityTypes/Individual/attributes/Education/University",
"value":"UC SF"
}
],
"Graduated":[
{
"URI":"entities/e1/attributes/Education/5/Graduated/8",
"type":"configuration/entityTypes/Individual/attributes/Education/Graduated",
"value":true
}
]
},
"status":"OK"
}
}Nested Attribute: Granular
Request
PUT
/entities/e1/attributes/Education/5/University/9?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"value":"UCSF"
}Response
PUT
/entities/e1/attributes/Education/5/University/9?crosswalkValue=XYZ.id1
Headers:Source-System:configuration/sources/XYZ,
Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"URI":"entities/e1/attributes/Education/5/University/9",
"object":{
"URI":"entities/e1/attributes/Education/5/University/9",
"type":"configuration/entityTypes/Individual/attributes/Education/University",
"value":"UCSF"
},
"status":"OK"
}Reference Attribute
Use Partial Override
This is the preferred approach; therefore, use it whenever possible. You can update
multiple attributes simultaneously. Defining “dataProvider = false”
and “options = partialOverride” prevents the attributes of the
Product and Contact entities from being set to NULL where not specified. Using this
approach does not require knowledge of the entity IDs, and it creates the most
efficient association between entity types, attributes, and their crosswalks.
Request
POST {{TenantURL}}/entities?options=partialOverride
[
{
"type": "configuration/entityTypes/Contact",
"attributes": {
"Product": [
{
"value": {
"Status": [
{
"value": "Active"
}
],
"purchaseDate": [
{
"value": "2019-03-15"
}
]
},
"refEntity": {
"crosswalks": [
{
"type": "configuration/sources/CRM",
"value": "PRD_1000300",
"dataProvider": false
}
]
},
"refRelation": {
"crosswalks": [
{
"type": "configuration/sources/CRM",
"value": "CON_PRD_1000300"
}
]
}
}
]
},
"crosswalks": [
{
"type": "configuration/sources/CRM",
"value": "CON_1000300"
}
]
}
]
Response
[
{
"index": 0,
"object": {
"uri": "entities/1DOZBEBY",
"type": "configuration/entityTypes/Contact",
"createdBy": "terence.kirk@reltio.com",
"createdTime": 1558371247871,
"updatedBy": "terence.kirk@reltio.com",
"updatedTime": 1558371312896,
"attributes": {
"Name": [
{
"type": "configuration/entityTypes/Contact/attributes/Name",
"ov": true,
"value": "James Smith",
"uri": "entities/1DOZBEBY/attributes/Name/2APS2yQTk"
}
],
"FirstName": [
{
"type": "configuration/entityTypes/Contact/attributes/FirstName",
"ov": true,
"value": "James",
"uri": "entities/1DOZBEBY/attributes/FirstName/2APS2rgmS"
}
],
"LastName": [
{
"type": "configuration/entityTypes/Contact/attributes/LastName",
"ov": true,
"value": "Smith",
"uri": "entities/1DOZBEBY/attributes/LastName/2APS2rl2i"
}
],
"Addresses": [
{
"label": "Mailing : 800 Curran Memorial Hwy, North Adams, Massachusetts",
"value": {
"AddressType": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/AddressType",
"ov": true,
"value": "Mailing",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/AddressType/2APS2rLTA"
}
],
"AddressLine1": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/AddressLine1",
"ov": true,
"value": "800 Curran Memorial Hwy",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/AddressLine1/2APS2r4Q8"
}
],
"City": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/City",
"ov": true,
"value": "North Adams",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/City/2APS2uZnI"
},
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/City",
"ov": false,
"value": " North Adams",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/City/2APS2rHCu"
}
],
"StateProvince": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/StateProvince",
"ov": true,
"value": "Massachusetts",
"lookupCode": "MA",
"lookupRawValue": "MA",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/StateProvince/2APS2uN0W"
},
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/StateProvince",
"ov": false,
"value": "MA ",
"lookupError": "1001: Source system [CRM] not found in tenant [RdMiN2YpM94aI200]",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/StateProvince/2APS2r8gO"
}
],
"Country": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/Country",
"ov": true,
"value": "United States",
"lookupCode": "US",
"lookupRawValue": "United States",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Country/2APS2vC9c"
},
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/Country",
"ov": false,
"value": "US",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Country/2APS2rCwe"
}
],
"Zip5": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/Zip5",
"ov": true,
"value": "01247",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Zip5/2APS2vTCe"
},
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/Zip5",
"ov": false,
"value": "1247",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Zip5/2APS2rPjQ"
}
],
"Zip4": [
{
"type": "configuration/entityTypes/Contact/attributes/Addresses/attributes/Zip4",
"ov": true,
"value": "3960",
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Zip4/2APS2vGPs"
}
]
},
"ov": true,
"uri": "entities/1DOZBEBY/attributes/Addresses/2APS2r09s"
}
],
"Phone": [
{
"label": "Phone (415) 555-1212 VALID",
"value": {
"Type": [
{
"type": "configuration/entityTypes/Contact/attributes/Phone/attributes/Type",
"ov": true,
"value": "Phone",
"uri": "entities/1DOZBEBY/attributes/Phone/2APS2rTzg/Type/2APS2rYFw"
}
],
"Number": [
{
"type": "configuration/entityTypes/Contact/attributes/Phone/attributes/Number",
"ov": true,
"value": "1-415-555-1212",
"uri": "entities/1DOZBEBY/attributes/Phone/2APS2rTzg/Number/2APS2rcWC"
}
]
},
"ov": true,
"uri": "entities/1DOZBEBY/attributes/Phone/2APS2rTzg"
}
],
"Product": [
{
"label": "Pen, PEN-0004",
"relationshipLabel": "Active",
"value": {
"Name": [
{
"type": "configuration/entityTypes/Product/attributes/Name",
"ov": true,
"value": "Pen",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/Name/2APS2rtZE"
}
],
"SKU": [
{
"type": "configuration/entityTypes/Product/attributes/SKU",
"ov": true,
"value": "PEN-0004",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/SKU/2APS2rxpU"
}
],
"productID": [
{
"type": "configuration/entityTypes/Product/attributes/productID",
"ov": true,
"value": "10300",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productID/2APS2s25k"
}
],
"productProperties": [
{
"label": "Ink Color: Blue",
"value": {
"Type": [
{
"type": "configuration/entityTypes/Product/attributes/productProperties/attributes/Type",
"ov": true,
"value": "Ink Color",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2sJ8m/Type/2APS2sNP2"
}
],
"Value": [
{
"type": "configuration/entityTypes/Product/attributes/productProperties/attributes/Value",
"ov": true,
"value": "Blue",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2sJ8m/Value/2APS2sRfI"
}
]
},
"ov": true,
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2sJ8m"
},
{
"label": "Style: Fountain",
"value": {
"Type": [
{
"type": "configuration/entityTypes/Product/attributes/productProperties/attributes/Type",
"ov": true,
"value": "Style",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2s6M0/Type/2APS2sAcG"
}
],
"Value": [
{
"type": "configuration/entityTypes/Product/attributes/productProperties/attributes/Value",
"ov": true,
"value": "Fountain",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2s6M0/Value/2APS2sEsW"
}
]
},
"ov": true,
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2s6M0"
}
],
"Status": [
{
"type": "configuration/relationTypes/ContactProduct/attributes/Status",
"ov": true,
"value": "Active",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/Status/2APS2yhWm"
}
],
"purchaseDate": [
{
"type": "configuration/relationTypes/ContactProduct/attributes/purchaseDate",
"ov": true,
"value": "2019-03-15",
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W/purchaseDate/2APS2yln2"
}
]
},
"ov": true,
"uri": "entities/1DOZBEBY/attributes/Product/uC0J62W",
"refEntity": {
"type": "configuration/entityTypes/Product",
"crosswalks": [
{
"uri": "entities/1DOZBEBY/crosswalks/1DOZBIRo.2APS2sVvY",
"type": "configuration/sources/CRM",
"value": "PRD_1000300",
"createDate": "2019-05-20T16:54:07.871Z",
"updateDate": "2019-05-20T16:54:07.871Z",
"attributeURIs": [
"entities/1DOZBEBY/attributes/Product/uC0J62W/productID/2APS2s25k",
"entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2s6M0",
"entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2s6M0/Value/2APS2sEsW",
"entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2sJ8m/Value/2APS2sRfI",
"entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2s6M0/Type/2APS2sAcG",
"entities/1DOZBEBY/attributes/Product/uC0J62W",
"entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2sJ8m",
"entities/1DOZBEBY/attributes/Product/uC0J62W/Name/2APS2rtZE",
"entities/1DOZBEBY/attributes/Product/uC0J62W/productProperties/2APS2sJ8m/Type/2APS2sNP2",
"entities/1DOZBEBY/attributes/Product/uC0J62W/SKU/2APS2rxpU"
]
}
],
"objectURI": "entities/1DOZBIRo"
},
"refRelation": {
"type": "configuration/relationTypes/ContactProduct",
"crosswalks": [
{
"uri": "entities/1DOZBEBY/crosswalks/uC0J62W.2APS2yuJY",
"type": "configuration/sources/CRM",
"value": "CON_PRD_1000300",
"createDate": "2019-05-20T16:55:12.896Z",
"updateDate": "2019-05-20T16:55:12.896Z",
"attributeURIs": [
"entities/1DOZBEBY/attributes/Product/uC0J62W/Status/2APS2yhWm",
"entities/1DOZBEBY/attributes/Product/uC0J62W",
"entities/1DOZBEBY/attributes/Product/uC0J62W/purchaseDate/2APS2yln2"
]
}
],
"startRefPinned": false,
"endRefPinned": false,
"startRefIgnored": false,
"endRefIgnored": false,
"objectURI": "relations/uC0J62W"
},
"startObjectCrosswalks": [
{
"type": "configuration/sources/CRM",
"value": "CON_1000300"
],
"singleAttributeUpdateDates": {}
}
]
}
]
},
"isFavorite": false,
"crosswalks": [
{
"uri": "entities/1DOZBEBY/crosswalks/2APS2rpIy",
"type": "configuration/sources/CRM",
"value": "CON_1000300",
"reltioLoadDate": "2019-06-03T16:19:28.521Z",
"createDate": "2019-05-20T16:54:07.871Z",
"updateDate": "2019-05-20T16:54:07.871Z",
"attributes": [
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Zip5/2APS2rPjQ",
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s/AddressType/2APS2rLTA",
"entities/1DOZBEBY/attributes/LastName/2APS2rl2i",
"entities/1DOZBEBY/attributes/Phone/2APS2rTzg/Number/2APS2rcWC",
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s/StateProvince/2APS2r8gO",
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s",
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s/Country/2APS2rCwe",
"entities/1DOZBEBY/attributes/Phone/2APS2rTzg",
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s/City/2APS2rHCu",
"entities/1DOZBEBY/attributes/Phone/2APS2rTzg/Type/2APS2rYFw",
"entities/1DOZBEBY/attributes/Addresses/2APS2r09s/AddressLine1/2APS2r4Q8",
"entities/1DOZBEBY/attributes/FirstName/2APS2rgmS"
],
"singleAttributeUpdateDates": {}
}
],
"label": "James Smith,"
},
"successful": true
}
]