API Enumeration Definitions

Enumerations used in API Methods

Enumerations

AccessType

Role access types.

AdminType

The administration level of a user

AggregationType

Used to set or change the summation logic used on columns presented in the data model

AnalystPermissionOptions

Bit switches for analyst user profiles. Certain switch combinations can be mutually exclusive.

ApiResponseFormat

Query result data structure types for export.

AxisTotalsType

The type of totals column/row

BulkWritingType

Describes the write type for Synapse

BwDatabaseListType

Configure which type of Database ('info-provider') listing technique to use

BwInfoAreaTreeViewType

Configures the SAP BW server instance to support different views in the databases panel

CartesianBarVisualType

The type of graphical chart or visualization used as the primary or secondary axis of the bar chart

CartesianColumnVisualType

The type of graphical chart or visualization used as the primary or secondary axis of the column charts

CartesianLineVisualType

The type of graphical chart or visualization used as the primary or secondary axis of the line charts

CartesianStackedBarVisualType

The type of graphical chart or visualization used as the primary or secondary axis of the stacked bar charts

CartesianStackedColumnVisualType

The type of graphical chart or visualization used as the primary or secondary axis of the stacked column charts

CartesianVisualType

The type of graphical chart or visualization used in the Discover report for the Cartesian visual

ClashDefaultOption

Clash default option is the operation neededed to be taken when items of the same name are encountered.

ClientLicenseType

The user license type enumeration.

ColorMathFunction

Describes the logic that drives the calculation of the drop zone chip

ConditionConjunctionType

logical operators

ConnectionStringType

The data source server type enumeration.

ContentItemObject

The Content Item type.

ContentType

The item content type

ContentTypeObject

Content type enumeration.

CsvDelimiter

The Csv delimiter for Csv outputs

CubeAuthMethod

Determines which type of end-user authentication to use when connecting to destination server

CustomRootCAType

Defines options to use as a custom Root Certificate Authority for the trust validation of SSL certificates

DataFlowModelType

The model type: Virtual Model or MS Tabular model

DataType

The type of data

DomainAdminPermissionType

Domain Admin permission types.

ElementSelectionDataType

The types of selection that is made: member elements or lists/sets

EtlSyncModelColumnsType

Model columns synchronization type

FilterHierarchyType

The type of filter for hierarchy chip

FilterValuesType

The type of filter for values chip

FirstWorkday

The first weekly working day for scheduling. Set on tenant.

FtpDataMode

FTP transfer mode - active or passive

FtpSecurityType

FTP channel encryption type: unsecure, explicit or implicit

GaType

Google Analytics type

GridColorOption

The location for the color chip

HideMemberType

When to hide a member in a hierarchy

HierarchyCategory

Predefined categories for hierarchies (none/date/geo location/person)

HierarchyOverlayProperty

Predefined hierarchy overlay properties

HierarchyType

Type of the modeling hierarchy: Drill path, parent-child tree, regular

IsolationMode

See https://learn.microsoft.com/en-us/sql/mdx/mdx-data-definition-create-member?view=sql-server-ver16#scope for details

ItemType

The item type

JoinType

The type of join used in relationships of a data model (inner, right outer, left outer, full outer, or cross join)

KpiAttributeType

Describes in what capacity the measure is connected to its parent KPI

LanguageType

The user language enumeration.

LdapSearchType

The LDAP search type.

LicenseStatus

License status enumeration.

MapVisualType

The type of graphical chart or visualization used in the Discover report for the Map visual

MaskingMethodType

Masking column method: how do display values of masked columns to the user

MaterializedItemType

The type of materialized model or data item.

MeasureFormat

Predefined measure overlay format string

MeasureMapOptions

The type of geolocation chip

MeasureOverlayProperty

Predefined measure overlay properties

ModelAttributeType

Attribute type

ModelingColumnCategories

Predefined categories for modeling columns

ModelingColumnType

Column type: regular database table (identified by column and table name) or a calculated column expression

ModelingTableType

Table type: regular database table (identified by schema and table name) or a custom query

MsOlapConnectionType

Configure the manner in which the SSAS server is configured to receive connections

OpenIdAuthType

OpenId Provider type

OperatorType

Describe the operator that will drive the comparison between two values

PaperType

ParentChildOrphans

How orphan nodes will be handled

ParentChildRollupType

How will a member's value be calculated

PermissionBitIndex

Bit switches for user profiles. Certain switch combinations can be mutually exclusive.

PrintingOutputType

The result type of the printing process

ProPermissionOptions

Bit switches for pro user profiles. Certain switch combinations can be mutually exclusive.

QueryCacheMode

Cache options for the next re-query

QueryTotalPosition

The position of totaling that can be enabled in a Discover report

RoleAssignment

The enumeration of role assignment approaches.

RoleAssignmentType

The enumeration of role assignment approaches.

RootFolderType

An item 'Root' path node

SapBwServerConnectionType

Configure what type of SAP BW server to connect to

ScatterVisualType

The type of graphical chart or visualization used in the Discover report for the Scatter visual

ScheduleDataType

Determines the schedule recurrence configuration

ScheduleStatus

The schedule's status

ScheduleType

Schedule type enumeration.

ScientistPermissionOptions

Bit switches for scientist user profiles. Certain switch combinations can be mutually exclusive.

SearchMatchType

Search type enumeration

SearchRootFolderType

The type of root folder.

SecurityType

The active directory provider type.

SegmentVisualType

The type of graphical chart or visualization used in the Discover report for the Segment visual

ServerAuthenticationMethod

The data source security type enumeration.

ServerEffectiveUserName

The user's effective name type

ServiceStatus

The service status enumeration.

SizeDropZoneOptions

Describes the possible options for the size dropzone

SizeMathFunction

Describes the possible mathematical option for the size dropzone

SparkTransportMode

transportMode parameter for SparkSQL JDBC connection

SyntaxType

Member unique name standard

TagType

Enumeration of tag types.

TaskStatus

A schedule's task status.

UpdateSchemaValidation

Define whether to check if the new schema exists within this data source, before changing the schema.

UserProfileType

User profile types

UserStatus

The user's status flag.

ValidRootFolderType

The type of root folder.

ValuesDropZoneOptions

Describes the possible options for the values dropzone

VariableType

The type of variable

ViewerPermissionOptions

Bit switches for viewer user profiles. Certain switch combinations can be mutually exclusive.