Add DELETE Attribute Request
Learn more about how to add a DELETE_ATTRIBUTE change item to a data change request for an existing attribute.
Use the Add DELETE Attribute Request operation to queue an attribute for deletion within a data change request, instead of deleting the attribute directly from the object. Reltio uses the attribute's URI to identify which attribute to delete. This approach is useful when your workflow requires change review and approval before data is permanently modified, or when you have initiation privileges but not direct delete privileges.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
DELETE <TenantURL>/{attributeValueURI}The following table describes the endpoint path parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
TenantURL | String | Yes | Base URL of your Reltio tenant. |
attributeValueURI | String | Yes | URI of the existing attribute value to delete. This path parameter identifies the attribute that Reltio adds to the data change request as a DELETE_ATTRIBUTE change item. |
Request headers
Include the following headers in every request:
| Name | Required | Description |
|---|---|---|
Authorization | Yes | Authentication access token in the format Bearer <access_token>. |
Source-System | No | Source system that the request represents. Example: configuration/sources/Reltio when the data is created directly in Reltio Platform. |
Content-Type | Yes | application/json |
Query parameters
The following table describes the query parameters and their values.
| Parameter | Type | Required | Description |
|---|---|---|---|
changeRequestId | String | No | ID of the data change request to which the new change item is added. |
crosswalkValue | String | Yes, if Source-System is not Reltio | ID of the entity object that provides this attribute in the source system. |
crosswalkSourceTable | String | No | Source table for the crosswalk, when applicable. |
Behavior based on privileges and changeRequestId
The following table describes the behavior of Add DELETE Attribute Request based on whether changeRequestId is provided and on the user's privileges for the object and attribute.
changeRequestId provided | User privileges | Result |
|---|---|---|
| Yes |
READ, INITIATE_CHANGE_REQUEST, or DELETE, as applicable for the request | Reltio appends the DELETE_ATTRIBUTE item to the specified existing data change request. |
| No | User has READ privilege for the object and attribute and INITIATE_CHANGE_REQUEST privilege for the attribute, but does not have DELETE privilege | Reltio automatically creates a new data change request and returns it. |
| No | User has DELETE privilege for the attribute | Reltio deletes the attribute directly without creating a data change request. |
Request body
This operation does not require a request body.
The attributeValueURI in the request path identifies the attribute to delete. After Reltio validates the request, it creates a data change request change item of type DELETE_ATTRIBUTE.
Example request
Use the following example to see how to submit the request with headers and no request body.
curl -X POST \
"{TenantURL}/<existing-delete-attribute-dcr-endpoint>" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json"Response body
The following table describes the fields returned in the response body.
| Parameter | Type | Description |
|---|---|---|
id | String | Unique identifier of the generated change item. |
type | String | Type of the generated change item. For this request, the value is DELETE_ATTRIBUTE. |
createdTime | Number | Time when the change item was created, in epoch milliseconds. |
createdBy | String | User who created the change item. |
attributePath | String | Path of the attribute targeted for deletion. |
oldValue | Object | Previous value of the attribute before the delete request was added. |
crosswalk | Object | Crosswalk information associated with the attribute value. |
Example response
The following example shows a response with the generated change item.
{
"id": "0000sLJ",
"type": "DELETE_ATTRIBUTE",
"createdTime": 1445443808276,
"createdBy": "User",
"attributePath": "ProductMetrics/3/NumberPatients/5",
"oldValue": {
"value": "1111"
},
"crosswalk": {
"type": "configuration/sources/Veeva",
"value": "e1"
}
}