Services Integration Framework Guide

10.4 HotFix 3
- 10.5
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 3
- 10.3 HotFix 2
- 10.3 HotFix 1
- 10.3

Back Next

DeleteRelationship

DeleteRelationship deletes a relationship between two entities. This request does not remove the record from the relationship table. If the relationship is a foreign key relationship rather than a record in a relationship table, the request sets the foreign key value to null.

This request behaves differently when used with Foreign Key Relationship Types. Since all Relationship records of a Foreign Key Relationship Type use the same End Date, instead of setting the End Date this request sets the foreign key value in the FK Relationship Base Object to null.

The request provides the Hierarchy Manager configuration, the record key, and the relationship type of the relationship to be removed.

Required Parameters

The following table lists and describes the parameters that are required by the DeleteRelationship API:

Parameter	Description
HmConfigurationUid	Unique ID of the Hierarchy Manager configuration.
RelTypeUid	Unique ID of the relationship type.
RecordKey	Key to uniquely identify the relationship record to be deleted.

Optional Parameters

The following table lists and describes the optional parameter that is used by the DeleteRelationship API:

Parameter	Description
deleteAsSMOS	If true , the hub state of the relationship record is set to deleted by the state management override system, and this takes precedence over active records from other source systems. Default is false.

Use Case

This is the common scenario for using the DeleteRelationship request:

Delete a relationship between two HM entities
— If you have Hierarchy Manager and have populated it with data, you can use the DeleteRelationship request to delete an existing relationship between two entities.