Configuration and Content API Guide

Update Reporting Hierarchy Relationships

post

/config/sim/v2/hierarchy/locations/updateReportingHierarchyRelationships

Assigns, updates, or removes a parent level to a location within a reporting hierarchy.

Request

Supported Media Types

application/json
multipart/form-data

Request body for updating parent level within a reporting hierarchy

Root Schema : UpdateReportingHierarchyRelationshipRequest

Type: object

The input body model that needs to be given for the update request.

Show Source

locRef(required): string

The unique reference for the reporting location

Example: locRef1
parentReportingLevelName(required): string

The name of parent enterprise level within the reporting hierarchy. Use 'No Parent' keyword to assign the highest level.

Example: Corporate
reportingHierarchyName(required): string

The name of reporting hierarchy where the parent level needs to be assigned/ updated.

Example: TestReportingHierarhy

{
    "description":"The input body model that needs to be given for the update request.",
    "type":"object",
    "required":[
        "locRef",
        "reportingHierarchyName",
        "parentReportingLevelName"
    ],
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The unique reference for the reporting location",
            "example":"locRef1"
        },
        "reportingHierarchyName":{
            "type":"string",
            "description":"The name of reporting hierarchy where the parent level needs to be assigned/ updated.",
            "example":"TestReportingHierarhy"
        },
        "parentReportingLevelName":{
            "type":"string",
            "description":"The name of parent enterprise level within the reporting hierarchy. Use 'No Parent' keyword to assign the highest level.",
            "example":"Corporate"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Unique reference of the location

Root Schema : UpdateReportingHierarchyRelationshipResponse

Type: object

The input body model that needs to be given for the update request.

Show Source

locRef(required): string

The unique reference for the reporting location

Example: locRef1

{
    "description":"The input body model that needs to be given for the update request.",
    "type":"object",
    "required":[
        "locRef"
    ],
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The unique reference for the reporting location",
            "example":"locRef1"
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): string

A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":"55223"
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":"400"
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}