Configuration and Content API Guide

Delete Reporting Hierarchy Relationships

post

/config/sim/v1/hierarchy/locations/deleteReportingHierarchyRelationships

Removes location from the given reporting hierarchy.

Request

Supported Media Types

application/json
multipart/form-data

Request body for removing location from a reporting hierarchy

Root Schema : schema

Type: object

Show Source

locRef(required): string

The unique reference for the reporting location

Example: locRef1
reportingHierarchyName(required): string

The name of reporting hierarchy from where the location is to be removed.

Example: TestReportingHierarhy

{
    "type":"object",
    "required":[
        "locRef",
        "reportingHierarchyName"
    ],
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The unique reference for the reporting location",
            "example":"locRef1"
        },
        "reportingHierarchyName":{
            "type":"string",
            "description":"The name of reporting hierarchy from where the location is to be removed.",
            "example":"TestReportingHierarhy"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Message indicating the location has been removed.

Root Schema : schema

Type: object

Show Source

msg: string

Example: Removed the location from the reporting hierarchy.

{
    "type":"object",
    "properties":{
        "msg":{
            "type":"string",
            "example":"Removed the location from the reporting hierarchy."
        }
    }
}