API Object Definitions

Objects/Classes used in API Methods

Objects / Classes

AdUserData

The special 'Active Directory' user object with all relevant meta-data for the user.

AddHierarchyOverlayApiObject

An object representing the hierarchy overlays to be applied to a data model.

AddMeasureOverlayApiObject

An object representing the measure overlays to be applied to a data model.

AddUsersRoleData

An object for defining which suers are attached a role.

AdditionalServerProperties

Additional data source connection properties and settings used OPTIONALLY for different server types.

AdminMultiTenantData

The tenant object contains all relevant meta-data for the tenant.

AdminTypeApiData

The admin type object contains the admin settings for a given user.

ChangeItemDescriptionData

The change object used to set a description for a given content item.

ChangeUserLicenseData

The change license type object contains the license settings for a given user.

ChangeUserLicenseObject

The change license type object contains the license settings for a given user.

ConnStringDscApiObject

The import content items result object from importing content into the system.

ConnectedItemsSearchCriteria

The search criteria for finding materialized data elements.

ConnectionStringProperties

The connection object representing the details of the data sources.

ContentSearchParamsObject

The content search object for specifying search criteria to be used in content searches.

CreateUserAdObject

The object used to create a new user when AD authentication is used.

CreateUserDbObject

The object used to create a new user when DB authentication is used.

CreateUserOpenIdObject

The object used to create a new user when OpenID authentication is used.

CreateUserSamlObject

The object used to create a new user when SAML authentication is used.

DataBaseRecognitionObject

The database and its details object.

DataSourceTableResult

A data flow table, can be information of a direct query table or information of a table node.

DataSourceUsedTablesResult

List of used tables of a data source node within a data flow.

DeleteHierarchyOverlayApiObject

An object representing the hierarchy overlays to be deleted from a data model.

DeleteMeasureOverlayApiObject

An object representing the measure overlays to be deleted from a data model.

DeleteTenantApiData

The listing of tenants that will be removed from the system.

DomainSecurityObject

The security settings object.

DscApiData

The data source changer settings object.

ExecuteMasterFlowObject

Input parameters needed to execute a Master Flow

ExecuteMasterFlowResult

Execute master flow result

ExecuteScheduleApiData

An object for settings the execution parameters of a schedule.

ExecutionViewData

The execution object contains all the details of scheduled execution instance.

ExportData

The object representing the exported PIE file.

ExportOptions

The query export options object used to set optional switches.

ExternalParameters

The parameter object used to specify filters and targets to be used to parameterize the query in the export.

FilterParameter

The filter parameter object used to specify filters for parameterizing queries.

FolderTenantObject

The folder for a tenant object.

HierarchyMeasureSecurity

Details of the security settings to be applied to a data model's hierarchies or measures.

HierarchyMeasureSecurityApiObject

Details of the security settings to be applied to a data model's hierarchies or measures.

HierarchyOverlayData

Metadata overlay of a data model's hierarchy to add. If a property isn't passed then its existing value stays.

HierarchyOverlayToDeleteData

Hierarchy overlay data to delete.

ImportApiResultObject

The import content items result object from importing content into the system.

ItemId

A generic object used to contain ID's of items.

ItemParentApiData

The item-parent object used to set the content item's parent item ID.

ItemRolePair

Object with role and role access types.

ItemRolesForRemoval

Object with roles and items to be removed.

ItemRolesToBeAdded

Object with roles and items to be added.

ItemsForFavorites

The listing of favorite content items for a user.

LdapGroupDetails

The LDAP group object contains a list of all Active Directory groups.

LdapGroupIdentifier

The LDAP/AD group object.

LdapSearchObject

The LDAP search object that contains the parameters to be used in Active Directory searches.

LdapUserObject

The LDAP user object contains a list of all Active Directory users.

LdapUsersSearchObject

The LDAP search object used to find users in teh LDAP directory.

LicenseCountObject

Object which represents the total numbers of Pro and Viewer user licenses

MasterFlowFindDataSourceObject

Use this object to find a specific data source

MasterFlowModelNameObject

Use this object to update model name.

MasterFlowOtherObject

The master flow object contains information about the details of a specific master flow or data flow node and the validation message

MasterFlowProgressResult

The master flow progress update

MasterFlowSchemasObject

Use this object to update the database schemas used in the data flow.

MasterFlowSourceConnectionObject

Use this object to modify the data source server and/or the database in a data flow.

MasterFlowSourceObject

The master flow data source object contains information about the connection of a specific source ETL node or master flow sql script node and the validation message result

MasterFlowTargetConnectionObject

Use this object to modify the data target server and/or the database in a data flow.

MasterFlowTargetObject

The master flow target object contains information about the connection of a specific target ETL node and the validation message result

MasterFlowUpdatedVariableResult

The master flow updated list of variables result

MasterFlowValidationResult

Validation result, includes list for each validation type object

MasterFlowVariableConnectionObject

Use this object to modify the data source server ID or/and database name used in the variable connection.

