Configuration and Content API Guide

Get Reporting Hierarchy Levels

post

/config/sim/v1/hierarchy/locations/getReportingHierarchyLevels

Gets available reporting hierarchy levels within all reporting hierarchies.

Request

Supported Media Types

application/json
multipart/form-data

Request body for get reporting hierarchy levels.

Root Schema : schema

Type: object

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

Show Source

include: string

If specified, limits the data returned to these fields.

Example: levels.name
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
offset: integer

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

Example: 2

{
    "description":"The input body model that needs to be given for get request.",
    "type":"object",
    "properties":{
        "include":{
            "type":"string",
            "description":"If specified, limits the data returned to these fields.",
            "example":"levels.name"
        },
        "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":2
        },
        "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 list of available reporting hierarchy levels present in the organization.

Root Schema : GetReportingHierarchyLevelsResponse

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 Available Reporting Hierarchy Levels of the organization.
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 Available Reporting Hierarchy Levels of the organization.",
            "items":{
                "$ref":"#/definitions/ReportingHierarchyLevels"
            }
        },
        "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 Available Reporting Hierarchy Levels of the organization.

Show Source

Array of: object ReportingHierarchyLevels

{
    "type":"array",
    "description":"Array of Available Reporting Hierarchy Levels of the organization.",
    "items":{
        "$ref":"#/definitions/ReportingHierarchyLevels"
    }
}

Nested Schema : ReportingHierarchyLevels

Type: object

Show Source

levels: array levels

An array of available levels.
reportingHierarchyName: string

Name of available reporting hierarchies present in the organization

Example: ReportingHierarchy

{
    "type":"object",
    "properties":{
        "reportingHierarchyName":{
            "description":"Name of available reporting hierarchies present in the organization",
            "type":"string",
            "items":{
                "type":"string"
            },
            "example":"ReportingHierarchy"
        },
        "levels":{
            "description":"An array of available levels.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/level"
            }
        }
    }
}

Nested Schema : levels

Type: array

An array of available levels.

Show Source

Array of: object level

{
    "description":"An array of available levels.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/level"
    }
}

Nested Schema : level

Type: object

Show Source

name(required): string

name of the level

Example: Corporate

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the level",
            "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