MembersSecurityApiObject

The details of the security settings for the hierarchy's member elements.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

modelId

The model's ID

Y

string

roleId

The role id that the settings apply to

Y

string

hierarchyUniqueName

The unique name of the hierarchy that contain the members

Y

string

enableMode

Set to true for 'Enabled' (included) mode. Set to false for 'Disabled' (excluded) mode.

Y

boolean

visualTotals

Enable or disable visual totals. Relevant in parent-child hierarchies security only.

 -

boolean

members

A listing of the unique names of members that need to be secured.

 -

array

script

The PQL script to be used to evaluate the member listing that needs to be secured.

 -

string

*Required elements are only used for API parameters

Usages
  • /API2/dataSources/addMembersSecurityToModel