Configuration and Content API Guide

Delete Locations

post

/config/sim/v1/hierarchy/deleteLocations

Deletes the location object. The corresponding reporting location is not deleted. After deleting the Location, the corresponding Location Parameter needs to be deleted manually.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Request Body

Root Schema : schema

Type: object

Show Source

hierUnitId(required): integer

unique hierarchy unit value

Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "description":"unique hierarchy unit value",
            "type":"integer",
            "example":1
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Message indicating the number of records deleted.

Root Schema : schema

Type: object

Show Source

msg: string

Example: 1 record deleted

{
    "type":"object",
    "properties":{
        "msg":{
            "type":"string",
            "example":"1 record deleted"
        }
    }
}