Get hierarchy overlay properties

Gets hierarchy overlays for the given role.

Method

/API2/dataSources/getModelHierarchyOverlay

  • API Section: /API2/dataSources
  • API Version: 2.0
  • From Release: 2023.10
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Domain Admin

Method Signature

Input Parameters

Name

getOverlaySecurityObject

Object Type

GetOverlaySecurityObject

Description

An object representing the data model overlay / security.

Output Response

Successful Result Code

200

Response List Type

HierarchyOverlayData[]

Description of Response Type

List of the hierarchy overlays for the model and the role.. Note that the response is returned as a list of items of this object type.