Jump to

• Request
• Response

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

Body ()

Request body for reporting hierarchy relationship request

Root Schema : GetReportingHierarchyRelationshipRequest

Type: object

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

Show Source

• include: string
  Objects included in response

  Example: reportingHierarchyName
• 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
• 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

{
    "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":"Objects included in response",
            "example":"reportingHierarchyName"
        },
        "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 collection of reporting hierarchy relationships for a location.

Body ()

Root Schema : GetReportingHierarchyRelationshipResponse

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 reporting hierarchy relationships
• 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 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"
        }
    }
}

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