Post Entities (Synchronously)

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

Note

Once entities created when update entities(full object update), it restricts some below properties to change.
entityType,brickEntityName, brickEntitySubType, brickEntityType.

URL

https://{{HOST}}/apollo/er/entities?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/entities?v=1.1' 
  -H 'Authorization: Bearer ACCESS_TOKEN' 
  -H 'Content-Type: application/json' 
  -H 'ercollectionid: TestER-DVDocs' 
  -H 'async: false'
  -d '{"entityType": "BRICK_0_4__Building", "entityName": "JCI 507 Michigan Street Milwaukee Building B6", "id": "JCI-507-B6"}'

Response

{
    "status": {
        "message": "Total number of Entities Upserted:  1.",
        "code": "207"
    },
    "transactionId": "64572d07-fbbf-4315-b24f-4dd49b8b6c1f",
    "data": {
        "responses": {
            "success": [
                {
                    "id": "JCI-507-B6",
                    "message": "success",
                    "tracker": "http://{{HOST}}/apollo/status/logs?entityid=JCI-507-B6&transactionid=64572d07-fbbf-4315-b24f-4dd49b8b6c1f"
                }
            ]
        }
    }
}

Errors