Configuration and Content API Guide

Get Reporting Hierarchy Relationships

post

/config/sim/v1/hierarchy/locations/getReportingHierarchyRelationships

Returns details of parent enterprise levels assigned to a location within various reporting hierarchies.

Request

Supported Media Types

application/json
multipart/form-data

Request body for reporting hierarchy relationship request

Root Schema : schema

Type: object

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

Show Source

include: string

If specified, limits the data returned to these fields.

Example: reportingHierarchyName
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
limit: integer

If using paging, number of results returned in this page.

Example: 10
locRef(required): string

The unique reference for the reporting location

Example: locRef1
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0

{
    "description":"The input body model that needs to be given for the get request.",
    "type":"object",
    "required":[
        "locRef"
    ],
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The unique reference for the reporting location",
            "example":"locRef1"
        },
        "include":{
            "type":"string",
            "description":"If specified, limits the data returned to these fields.",
            "example":"reportingHierarchyName"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":10
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of reporting hierarchy relationships for a location.

Root Schema : GetReportingHierarchyRelationshipResponse

Type: object

Show Source

count: integer

Current response record count.

Example: 1
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: false
items: array items

Array of reporting hierarchy relationships
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 1

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":1,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":false,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":1,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of reporting hierarchy relationships",
            "items":{
                "$ref":"#/definitions/ReportingHierarchyRelationships"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of reporting hierarchy relationships

Show Source

Array of: object ReportingHierarchyRelationships

{
    "type":"array",
    "description":"Array of reporting hierarchy relationships",
    "items":{
        "$ref":"#/definitions/ReportingHierarchyRelationships"
    }
}

Nested Schema : ReportingHierarchyRelationships

Type: object

Show Source

parentReportingLevelName(required): string

The name of parent enterprise level within the reporting hierarchy.

Example: Corporate
reportingHierarchyName(required): string

The name of reporting hierarchy where the parent level is assigned.

Example: TestReportingHierarhy

{
    "type":"object",
    "required":[
        "reportingHierarchyName",
        "parentReportingLevelName"
    ],
    "properties":{
        "reportingHierarchyName":{
            "type":"string",
            "description":"The name of reporting hierarchy where the parent level is assigned.",
            "example":"TestReportingHierarhy"
        },
        "parentReportingLevelName":{
            "type":"string",
            "description":"The name of parent enterprise level within the reporting hierarchy.",
            "example":"Corporate"
        }
    }
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details