Get the list of applicable properties for a given metric
GET {{baseUrl}}/api/model/metrics/:metricId/applicableAdvancedProperties
The response returns the definition of a single metric. The project ID is required to return a metric's definition in metadata.
The changeset ID is required to return a metric's definition within a specific changeset.
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. The 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.
Body
PARAM
| Key | Datatype | Required | Description |
showSqlPreview
|
null | 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 | Project ID | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
status OK
| {
"propertyCount": 11,
"applicableProperties": {
"[VLDB Function].[Null Check]": {
"name": "Null Check",
"groupId": 2,
"groupName": "Metrics",
"maxValue": 2,
"displayType": "options",
"displayName": "Null Check",
"showSqlPreview": true,
"options": [
{
"value": "Do nothing",
"sqlPreview": "\n \n create table TEMP1 as\n select a21.STORE_NBR STORE_NBR,\n (sum(a21.REG_SLS_DLR) + sum(a21.PML_SLS_DLR)) TOT_SLS,\n sum(a21.PML_SLS_DLR) PRM_DLR\n from Curl curl -X GET 'baseUrl/api/model/metrics/:metricId/applicableAdvancedProperties?showSqlPreview=' -H 'X-MSTR-AuthToken: authToken' -H 'X-MSTR-ProjectID: projectId' -H 'X-MSTR-MS-Changeset: rd_changesetId' ENDPOINTS |