Remove Relation by DCR

This operation removes a relation only when the DCR is applied.

Request:

Operation endpoints:

DELETE {TenantURL}/relations/{id}?changeRequestId={dcr_id}

DELETE {TenantURL}/relations/{id}?alwaysCreateDCR=true

Table 1. Parameters
Name				Required	Details
Headers	`Authorization`			Yes	Access Token in format "Bearer`<accessToken>`".
	`Content-Type`			Yes	Should be `"Content-Type: application/json"`.
	`EnvironmentURL`			Yes	Reltio Environment URL.
Body				Yes	JSON Array with objects representing attribute values to be used for creating/updating the data change s request.
	`uri`			No	URI of relationship object that is created.
	`createdBy`			No	User who created the object.
	`createdTime`			No	Timestamp when record was created, in milliseconds.
	`updatedBy`			No	ID of a user who updated this data request.
	`updatedTime`			No	Timestamp when record was most recently updated, in milliseconds.
	`changes`			Yes	Contains all change items grouped by objects.
		`relations`		No
			`id`	No	Unique ID of the change item.
			`type`	No	Type of object change item.
			`createdTime`	No	Timestamp when record was created, in milliseconds.
			`createdBy`	No	User who created the object.
	`objectsInfo`			Yes	Information about objects participating in this data change request: `type`, `label`,`secondaryLabel`,`startObjectLabel`,`startObjectUri`,`endObjectLabel`, `endObjectUri`, `isExist`. This property exists only if`showObjectsInfo=true` request parameter was specified.
		`relations`		No
	`type`			Yes	Relationship type. Example:`configuration/relationTypes/Employment`
	`state`			Yes	Current state of the data request:`AWAITING_REVIEW`, `APPLIED`, `REJECTED`.

Response:

Response structure:

uri: URI of relationship object that is created
createdBy: User who created the object
createdTime: Timestamp when record was created, in milliseconds
updatedBy: ID of a user who updated this data request
updatedTime: Timestamp when record was most recently updated, in milliseconds
changes: Contains all change items grouped by objects.
relations:
objectsInfo: Information about objects participating in this data change request
type: Relationship type
state: Current state of the data request
error: returned if an error is encountered, contains details of the issue:
- errorCode: 5-digit error code
- errorMessage: error message
- errorData: details of the error:
  - exception: exception message
  - stack: stack trace
- innerError: details of the error from Reltio API:
  - errorMessage: Reltio API error message
  - errorCode: Reltio API error code
  - innerErrorData: Reltio API inner error data
warning: returned if the operation is completed with some minor issues
status: result of the operation; possible values are "OK" or "failed"

Sample Response JSON:

GET {TenantURL}/{changeRequestURI}?showObjectsInfo=true{
   "uri":"changeRequests/0001dE9",
   "createdBy":"User",
   "createdTime":1503657442051,
   "updatedBy":"User",
   "updatedTime":1503657442051,
   "changes":{
      "relations/0000Aef":[
         {
            "id":"0001lkf",
            "type":"DELETE_RELATIONSHIP",
            "createdTime":1503657442051,
            "createdBy":"User"
         }
      ]
   },
   "objectsInfo":{
      "relations/0000Aef":{
         "type":"configuration/relationTypes/HasAddress",
         "startObjectUri":"entities/00005KL",
         "startObjectLabel":"Test",
         "endObjectUri":"entities/0000Dqr",
         "endObjectLabel":"AddressLine",
         "isExist":true
      }
   },
   "type":"configuration/changeRequestTypes/someChangeRequestType",
   "state":"AWAITING_REVIEW"

Possible Object Change Types

The following types are supported:

INSERT_ATTRIBUTE
UPDATE_ATTRIBUTE
DELETE_ATTRIBUTE
PIN_ATTRIBUTE
IGNORE_ATTRIBUTE
CREATE_ENTITY
CREATE_RELATIONSHIP
DELETE_RELATIONSHIP

Unify and manage your data

Remove Relation by DCR

Possible Object Change Types

Footer