Post Relationships from CSV OR JSON file (Synchronously)

This endpoint is used to create and update relationships to ER Service API based on existing relationship type schema.

This request consists one additional required parameter named ‘fileName’ in request header. It means if request has ‘fileName’ parameter, ERService application will import and read relationship data from JSON file instead from request body. In this request, we do not need to specify any relationship object details in request body. Request body should be null/empty.
Once ERService imports data from JSON file, after that it validates the data from it and process for upsert operation in document DB.

Structure of CSV file :
First Row : It consists all columns with relationships JSON property names
Second Row : It consists data types of each JSON property.
Third Row : It is used to specify the column/JSON property value is ‘required/optional’ field.
Forth Row : From forth row onwards, it consists all relationship objects.

Structure of JSON file:
It consists JObjects of the relationships.

URL

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

Method

Required IMS Scopes

• apollo_write

Versions Supported

1.0 (Default) (For JSON)
1.1 (For CSV)

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-Files' 
  -H 'async: false' 
  -H 'fileName: Import_Relationships.csv'

Response

{
    "status": {
        "message": "Total number of Relationships Upserted:  1.",
        "code": "207"
    },
    "transactionId": "98e4d055-4887-4925-be14-1d565ce8d55b",
    "data": {
        "responses": {
            "success": [
                {
                    "id": "JCI-507-B1-hasPart-JCI-507-B1-F1",
                    "message": "Relationship upserted successfully",
                    "tracker": "http://{{HOST}}/apollo/status/logs?relationshipid=JCI-507-B1-hasPart-JCI-507-B1-F1&transactionid=98e4d055-4887-4925-be14-1d565ce8d55b"
                }
            ]
        }
    }
}

Errors