Ignore Attribute
Learn how to ignore an attribute with the Attribute API.
Use the Attribute ignore endpoint to set or remove an ignored flag for a particular attribute value.
Here are considerations to understand when using this flag:
- Its behavior is opposite to the pin value. When getting attribute values, the API always returns ignored values last, no matter which survivorship strategy is set for this attribute type.
- If a value is ignored and this value is updated through an API or DCR, the updated value also remains ignored. For details, see topic Pin/Ignore Flags.
-
If this value is ignored, all crosswalks containing the same value are also ignored.
- If you need to override the ignore flag when the same value is updated from a different crosswalk, raise a Support ticket requesting to set the overridePrevValueStatus to true in the Tenant Storage Configuration of the Physical Configuration. For information on raising a Support ticket, see topic Get help in Support Portal
Request
PUT /{attributeValueURI}/ignore {"value": true}| Parameter | Required | Details | |
|---|---|---|---|
|
Headers |
Authorization |
Yes |
Information about authentication access token in format Bearer |
|
Body |
|
Yes |
JSON object representing attribute value |
Response
JSON objects with:
URI: URI of attribute that was updated/created.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"and"failed".
Sample response
PUT /entities/00005KL/attributes/FirstName/49/pin
Headers:Authorization:Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512,
Content-Type:application/json
Body:{
"type":"configuration/entityTypes/Reltio.System.Individual/attributes/FirstName",
"value":"Yury",
"URI":"entities/00005KL/attributes/FirstName/49",
"ignored":true
}