Cumulative Entity Update
You can make multiple changes to an entity's attribute at the same time using a cumulative update request.
The following request allows you to do a cumulative entity update:
Request
Parameter | Required | Details | |
---|---|---|---|
Headers | Authorization | Yes | Information about the authentication access token must be in the following format "Bearer
<accessToken> ". For more information, see Authentication API. |
Query | changeRequestId | No | If this parameter is present, all changes will be added to the DCR with a given ID instead of updating the entity. |
alwaysCreateDCR | No |
If Example: | |
overwriteDefaultCrosswalkValue | No | If set to false , the process of normalization of
Reltio crosswalk is skipped. Default is true . | |
Body | Request definition | Yes |
Array of JSON objects, where each object represents changing of an
attribute, tags, or roles. Each object must have a
|
The following types of changes can be done for an entity:
INSERT_ATTRIBUTE
UPDATE_ATTRIBUTE
DELETE_ATTRIBUTE
PIN_ATTRIBUTE
IGNORE_ATTRIBUTE
UPDATE_TAGS
UPDATE_ROLES
UPDATE_START_DATE
UPDATE_END_DATE
All changes, except DELETE_ATTRIBUTE
, must have a
newValue
property, which is the new value of attributes, tags, or
roles.
INSERT_ATTRIBUTE
, UPDATE_ATTRIBUTE
,
DELETE_ATTRIBUTE
, PIN_ATTRIBUTE
,
IGNORE_ATTRIBUTE
changes must have the uri
property,which is the URI of the attribute.
INSERT_ATTRIBUTE
, UPDATE_ATTRIBUTE
, and
DELETE_ATTRIBUTE
changes must have the crosswalk
property, which is the crosswalk for which this attribute should be updated.
Request Examples
Response
Changed entity or data change request (if changeRequestId
is defined or
if you don't have access to update the object, but you do have permission to initiate a
data change request).
"Cumulative update request should not contain
crosswalk of already existing entity"
.