API Object Definitions
Objects/Classes used in API Methods
Objects / Classes
|
An object representing the hierarchy overlays to be applied to a data model. |
|
|
An object representing the measure overlays to be applied to a data model. |
|
|
An object for defining which user is attached to a role. |
|
|
An object for defining which users are attached a role. |
|
|
Additional data source connection properties and settings used OPTIONALLY for different server types. |
|
|
The tenant object contains all relevant meta-data for the tenant. |
|
|
The admin type object contains the admin settings for a given user. |
|
|
An object that contains the profile definition for analyst users. |
|
|
The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied |
|
|
An object containing the license status |
|
|
An object containing the task status |
|
|
Describes translations for attribute |
|
|
The user credentials for authentication by OpenID parameter map. |
|
|
The user credentials for authentication by SAML token. |
|
|
Settings for the Categories drop zone for the Cartesian visual |
|
|
Settings for the Categories hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Color drop zone chip for the Cartesian visual |
|
|
Settings for the Color drop zone for the Cartesian visual |
|
|
Settings for the Color hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Color measure drop zone chip for the Cartesian visual |
|
|
Settings for the Filter drop zone chip for the Cartesian visual |
|
|
Settings for the Filter drop zone for the Cartesian visual |
|
|
Settings for the Filter hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Filter values drop zone chip for the Cartesian visual |
|
|
Settings for the Labels drop zone chip for the Cartesian visual |
|
|
Settings for the Labels drop zone for the Cartesian visual |
|
|
Settings for the Labels hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Labels measure drop zone chip for the Cartesian visual |
|
|
Settings for the Motion drop zone for the Cartesian visual |
|
|
Settings for the Motion hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Shape drop zone chip for the Cartesian visual |
|
|
Settings for the Shape drop zone for the Cartesian visual |
|
|
Settings for the Shape hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Shape measure drop zone chip for the Cartesian visual |
|
|
Settings for the Size drop zone for the Cartesian visual |
|
|
Settings for the Size measure drop zone chip for the Cartesian visual |
|
|
Settings for the Tooltip drop zone chip for the Cartesian visual |
|
|
Settings for the Tooltip drop zone for the Cartesian visual |
|
|
Settings for the Tooltip hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the Tooltip measure drop zone chip for the Cartesian visual |
|
|
Settings for the TrellisHorizontal drop zone chip for the Cartesian visual |
|
|
Settings for the TrellisHorizontal drop zone for the Cartesian visual |
|
|
Settings for the TrellisHorizontal hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the TrellisHorizontal values drop zone chip for the Cartesian visual |
|
|
Settings for the TrellisVertical drop zone chip for the Cartesian visual |
|
|
Settings for the TrellisVertical drop zone for the Cartesian visual |
|
|
Settings for the TrellisVertical hierarchy drop zone chip for the Cartesian visual |
|
|
Settings for the TrellisVertical values drop zone chip for the Cartesian visual |
|
|
Settings for the Values drop zone for the Cartesian visual |
|
|
Settings for the Values measure drop zone chip for the Cartesian visual |
|
|
Settings for the Values measure drop zone chip for the Cartesian visual |
|
|
Settings for the Cartesian visual |
|
|
The change object used to set a description for a given content item. |
|
|
The change license type object contains the license settings for a given user. |
|
|
The import content items result object from importing content into the system. |
|
|
The search criteria for finding materialized data elements. |
|
|
The search criteria for finding data sources connections and their properties. |
|
|
The connection object representing the details of the data sources |
|
|
The connection object representing the details of the data sources. |
|
|
The content search object for specifying search criteria to be used in content searches. |
|
|
The role creation object contains meta-data for the role. |
|
|
The object used to create a new user when AD authentication is used. |
|
|
The object used to create a new user when DB authentication is used. |
|
|
The object used to create a new user from search. |
|
|
Represents a user to be updated in the system |
|
|
The object used to create a new user when OpenID authentication is used. |
|
|
The object used to create a new user when SAML authentication is used. |
|
|
The returned Object when importing a theme. |
|
|
The database and its details object. |
|
|
Describes a Dimension/Table in the model |
|
|
Describes a Hierarchy/Column in Dimension/Table |
|
|
Describes a level of a hierarchy |
|
|
Describes an Item in the data catalog |
|
|
Describes a Measure in the model |
|
|
Describes the metadata of the discover object |
|
|
Describes a property of Hierarchy, Column or Hierarchy Level |
|
|
Data for data catalog update operation |
|
|
A data flow table, can be information of a direct query table or information of a table node. |
|
|
List of used tables of a data source node within a data flow. |
|
|
An object representing the hierarchy overlays to be deleted from a data model. |
|
|
An object representing the measure overlays to be deleted from a data model. |
|
|
The listing of tenants that will be removed from the system. |
|
|
Metadata details of the Discover item |
|
|
Describes the discover model |
|
|
An object that contains the profile permission for domain admin users. |
|
|
The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied |
|
|
The security settings object. |
|
|
The data source changer settings object. |
|
|
Describes single selection in hierarchy |
|
|
The members/elements contained in a Formulation parameter |
|
|
Describes error details |
|
|
Input parameters needed to execute a Master Flow |
|
|
Execute master flow result |
|
|
An object for settings the execution parameters of a schedule. |
|
|
Advanced Query Features |
|
|
The execution object contains all the details of scheduled execution instance. |
|
|
The object representing the details for which items to export with two booleans. |
|
|
The object representing the exported PIE file. |
|
|
The query export options object used to set optional switches. |
|
|
The object used to specify groups in the external IDP. |
|
|
Represents an external group |
|
|
The parameter object used to specify filters and targets to be used to parameterize the query in the export. |
|
|
The search object used to find items in the external IDP. |
|
|
The object used to specify users in the external IDP. |
|
|
Represents an external user |
|
|
A generic object used to contain ID of item. |
|
|
The filter parameter object used to specify filters for parameterizing queries. |
|
|
The folder for a tenant object. |
|
|
The details of the Formula to add to the system. |
|
|
Settings for FTP server connections |
|
|
The object for getting the folder items |
|
|
The search configuration for specifying the criteria to be used |
|
|
An object representing the data model overlay / security. |
|
|
Settings for the Color drop zone chip for the Grid visual |
|
|
Settings for the Color drop zone for the Grid visual |
|
|
Settings for the Color hierarchy drop zone chip for the Grid visual |
|
|
Settings for the Color measure drop zone chip for the Grid visual |
|
|
Settings for the Cols drop zone chip for the Grid visual |
|
|
Settings for the Cols drop zone for the Grid visual |
|
|
Settings for the Cols hierarchy drop zone chip for the Grid visual |
|
|
Settings for the Cols values drop zone chip for the Grid visual |
|
|
Settings for the Filter drop zone chip for the Grid visual |
|
|
Settings for the Filter drop zone for the Grid visual |
|
|
Settings for the Filter hierarchy drop zone chip for the Grid visual |
|
|
Settings for the Filter values drop zone chip for the Grid visual |
|
|
Settings for the Indicator drop zone for the Grid visual |
|
|
Settings for the Indicator measure drop zone chip for the Grid visual |
|
|
Settings for the Rows drop zone chip for the Grid visual |
|
|
Settings for the Rows drop zone for the Grid visual |
|
|
Settings for the Rows hierarchy drop zone chip for the Grid visual |
|
|
Settings for the Rows values drop zone chip for the Grid visual |
|
|
Settings for the Size drop zone for the Grid visual |
|
|
Settings for the Size measure drop zone chip for the Grid visual |
|
|
Settings for the Tooltip drop zone chip for the Grid visual |
|
|
Settings for the Tooltip drop zone for the Grid visual |
|
|
Settings for the Tooltip hierarchy drop zone chip for the Grid visual |
|
|
Settings for the Tooltip measure drop zone chip for the Grid visual |
|
|
Settings for the Values drop zone for the Grid visual |
|
|
Settings for the Values measure drop zone chip for the Grid visual |
|
|
Settings for the Grid visual |
|
|
Describes the element selection for a given hierarchy |
|
|
Details of the security settings to be applied to a data model's hierarchies or measures. |
|
|
Details of the security settings to be applied to a data model's hierarchies or measures. |
|
|
Metadata overlay of a data model's hierarchy to add. If a property isn't passed then its existing value stays. |
|
|
Hierarchy overlay data to delete. |
|
|
An object containing the details of the Hub template archive. |
|
|
The import content items result object from importing content into the system. |
|
|
The object representing the details for where to import a model PIE file. |
|
|
A generic object used to contain ID of item. |
|
|
The item-parent object used to set the content item's parent item ID. |
|
|
Object with role and role access types. |
|
|
Object with roles and items to be removed. |
|
|
Object with roles and items to be added. |
|
|
The listing of favorite content items for a user. |
|
|
The copy items object with details of the selected content items and the destination folder. |
|
|
The move items object with details of the selected content items and the destination folder. |
|
|
The LDAP group object contains a list of all Active Directory groups. |
|
|
The LDAP/AD group object. |
|
|
The LDAP search object that contains the parameters to be used in Active Directory searches. |
|
|
The LDAP user object contains a list of all Active Directory users. |
|
|
The LDAP search object used to find users in the LDAP directory. |
|
|
Object which represents the total numbers of Pro and Viewer user licenses |
|
|
The Custom List To add. |
|
|
Additional properties for olap sources on calculation. |
|
|
Settings for the Color drop zone chip for the Map visual |
|
|
Settings for the Color drop zone for the Map visual |
|
|
Settings for the Color hierarchy drop zone chip for the Map visual |
|
|
Settings for the Color measure drop zone chip for the Map visual |
|
|
Settings for the Details drop zone for the Map visual |
|
|
Settings for the Details hierarchy drop zone chip for the Map visual |
|
|
Settings for the Filter drop zone for the Map visual |
|
|
Settings for the Filter hierarchy drop zone chip for the Map visual |
|
|
Settings for the Location drop zone chip for the Map visual |
|
|
Settings for the Location drop zone for the Map visual |
|
|
Settings for the Location hierarchy drop zone chip for the Map visual |
|
|
Settings for the Location measure drop zone chip for the Map visual |
|
|
Settings for the Motion drop zone for the Map visual |
|
|
Settings for the Motion hierarchy drop zone chip for the Map visual |
|
|
Settings for the Size drop zone for the Map visual |
|
|
Settings for the Size measure drop zone chip for the Map visual |
|
|
Settings for the Tooltip drop zone chip for the Map visual |
|
|
Settings for the Tooltip drop zone for the Map visual |
|
|
Settings for the Tooltip hierarchy drop zone chip for the Map visual |
|
|
Settings for the Tooltip measure drop zone chip for the Map visual |
|
|
Settings for the Map visual |
|
|
Describes the path of the node in the execution |
|
|
Use this object to find a specific data source |
|
|
Use this object to update model name. |
|
|
The master flow object contains information about the details of a specific master flow or data flow node and the validation message |
|
|
Item in the Progress log of a master flow execution |
|
|
Describes request for the progress logs of masterflow execution |
|
|
The master flow progress update |
|
|
Use this object to update the database schemas used in the data flow. |
|
|
Use this object to modify the data source server and/or the database in a data flow. |
|
|
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 |
|
|
Use this object to modify the data target server and/or the database in a data flow. |
|
|
The master flow target object contains information about the connection of a specific target ETL node and the validation message result |
|
|
The master flow updated list of variables result |
|
|
Validation result, includes list for each validation type object |
|
|
Use this object to modify the data source server ID or/and database name used in the variable connection. |
|
|
The master flow variable object contains information about the connection of a specific variable and the validation message result |
|
|
Use this object to modify a variable's value. |
|
|
List of variables based on a query with all their connection details |
|
|
Use this object to modify the values of a list of variables used in a Master Flow. |
|
|
The object representing the details for where to import a model PIE file. |
|
|
The search results object. |
|
|
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 |
|
|
Metadata overlay of a data model's measure to add. If a property isn't passed then its existing value stays. |
|
|
Measure overlay data to delete. |
|
|
Describe the information about a single member |
|
|
The details of the security settings for the hierarchy's member elements. |
|
|
The details of the security settings for the hierarchy's member elements. |
|
|
Describes translations for metadata |
|
|
Describes the data catalog |
|
|
Info about the source Data Flow used to drive this model |
|
|
The connection string id and the new model process date to be updated. |
|
|
The result from updating a model's process date |
|
|
The model and its details. |
|
|
Details of the model that will be the target of the on-demand execution. |
|
|
A listing of on-demand schedules triggered by the change |
|
|
The default setting for every new column that will be added as a part of the automatic synchronization of the model during the scheduling process. |
|
|
This mapping is been used when a ModelingTable has been defined as an Aggregated Table to determine the link between the aggregated column to the target column / measure |
|
|
Definition of a table column in the model. |
|
|
Model configuration for a specific language. |
|
|
Describes the translations for specific folder |
|
|
Hierarchy definition in the model. A hierarchy is defined by a list of levels, each defined by a column |
|
|
Definition of a hierarchy level in the model definition, contains source column identifier. |
|
|
Definition of a measure in the model definition, contains column unique identifies, aggregation, etc. |
|
|
The model definition that contains details of tables, their relationships and joins, and measures. |
|
|
A property column of another column, example: state could have country as a property |
|
|
Relationship definition used in the models when joining across tables columns. |
|
|
A pair of linked columns used to define a relationship in the model definition. A relationship can be defined by 1 or more pairs. |
|
|
Describe the details about the server that the current model is based on. |
|
|
Table definition in a model, contains table schema, name, columns, etc. |
|
|
Definition of general model translations. other translations are inside the table, column, measure, hierarchy objects |
|
|
Generic API response object with success or failure flag and related messages. |
|
|
Generic API response object with success or failure flag and related messages. |
|
|
The listing of content items object. |
|
|
The query export object used to specify how to extract nlp query results. |
|
|
Describes request for notification indicators. |
|
|
List of notification indicator counts for unread items. |
|
|
Additional setting for OauthDataSources |
|
|
Additional query information for ODBC Direct data source |
|
|
The object representing the details for where to import a PIE file of content. |
|
|
The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied |
|
|
An object that contains the profile definition for pro users. |
|
|
The Profile definition object contains the definition for a user profile. |
|
|
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 |
|
|
The profile-role object contains a list of all roles to add or remove for the specified profile. |
|
|
Data payload with details on the Pulse clients |
|
|
Pyramid Content item object. |
|
|
The item idenifier object. |
|
|
The user object contains all relevant meta-data for the user. |
|
|
The user object contains all relevant meta-data for the user. |
|
|
The query export object used to specify how to extract query results. |
|
|
Advanced Query Features |
|
|
Defines the total settings for the Rows/Columns |
|
|
Represents an item related data |
|
|
The rename object for settings to rename content items. |
|
|
The user object contains all relevant meta-data for the user. |
|
|
The role object contains meta-data for the role. |
|
|
The user object contains all relevant meta-data for the user. |
|
|
The 'minimal' role object contains basic meta-data for the role. |
|
|
The role object with settings to be set for the chosen content item. |
|
|
The role object with settings to be set for the chosen content item. |
|
|
Settings for the Color drop zone chip for the Scatter visual |
|
|
Settings for the Color drop zone for the Scatter visual |
|
|
Settings for the Color hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Color measure drop zone chip for the Scatter visual |
|
|
Settings for the Details drop zone for the Scatter visual |
|
|
Settings for the Details hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Filter drop zone chip for the Scatter visual |
|
|
Settings for the Filter drop zone for the Scatter visual |
|
|
Settings for the Filter hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Filter values drop zone chip for the Scatter visual |
|
|
Settings for the Labels drop zone chip for the Scatter visual |
|
|
Settings for the Labels drop zone for the Scatter visual |
|
|
Settings for the Labels hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Labels measure drop zone chip for the Scatter visual |
|
|
Settings for the Motion drop zone for the Scatter visual |
|
|
Settings for the Motion hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Shape drop zone chip for the Scatter visual |
|
|
Settings for the Shape drop zone for the Scatter visual |
|
|
Settings for the Shape hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Shape measure drop zone chip for the Scatter visual |
|
|
Settings for the Size drop zone for the Scatter visual |
|
|
Settings for the Size measure drop zone chip for the Scatter visual |
|
|
Settings for the Tooltip drop zone chip for the Scatter visual |
|
|
Settings for the Tooltip drop zone for the Scatter visual |
|
|
Settings for the Tooltip hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the Tooltip measure drop zone chip for the Scatter visual |
|
|
Settings for the TrellisHorizontal drop zone chip for the Scatter visual |
|
|
Settings for the TrellisHorizontal drop zone for the Scatter visual |
|
|
Settings for the TrellisHorizontal hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the TrellisHorizontal values drop zone chip for the Scatter visual |
|
|
Settings for the TrellisVertical drop zone chip for the Scatter visual |
|
|
Settings for the TrellisVertical drop zone for the Scatter visual |
|
|
Settings for the TrellisVertical hierarchy drop zone chip for the Scatter visual |
|
|
Settings for the TrellisVertical values drop zone chip for the Scatter visual |
|
|
Settings for the Scatter visual |
|
|
Settings for the XValues drop zone for the Scatter visual |
|
|
Settings for the XValues measure drop zone chip for the Scatter visual |
|
|
Settings for the YValues drop zone for the Scatter visual |
|
|
Settings for the YValues measure drop zone chip for the Scatter visual |
|
|
The search criteria object for finding a schedule. |
|
|
The schedule listing object. |
|
|
The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied |
|
|
An object that contains the profile definition for scientist users. |
|
|
The LDAP search object that contains the parameters to be used in Active Directory searches. |
|
|
The LDAP search object that contains the parameters to be used in Active Directory searches. |
|
|
The search object to be used for providing search settings. |
|
|
Settings for the Color drop zone chip for the Segment visual |
|
|
Settings for the Color drop zone for the Segment visual |
|
|
Settings for the Color hierarchy drop zone chip for the Segment visual |
|
|
Settings for the Color measure drop zone chip for the Segment visual |
|
|
Settings for the Details drop zone for the Segment visual |
|
|
Settings for the Details hierarchy drop zone chip for the Segment visual |
|
|
Settings for the Filter drop zone chip for the Segment visual |
|
|
Settings for the Filter drop zone for the Segment visual |
|
|
Settings for the Filter hierarchy drop zone chip for the Segment visual |
|
|
Settings for the Filter values drop zone chip for the Segment visual |
|
|
Settings for the Labels drop zone chip for the Segment visual |
|
|
Settings for the Labels drop zone for the Segment visual |
|
|
Settings for the Labels hierarchy drop zone chip for the Segment visual |
|
|
Settings for the Labels measure drop zone chip for the Segment visual |
|
|
Settings for the Motion drop zone for the Segment visual |
|
|
Settings for the Motion hierarchy drop zone chip for the Segment visual |
|
|
Settings for the Size drop zone for the Segment visual |
|
|
Settings for the Size measure drop zone chip for the Segment visual |
|
|
Settings for the Tooltip drop zone chip for the Segment visual |
|
|
Settings for the Tooltip drop zone for the Segment visual |
|
|
Settings for the Tooltip hierarchy drop zone chip for the Segment visual |
|
|
Settings for the Tooltip measure drop zone chip for the Segment visual |
|
|
Settings for the TrellisHorizontal drop zone chip for the Segment visual |
|
|
Settings for the TrellisHorizontal drop zone for the Segment visual |
|
|
Settings for the TrellisHorizontal hierarchy drop zone chip for the Segment visual |
|
|
Settings for the TrellisHorizontal values drop zone chip for the Segment visual |
|
|
Settings for the TrellisVertical drop zone chip for the Segment visual |
|
|
Settings for the TrellisVertical drop zone for the Segment visual |
|
|
Settings for the TrellisVertical hierarchy drop zone chip for the Segment visual |
|
|
Settings for the TrellisVertical values drop zone chip for the Segment visual |
|
|
Settings for the Values drop zone for the Segment visual |
|
|
Settings for the Values measure drop zone chip for the Segment visual |
|
|
Settings for the Segment visual |
|
|
The data source server object and its settings. |
|
|
Generic API response object with success or failure flag and related messages. |
|
|
Settings for the Color drop zone chip for the Tabular visual |
|
|
Settings for the Color drop zone for the Tabular visual |
|
|
Settings for the Color hierarchy drop zone chip for the Tabular visual |
|
|
Settings for the Color measure drop zone chip for the Tabular visual |
|
|
Settings for the Cols drop zone chip for the Tabular visual |
|
|
Settings for the Cols drop zone for the Tabular visual |
|
|
Settings for the Cols hierarchy drop zone chip for the Tabular visual |
|
|
Settings for the Cols measure drop zone chip for the Tabular visual |
|
|
Settings for the Filter drop zone for the Tabular visual |
|
|
Settings for the Filter hierarchy drop zone chip for the Tabular visual |
|
|
Settings for the Size drop zone for the Tabular visual |
|
|
Settings for the Size measure drop zone chip for the Tabular visual |
|
|
Settings for the Tooltip drop zone chip for the Tabular visual |
|
|
Settings for the Tooltip drop zone for the Tabular visual |
|
|
Settings for the Tooltip hierarchy drop zone chip for the Tabular visual |
|
|
Settings for the Tooltip measure drop zone chip for the Tabular visual |
|
|
Settings for the Tabular visual |
|
|
The tag object used to capture a tag's settings. |
|
|
The tag usage object used to set a tag for a given content item. |
|
|
The target parameter object used to specify target and its filters for parameterizing queries. |
|
|
The task Log message |
|
|
An object specifying the requested task id and user id . |
|
|
Execution Tasks object with details of a scheduled job task. |
|
|
The tenant license object with its license type. |
|
|
The tenant object. |
|
|
The tenant's miscellaneous settings. |
|
|
The tenant object for fetching users. |
|
|
The theme object holding the definition of a theme. |
|
|
The object of theme ID's and names |
|
|
An object containing theme id and the item ids that should contain this theme. |
|
|
The toggle object to indicate the datasource state in the system. |
|
|
The toggle object to indicate the user state in the system. |
|
|
Defines the total settings of the discover |
|
|
The tenant object for updating tenant seats. |
|
|
The object used to update an AD/LDAP based user. |
|
|
The object used to update a database authentication user. |
|
|
The object used to update a user from search. |
|
|
Represents a user to be updated in the system |
|
|
The object used to update a OpenID user. |
|
|
The object used to update a SAML user. |
|
|
The user credential object used to set a user's login settings. |
|
|
The user credentials for authentication by OpenID parameter map. |
|
|
Describes User Phone details |
|
|
The user-role object contains a list of all roles to add or remove for the specified user. |
|
|
The user credentials for authentication by SAML token. |
|
|
The user credentials for authentication by token. |
|
|
The functional items to be available in the profile as either a list or a sum index bits. The list will take priority if both are supplied |
|
|
An object that contains the profile definition for viewer users. |
|
|
All the dropzones of the visuals by groups |
AddHierarchyOverlayApiObject