Get the list of applicable properties for a given datasource.

GET {{baseUrl}}/api/model/datasources/:datasourceId/applicableAdvancedProperties?showSqlPreview=true

Returns the list of applicable properties for a given datasource object. The list is based on datasources's type and it's database type. For MDX datasource type, an additional filtering check on object's XDAType is being performed.

The project ID in the header is required to return the datasource's applicable properties in metadata. The changeset ID is required to return a datasource's applicable properties 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

KeyDatatypeRequiredDescription
showSqlPreviewbooleanBoolean value used to determine whether to show dynamic SQL preview or not.
Set to true by default.

HEADERS

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization Token
X-MSTR-ProjectIDstringProject ID
X-MSTR-MS-ChangesetstringChangeset ID
Acceptstring

RESPONSES

status: OK

{"propertyCount":188,"applicableProperties":{},"sqlDynamicPreview":"Example Ommitted"}