Read advanced property of a project

GET {{baseUrl}}/api/model/projects/:projectId?showAdvancedProperties=true

This API gets the definition of a specified project and the list of its advanced properties. The information field describes the common object information such as the object ID, creation time, version ID, etc. showAdvancedProperties=true query parameter is mandatory for the API to return the list of advanced properties.

The project ID in the header is required to return the project's definition in metadata. The changeset ID is required to return the project's definition within a specific changeset, otherwise it's optional. To execute the request, either the project ID or changeset ID needs to be provided. If both are provided, only the changeset ID is used.

A changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.

Request Params

The advanced properties are presented in the following groups:

• "vldbProperties": A list of properties as determined by the common infrastructure.

If omitted or false the API will return information field only.

If true, all applicable advanced properties are returned. |

HEADERS

RESPONSES

status: OK

{"information":{"dateCreated":"2015-06-30T21:55:35.000Z","dateModified":"2022-12-19T23:07:54.875Z","versionId":"C83C0E5B94428B913BD0A99330072A43","acg":255,"primaryLocale":"en-US","objectId":"B7CA92F04B9FAE8D941C3E9B7E0CD754","subType":"project","name":"MicroStrategy Tutorial","description":"MicroStrategy Tutorial project and application set designed to illustrate the platform's rich functionality. The theme is an Electronics, Books, Movies and Music store. Employees, Inventory, Finance, Product Sales and Suppliers are analyzed."},"advancedProperties":{"vldbProperties":{"[AnalyticalEngineProperties].[ConsolidationSubtotal]":{"name":"ConsolidationSubtotal","type":"boolean","value":"true","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[CustomGroupDisplayForJointElments]":{"name":"CustomGroupDisplayForJointElments","type":"boolean","value":"false","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[DisplayNullOnTop]":{"name":"DisplayNullOnTop","type":"boolean","value":"false","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[DisplayNullReplace]":{"name":"DisplayNullReplace","type":"boolean","value":"false","resolvedLocation":"project","isInherited":false,"nextValue":"false","nextResolvedLocation":"default"},"[AnalyticalEngineProperties].[DisplayNullReplaceValue]":{"name":"DisplayNullReplaceValue","type":"double","value":"0.0","resolvedLocation":"project","isInherited":false,"nextValue":"0.0","nextResolvedLocation":"default"},"[AnalyticalEngineProperties].[EvaluationOrdering]":{"name":"EvaluationOrdering","type":"int32","value":"2","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[FilteringOnStringValues]":{"name":"FilteringOnStringValues","type":"boolean","value":"true","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[HideNullZeroValues]":{"name":"HideNullZeroValues","type":"int32","value":"2","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[MetricLevelDetermination]":{"name":"MetricLevelDetermination","type":"boolean","value":"false","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[NotCalculatedDisplay]":{"name":"NotCalculatedDisplay","type":"string","value":"--","resolvedLocation":"project","isInherited":false,"nextValue":"--","nextResolvedLocation":"default"},"[AnalyticalEngineProperties].[NullCheckingForAnalyticalEngine]":{"name":"NullCheckingForAnalyticalEngine","type":"int32","value":"2","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[RemoveMissingUnits]":{"name":"RemoveMissingUnits","type":"boolean","value":"true","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[ShowAllRows]":{"name":"ShowAllRows","type":"boolean","value":"true","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[SingleSourceGrid]":{"name":"SingleSourceGrid","type":"boolean","value":"false","resolvedLocation":"default","isInherited":true},"[AnalyticalEngineProperties].[SubtotalDimensionalityAware]":{"name":"SubtotalDimensionalityAware","type":"boolean","value":"true","resolvedLocation":"default","isInherited":true},"[ExportProperties].[AttributeIDsForRemovingDummyElements]":{"name":"AttributeIDsForRemovingDummyElements","type":"string","value":"","resolvedLocation":"default","isInherited":true},"[MDX Syntax].[MDX MultiPass Parallel Execution]":{"name":"MDX MultiPass Parallel Execution","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[MDX Syntax].[MDX Property Key Date Format]":{"name":"MDX Property Key Date Format","type":"string","value":"DD.MM.YYYY","resolvedLocation":"default","isInherited":true},"[MDX Syntax].[MDX Where Clause]":{"name":"MDX Where Clause","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[System Objects Version].[AEVersion]":{"name":"AEVersion","type":"int32","value":"14","resolvedLocation":"project","isInherited":false,"nextValue":"10","nextResolvedLocation":"default"},"[VLDB Function].[Missing Display]":{"name":"Missing Display","type":"string","value":"","resolvedLocation":"default","isInherited":true},"[VLDB Function].[Null Display]":{"name":"Null Display","type":"string","value":",","resolvedLocation":"project","isInherited":false,"nextValue":"","nextResolvedLocation":"default"},"[VLDB Report].[Autocommit]":{"name":"Autocommit","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Report].[Filter on selection behavior for standard and OLAP Reports]":{"name":"Filter on selection behavior for standard and OLAP Reports","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Report].[Incremental Data Transfer]":{"name":"Incremental Data Transfer","type":"int32","value":"1","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Aggregation Tables Problems]":{"name":"Aggregation Tables Problems","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Allow Cartesian Join]":{"name":"Allow Cartesian Join","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Apply Filter Options for queries against in-memory datasets]":{"name":"Apply Filter Options for queries against in-memory datasets","type":"int32","value":"1","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Cube Parse Log Enabled in SQL View for Dynamic Sourcing]":{"name":"Cube Parse Log Enabled in SQL View for Dynamic Sourcing","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Cube Reuse for Ad Hoc For Current Cube Enabled]":{"name":"Cube Reuse for Ad Hoc For Current Cube Enabled","type":"int32","value":"1","resolvedLocation":"project","isInherited":false,"nextValue":"0","nextResolvedLocation":"default"},"[VLDB Select].[Cube Reuse for Ad Hoc For Current Report Enabled]":{"name":"Cube Reuse for Ad Hoc For Current Report Enabled","type":"int32","value":"1","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Cube Safe For Reuse For Ad Hoc Reports]":{"name":"Cube Safe For Reuse For Ad Hoc Reports","type":"int32","value":"0","resolvedLocation":"project","isInherited":false,"nextValue":"0","nextResolvedLocation":"default"},"[VLDB Select].[Do Case Insensitive Comparison for Strings in Filters]":{"name":"Do Case Insensitive Comparison for Strings in Filters","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Extended Mismatch Log Enabled in SQL View for Dynamic Sourcing]":{"name":"Extended Mismatch Log Enabled in SQL View for Dynamic Sourcing","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Filter tree optimization for metric qualifications]":{"name":"Filter tree optimization for metric qualifications","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Join Across Datasets]":{"name":"Join Across Datasets","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Max Parallel SQLs Per Report]":{"name":"Max Parallel SQLs Per Report","type":"int32","value":"2","resolvedLocation":"default","isInherited":true},"[VLDB Select].[MCE Join To Get Data Combination]":{"name":"MCE Join To Get Data Combination","type":"int32","value":"1","resolvedLocation":"project","isInherited":false,"nextValue":"0","nextResolvedLocation":"default"},"[VLDB Select].[Mismatch Log Enabled in SQL View for Dynamic Sourcing]":{"name":"Mismatch Log Enabled in SQL View for Dynamic Sourcing","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Multiple data sources: Heterogeneous Database or Gateway]":{"name":"Multiple data sources: Heterogeneous Database or Gateway","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Multisource database instance selection option]":{"name":"Multisource database instance selection option","type":"int32","value":"0","resolvedLocation":"project","isInherited":false,"nextValue":"0","nextResolvedLocation":"default"},"[VLDB Select].[No Nulls All In Lookup In Attribute For Cube Reuse]":{"name":"No Nulls All In Lookup In Attribute For Cube Reuse","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[No Nulls In Metric For Cube Reuse]":{"name":"No Nulls In Metric For Cube Reuse","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Parallel SQL Execution]":{"name":"Parallel SQL Execution","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[PSE Improvement in SQLView]":{"name":"PSE Improvement in SQLView","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Report Parse Log Enabled in SQL View for Dynamic Sourcing]":{"name":"Report Parse Log Enabled in SQL View for Dynamic Sourcing","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Select].[Smart Metric Transformation]":{"name":"Smart Metric Transformation","type":"int32","value":"0","resolvedLocation":"default","isInherited":true},"[VLDB Syntax].[Quoting Behavior]":{"name":"Quoting Behavior","type":"int32","value":"1","resolvedLocation":"default","isInherited":true}}}}