Clone an unversioned hierarchy instance

Learn more about how to use the Clone unversioned hierarchy instance to create a hierarchy and, optionally, its first connection.

Use the Clone an unversioned hierarchy instance to create a new hierarchy by cloning an existing hierarchy. All hierarchy connections are cloned automatically. This operation requires the MDM.Data.Hierarchy permission with the CREATE privilege.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

POST https://<environment>.reltio.com/reltio/api/{tenantId}/hierarchies/list/{hierarchyId}/clone

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	Nested field	Type	Required	Description
`type`	—	String	Yes	The hierarchy type name as defined in the business configuration.
`name`	—	String	Yes	The name of the new hierarchy.
`hasVersioning`	—	Boolean	No	Indicates whether the cloned hierarchy is versioned.
`version`	—	Object	Yes, if `hasVersioning=true`	The object that describes the version to create.
	`name`	String	See `version`	The name of the version.
	`status`	String	See `version`	Optional. The status of the version.
	`effectiveStartDate`	String	See `version`	Optional. The start effective date of the version in ISO 8601 date format.
	`effectiveEndDate`	String	See `version`	Optional. The end effective date of the version in ISO 8601 date format.
	`description`	String	See `version`	Optional. The description of the version.
	`context`	String	See `version`	Optional. Additional context for the version.

Example request

Use the following example to see how a complete request is structured with headers.

POST /list/prd/clone
Authorization: Bearer <token>

{
  "type": "configuration/hierarchyTypes/TypeProduct",
  "name": "Cloned Product Hierarchy",
  "hasVersioning": true,
  "version": {
    "name": "Version 2",
    "status": "ACTIVE",
    "effectiveStartDate": "2024-01-01",
    "effectiveEndDate": "2026-12-31",
    "description": "longDescription",
    "context": "longContextDescription"
  }
}

Response fields

The following table describes the fields returned in the response body, which is an array of hierarchy connection objects.


Field	Nested field	Type	Description
`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.
`hierarchyId`	—	String	The ID of the created hierarchy.
`instanceId`	—	String	The ID of the created hierarchy instance.
`version`	—	Object	Optional. The created hierarchy version.
	`versionId`	String	The ID of the created version.
	`name`	String	The name of the version.
	`status`	String	Optional. The status of the version.
	`effectiveStartDate`	String	Optional. The start effective date of the version in ISO 8601 date format.
	`effectiveEndDate`	String	Optional. The end effective date of the version in ISO 8601 date format.
	`description`	String	Optional. The description of the version.
	`context`	String	Optional. Additional context for the version.
`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.

{
  "type": "configuration/hierarchyTypes/TypeProduct",
  "name": "Cloned Product Hierarchy",
  "hasVersioning": true,
  "hierarchyId": "0ABlc0A",
  "instanceId": "0ABlc0A.0ABlgGQ",
  "version": {
    "versionId": "0ABlgGQ",
    "name": "Version 2",
    "status": "ACTIVE",
    "effectiveStartDate": "2024-01-01",
    "effectiveEndDate": "2026-12-31",
    "description": "longDescription",
    "context": "longContextDescription"
  },
  "createdBy": "email@reltio.com",
  "createdTime": "2025-04-01T13:30:00",
  "updatedBy": "email@reltio.com",
  "updatedTime": "2025-04-01T13:30:00"
}

Unify and manage your data