Unify and manage your data

Partial Updates for Custom Attributes

Learn how to use partial operations to insert, update, or delete custom attribute values for lookup codes without replacing the entire lookup definition

Attributes store additional metadata for lookup codes in Reltio Reference Data Management (RDM). These custom key value pairs let you extend lookup definitions with business-specific information, such as population, capital city, or legacy identifiers.

You can manage these attribute values using partial update operations. The supported operations are:

  • INSERT – add a new custom attribute.
  • UPDATE – modifies the attributes of an existing custom attribute
  • DELETE – removes an existing custom attribute.

Each operation targets an attribute by its name and updates its value accordingly. You can include multiple custom operations in a single request payload.

INSERT - Add a new custom attribute

The following table describes the request body parameters for the INSERT operation, which adds a new custom attribute to a lookup value.

ParameterTypeRequiredDescriptionDefault ValueAccepted values
operationStringYesSpecifies the operation type.None"INSERT"
nameStringYesName of the attribute to insert.None"Population"
valueStringYesValue of the new attribute.None"331002651"

Example request for INSERT operation

{
  "operation": "INSERT",
  "name": "Population",
  "value": "331002651"
}

UPDATE - Modify the attributes of an existing custom attribute

The following table describes the request body parameters for the UPDATE operation, which modifies the value of an existing custom attribute. The name field identifies the attribute to be updated.

ParameterTypeRequiredDescriptionDefault ValueAccepted values
operationStringYesSpecifies the operation type.None"UPDATE"
nameStringYesName of the attribute to update.None"Population"
valueStringYesNew value to assign to the attribute.None "335000000"

Example request for UPDATE operation

{
  "operation": "UPDATE",
  "name": "Population",
  "value": "335000000"
}

DELETE - Remove an existing custom attribute

The following table describes the request body parameters for the DELETE operation, which removes a custom attribute from a lookup value. Both name and value must match exactly to the existing entry.

ParameterTypeRequiredDescriptionDefault ValueAccepted values
operationStringYesSpecifies the operation type.None "DELETE"
nameStringYesName of the attribute to delete.None"Population"
valueStringYesExact value of the attribute to match.None"331002651"

Example request for DELETE operation

{
  "operation": "DELETE",
  "name": "Population",
  "value": "331002651"
}

Insert, update, and delete custom attributes in a single request

The following example shows how to insert, update, and delete custom attributes for a RDM lookup code using a single request payload.

[
  {
    "tenantId": "{{rdm_tenant}}",
    "type": "rdm/lookupTypes/Country",
    "code": "US",
    "attributes": [
      {
        "operation": "INSERT",
        "name": "Capital",
        "value": "Washington, D.C."
      },
      {
        "operation": "UPDATE",
        "name": "Population",
        "value": "335000000"
      },
      {
        "operation": "DELETE",
        "name": "OldAttribute",
        "value": "OldValue"
      }
    ]
  }
]