Jump to

• Request
• Response

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

Body ()

Request body for get reporting hierarchy levels.

Root Schema : GetReportingHierarchyLevelsRequest

Type: object

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

Show Source

• include: string
  Objects included in response

  Example: levels.name
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  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

{
    "description":"The input body model that needs to be given for get request.",
    "type":"object",
    "properties":{
        "include":{
            "type":"string",
            "description":"Objects included in response",
            "example":"levels.name"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":10
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of available reporting hierarchy levels present in the organization.

Body ()

Root Schema : GetReportingHierarchyLevelsResponse

Type: object

Show Source

• count(required): integer
  Current response recount count.

  Example: 1
• hasMore(required): boolean
  Flag indicating if there are more objects to fetch.

  Example: false
• items(required): array items
  Array of Available Reporting Hierarchy Levels of the organization.
• limit(required): integer
  Server page size

  Example: 10
• offset(required): integer
  Starting resource record index

  Example: 0
• totalResults(required): integer
  Total number of rows (excluding the paging parameters)

  Example: 1

{
    "type":"object",
    "required":[
        "totalResults",
        "hasMore",
        "count",
        "items",
        "offset",
        "limit"
    ],
    "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 recount 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(required): array levels
  An array of available levels.
• reportingHierarchyName(required): string
  Name of available reporting hierarchies present in the organization

  Example: ReportingHierarchy

{
    "type":"object",
    "required":[
        "reportingHierarchyName",
        "levels"
    ],
    "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"
        }
    }
}

400 Response

400 Bad Request

Body ()

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"
        }
    }
}

Back to Top