Logo
MicroStrategy REST API API Documentation

Get the list of applicable properties for a given incremental refresh report.

GET {{baseUrl}}/api/model/incrementalRefresh/:incrementalRefreshReportId/applicableVldbProperties

Get the list of applicable properties for a given object. The list is returned based on object's xda type and report type. The object's subtype must be IRR, an error is thrown otherwise. InstanceId header is needed for unsaved objects so they can be retrieved from the instance. Internationalized fields will be based on user's displayLocale from MicroStrategy Library session.

 

Body PARAM

Key Datatype Required Description 
showSqlPreview
boolean Boolean value used to determine whether to show dynamic SQL preview or not. Set to true by default.



HEADERS

Key Datatype Required Description 
X-MSTR-AuthToken
string (Required) Authorization Token
X-MSTR-ProjectID
string (Required) Project ID
Accept
string




RESPONSES

status OK

{ "propertyCount": 175, "applicableProperties": {}, "sqlDynamicPreview": "[VLDB Report].[Session Based PreStatement]\n[VLDB Report].[Report PreStatement 1]\n[VLDB Report].[Report PreStatement 2]\n[VLDB Report].[Report PreStatement 3]\n[VLDB Report].[Report PreStatement 4]\n[VLDB Report].[Report PreStatement 5]\n\n[VLDB Create].[Table PreStatement 1]\n[VLDB Create].[Table PreStatement 2]\n[VLDB Create].[Table PreStatement 3]\n[VLDB Create].[Table PreStatement 4]\n[VLDB Create].[Table PreStatement 5]\n\ncreate [VLDB Create].[Table Qualifier] table [VLDB Create].[Table Descriptor] [VLDB Create].[Table Prefix] TABLENAME [VLDB Create].[Table\nOption] (ATTRIBUTE_COL1 VARCHAR(20) [VLDB Create].[Attribute ID Constraint] , FORM_COL2 CHAR(20), [Attribute non-ID Constraint] FACT_COL3\nFLOAT) [VLDB Create].[Table Space]\nprimary index (ATTRIBUTE_COL1, FORM_COL2) [VLDB Create].[Create PostString]\n\n[VLDB Insert].[Insert PreStatement 1]\n[VLDB Insert].[Insert PreStatement 2]\n[VLDB Insert].[I
Curl
curl -X GET 'baseUrl/api/model/incrementalRefresh/:incrementalRefreshReportId/applicableVldbProperties?showSqlPreview=true' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'Accept: application/json'

ENDPOINTS