MicroStrategy REST API API Documentation
Get the list of applicable properties for a specific datamart through Modeling service
GET {{baseUrl}}/api/model/datamarts/:datamartId/applicableVldbProperties
StartFragment Get the list of applicable properties for a specific datamart. The list is returned based on datamart's subtype. The datamart's subtype must be normal or customsqlfree_form, an error is thrown otherwise. Internationalized fields will be based on user's displayLocale from MicroStrategy Library session. EndFragmen
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
X-MSTR-ProjectID
|
string | (Required) Project ID |
RESPONSES
status OK
| {
"propertyCount": 30,
"applicableProperties": {
"[VLDB Select].[Allow Cartesian Join]": {
"name": "Allow Cartesian Join",
"groupId": 1,
"groupName": "Joins",
"maxValue": 2,
"displayType": "options",
"displayName": "Cartesian Join Governing",
"showSqlPreview": true,
"options": [
{
"value": "Choosing this option keeps the backward compatibility with MicroStrategy 2019 where SQL queries are governed by \"Cartesian Join Warning\" VLDB setting.",
"sqlPreview": "OBSOLETE - Keep backward compatibility with MicroStrategy 2019."
},
{
"value": "Cancel execution of cartesian join for SQL, MDX, In-Memory queries.",
"sqlPreview": "This VLDB setting only works for Data Engine Version 2020 or above. Choosing this option disallows cross join execution for SQL, MDX and In-Memory queries."
},
{
"value": "Execute cartesian join for SQL, MDX, In-Memory queries.",
"sqlPreview": "This VLDB setting only works for Data Engine Version 2020 or above. Choosing this option allows cross join execution for SQL, MDX and In-Memory queries."
}
],
"type": "int32",
"defaultValue": 0
},
"[VLDB Report].[Drop Database Connection]": {
"name": "Drop Database Connection",
"groupId": 3,
"groupName": "Pre/Post Statements",
"maxValue": 1,
"displayType": "options",
"displayName": "Drop Database Connection after running user defined SQL",
"showSqlPreview": false,
"options": [
{
"value": "Enable",
"sqlPreview": ""
},
{
"value": "Disable",
"sqlPreview": ""
}
],
"type": "int32",
"defaultValue": 0
},
"[VLDB Report].[Report PostStatement 1]": {
"name": "Report PostStatement 1",
"groupId": 3,
"groupName": "Pre/Post Statements",
"displayType": "n_line_text_box",
"displayName": "Report Post Stateme Curl curl -X GET 'baseUrl/api/model/datamarts/:datamartId/applicableVldbProperties' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' ENDPOINTS |