MasterFlowVariableObject

The master flow variable object contains information about the connection of a specific variable and the validation message result

MasterFlowVariableValueObject

Use this object to modify a variable's value.

MasterFlowVariablesResult

List of variables based on a query with all their connection details

MasterFlowVariablesValueObject

Use this object to modify the values of a list of variables used in a Master Flow.

MaterializedApiObject

The object representing the details for where to import a model PIE file.

MaterializedItemObject

The search results object.

MeasureGroup

A fact table grouping. If table A has measures on it, and table B is connected to it, then table B has MeasureGroup of table A

MeasureOverlayData

Metadata overlay of a data model's measure to add. If a property isn't passed then its existing value stays.

MeasureOverlayToDeleteData

Measure overlay data to delete.

MembersSecurity

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

MembersSecurityApiObject

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

ModelDataFlowSourceInfo

Info about the source Data Flow used to drive this model

ModelRecognitionObject

The model and its details.

ModelingColumn

Definition of a table column in the model.

ModelingHierarchy

Hierarchy definition in the model. A hierarchy is defined by a list of levels, each defined by a column

ModelingHierarchyLevel

Definition of a hierarchy level in the model definition, contains source column identifier.

ModelingMeasure

Definition of a measure in the model definition, contains column unique identifies, aggregation, etc.

ModelingModel

The model definition that contains details of tables, their relationships and joins, and measures.

ModelingProperty

A property column of another column, example: state could have country as a property

ModelingRelationship

Relationship definition used in the models when joining across tables columns.

ModelingRelationshipColumnPair

A pair of linked columns used to define a relationship in the model definition. A relationship can be defined by 1 or more pairs.

ModelingTable

Table definition in a model, contains table schema, name, columns, etc.

ModifiedItemsResult

Generic API response object with success or failure flag and related messages.

MoveItemsObject

The move/copy items object with details of the selected content items and the destination folder.

NewFolderApiData

The listing of content items object.

NewTenantObject

The tenant object for creating new tenants.

NotificationIndicatorsResult

List of notification indicator counts for unread items.

PieApiObject

The object representing the details for where to import a PIE file of content.

ProfileApiData

The Profile definition object contains the definition for a user profile.

ProfilePermissionHolder

The functional items to be available in the profile as either a list or the sum bit indexes. The list will take priority if both are supplied

ProfileRolesData

The profile-role object contains a list of all roles to add or remove for the specified profile.

PyramidContentItem

Pyramid Content item object.

PyramidItemIdentifier

The item idenifier object.

PyramidViewUserObject

The user object contains all relevant meta-data for the user.

QueryExportData

The query export object used to specify how to extract query results.

RenameItemApiData

The rename object for settings to rename content items.

ResultsObjectData

The a generic results object.

RoleAdGroupsModifyObject

The user object contains all relevant meta-data for the user.

RoleData

The role object contains meta-data for the role.

RoleMinimalData

The 'minimal' role object contains basic meta-data for the role.

RoleToItemApiData

The role object with settings to be set for the chosen content item.

RolesInItemRemovalObject

The role object with settings to be set for the chosen content item.

ScheduleSearchCriteria

The search criteria object for finding a schedule.

ScheduleViewObject

The schedule listing object.

SearchAdGroupUsersData

The LDAP search object that contains the parameters to be used in Active Directory searches.

SearchAdUserGroupsData

The LDAP search object that contains the parameters to be used in Active Directory searches.

SearchCriteria

The search object to be used for providing search settings.

ServerData

The data source server object and its settings.

TagData

The tag object used to capture a tag's settings.

TagUsageApiData

The tag usage object used to set a tag for a given content item.

TargetParameter

The target parameter object used to specify target and its filters for parameterizing queries.

TaskUserApiData

An object specifying the requested task id and user id .

TaskViewData

Execution Tasks object with details of a scheduled job task.

TenantLicenseTypeData

The tenant license object with its license type.

TenantSettings

The tenant's settings object.

TenantUsersGetObject

The tenant object for fetching users.

ThemeApiData

The theme object holding the definition of a theme.

ThemeApiObject

The theme object holding the definition of a theme.

ThemeListObject

The object of theme ID's and names

ToggleUserApiData

The toggle object to indicate the user state in the system.

UpdateTenantSeatsObject

The tenant object for updating tenant seats.

UpdateUserAdObject

The object used to update an AD/LDAP based user.

UpdateUserDbObject

The object used to update a database authentication user.

UpdateUserOpenIdObject

The object used to update a OpenID user.

UpdateUserSamlObject

The object used to update a SAML user.

UserCredentials

The user credential object used to set a user's login settings.

UserData

The user object contains all relevant meta-data for the user.

UserOpenIdCredentials

The user credentials for authentication by OpenID parameter map.

UserRolesData

The user-role object contains a list of all roles to add or remove for the specified user.

UserSamlCredentials

The user credentials for authentication by SAML token.

UserTokenCredentials

The user credentials for authentication by token.