Update a hierarchy by ID
Learn more about how to use the hierarchy update API to update a hierarchy by ID.
Use the Hierarchy update to update the metadata for a hierarchy. This operation requires the MDM.Data.Hierarchy permission with the UPDATE privilege.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
PUT https://<environment>.reltio.com/reltio/api/{tenantId}/hierarchies/list/{hierarchyId}Request headers
The following request headers must be included.
| Header | Value | Required |
|---|---|---|
Authorization | Bearer <token> | Yes |
Request body
The request body is a JSON array of connection definition objects.
| Field | Type | Required | Description |
|---|---|---|---|
type | String | Yes | The hierarchy type name as defined in the business configuration. |
name | String | Yes | The name of the hierarchy. |
hasVersioning | Boolean | No | Indicates whether hierarchy versioning must be enabled or disabled. If the hierarchy has multiple versions, you can't disable versioning. |
Example request
Use the following example to see how a complete request is structured with headers.
PUT /list/prd
Authorization: Bearer <token>
{
"type": "configuration/hierarchyTypes/TypeProduct",
"name": "Product Hierarchy",
"hasVersioning": true
}Response fields
The following table describes the fields returned in the response body.
| Field | Type | Description |
|---|---|---|
hierarchyId | String | The hierarchy ID. |
type | String | The hierarchy type name as defined in the business configuration. |
name | String | The name of the hierarchy. |
hasVersioning | Boolean | Indicates whether the hierarchy is versioned. |
singleInstanceId | String | Optional. If versioning is disabled, the ID of the only hierarchy instance. |
createdBy | String | The username of the user who created the hierarchy. |
createdTime | String | The time when the hierarchy was created, in ISO 8601 date-time format. |
updatedBy | String | The username of the user who last updated the hierarchy. |
updatedTime | String | The time when the hierarchy was last updated, in ISO 8601 date-time format. |
Example response
The following example shows the response body.
{
"hierarchyId": "prd",
"type": "configuration/hierarchyTypes/TypeProduct",
"name": "Product Hierarchy",
"hasVersioning": true,
"createdBy": "john.smith@reltio.com",
"createdTime": "2024-10-10T10:13:30",
"updatedBy": "john.smith@reltio.com",
"updatedTime": "2024-10-10T10:15:30"
}