Post Relationships (Synchronously)

This endpoint is used to create and update relationships to ER Service API based on existing relationship type schema. List of relationship are provided in the body of the POST request and partition key – ercollectionid should be provided as part of header body.

Note

Once relationships created when update relationships(full object update), it restricts some below properties to change.
relationshipType, brickDestinationEntitySubType,brickDestinationEntityType, brickRelationshipName, brickRelationshipType, brickSourceEntitySubType, brickSourceEntityType.

URL

https://{{HOST}}/apollo/er/relationships?v={version}

Method

Required IMS Scopes

• apollo_write

Versions Supported

1.0 (Default)
1.1

URL Query Parameters

Request Header Parameters

Example

Request

curl -X POST 
  'https://{{HOST}}/apollo/er/relationships?v=1.1' 
  -H 'Authorization: Bearer ACCESS_TOKEN' 
  -H 'Content-Type: application/json' 
  -H 'ercollectionid: TestER-DVDocs' 
  -H 'async: false'
  -d '{ 
        "id": "JCI-507-B1-hasPart-JCI-507-B1-F2", "relationshipName": "JCI-507-B1 hasPart JCI-507-B1-F2", 
        "relationshipType": "BRICK_0_4__hasPart_Location_Location", "sourceEntityId": "JCI-507-B1", "destinationEntityId": "JCI-507-B1-F2" 
    }'

Response

{
    "status": {
        "message": "Total number of Relationships Upserted:  1.",
        "code": "201"
    },
    "transactionId": "e82b6bd8-c2e1-44b0-9c68-7aa245cd0d17",
    "data": {}
}

Errors