Create a metric within a changeset
tip
You can try this workflow with REST API Playground.
Learn more about MicroStrategy REST API Playground here.
This workflow sample demonstrates how to create a metric object through the Modeling service.
tip
An authorization token allows the API layer to hide internal session-related implementations such as managing different project-specific sessions. Once the REST API layer has validated the user's credentials using the specified authentication mode, it initiates a session with the Intelligence server and creates a unique authorization token for the client.
Create a new metric object and name it “Cost Comparison" in the destination folder of 31727EF14E35DAA437B716BA56466585. The project ID is B7CA92F04B9FAE8D941C3E9B7E0CD754.
info
Get the authorization token needed to execute the request with POST /api/auth/login.
Get the project ID from GET /api/projects.
tip
Changesets are used in this workflow. For information on how to create and use changesets, see Changesets.
Create a new metric using POST /api/model/metrics
To create the new Metric , you need to submit the request body with the correct information.
In information, you must enter a name, subType, and destinationFolderID for the metric you want to create.
| Location | Name | Description |
|---|---|---|
| header | X-MSTR-authToken | The authorization token. |
| header | X-MSTR-ProjectID | The project ID. |
| header | X-MSTR-MS-Changeset | The changeset ID. |
| params | showFilterTokens | Specifies whether the "filter" in Metric is returned in "tokens", "text", and "tree" formats. |
| params | showExpressionAs | Omitted, tree, or tokens: - If omitted, the expression is returned in only “text“ formats. - If tree, the expression is returned in "text" and "tree" formats.- If tokens, the expression is returned in "text" and "tokens" formats. |
| params | showAdvancedProperties | Specifies whether the metric’s definition is returned with advanced properties. - If omitted or false, the advanced properties are not returned. - If true, the advanced properties are are returned. |
Sample Request Header:
"accept": "application/json"
"X-MSTR-AuthToken": "bbjpsjos3b7ebokq9jdfvknska"
"X-MSTR-ProjectID": "B7CA92F04B9FAE8D941C3E9B7E0CD754"
"X-MSTR-MS-Changeset": "4E830DF576A24E4B9120455EE576EB51"
"Content-Type": "application/json"
Sample Request Body:
{
"information": {
"destinationFolderId": "1031D6F04D13AE5E24EF08944D5745AD",
"subType": "metric",
"name": "Cost Comparison"
},
"expression": {
"text": "Sum(Cost)",
"tokens": [
{
"level": "resolved",
"state": "initial",
"value": "Sum",
"type": "function",
"target": {
"dateCreated": "2001-01-02T20:47:35.000Z",
"dateModified": "2021-02-26T03:18:40.000Z",
"versionId": "93B1FFD040F7CBECF3C3378D5391AA35",
"primaryLocale": "en-US",
"objectId": "8107C31BDD9911D3B98100C04F2233EA",
"subType": "function",
"name": "Sum",
"description": "Returns the sum of all values in the ValueList. This is a group-value function."
}
},
{
"level": "resolved",
"state": "initial",
"value": "<",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "UseLookupForAttributes",
"type": "identifier"
},
{
"level": "resolved",
"state": "initial",
"value": "=",
"type": "function"
},
{
"level": "resolved",
"state": "initial",
"value": "False",
"type": "boolean"
},
{
"level": "resolved",
"state": "initial",
"value": ">",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "(",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "Cost",
"type": "object_reference",
"target": {
"dateCreated": "2001-09-18T20:21:56.000Z",
"dateModified": "2021-02-26T03:18:52.000Z",
"versionId": "66BBCD784D52223085BBC2BC81EB8F16",
"primaryLocale": "en-US",
"objectId": "7A4ABE9111D5AC6FC000D98A4CC5F24F",
"subType": "fact",
"name": "Cost"
}
},
{
"level": "resolved",
"state": "initial",
"value": ")",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "{",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "~",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "+",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": ",",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "<|",
"type": "other"
},
{
"level": "resolved",
"state": "initial",
"value": "Year",
"type": "object_reference",
"target": {
"dateCreated": "2001-01-02T20:48:10.000Z",
"dateModified": "2021-02-26T03:18:50.000Z",
"versionId": "CF8EEF064DCB3A0CFFC3439EF5ADEE47",
"primaryLocale": "en-US",
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name": "Year"
}
},
{
"level": "resolved",
"state": "initial",
"value": "*",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "}",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "<",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "[Select a Quarter]",
"type": "object_reference",
"target": {
"dateCreated": "2001-10-19T16:59:45.000Z",
"dateModified": "2016-02-02T21:42:28.000Z",
"versionId": "BC17244611E5C05100000080EF75F6D3",
"primaryLocale": "en-US",
"objectId": "E638359211D5C49EC0000C881FDA1A4F",
"subType": "filter",
"name": "Select a Quarter"
}
},
{
"level": "resolved",
"state": "initial",
"value": ";",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "@",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "3",
"type": "integer"
},
{
"level": "resolved",
"state": "initial",
"value": ">",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "|",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "[Last Quarter's]",
"type": "object_reference",
"target": {
"dateCreated": "2001-10-10T13:50:20.000Z",
"dateModified": "2021-02-26T03:18:51.000Z",
"versionId": "28EA303A4A885EC20F1BC3BBD1AACD20",
"primaryLocale": "en-US",
"objectId": "2437C03311D5BD85C000F98A4CC5F24F",
"subType": "role_transformation",
"name": "Last Quarter's",
"description": "Transforms Quarter to Last Quarter, Month to Last Quarter's Month, Day to Last Quarter's Day"
}
},
{
"level": "resolved",
"state": "initial",
"value": "|",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "",
"type": "end_of_text"
}
]
},
"dimty": {
"dimtyUnits": [
{
"dimtyUnitType": "report_base_level",
"aggregation": "normal",
"filtering": "apply",
"groupBy": true
},
{
"dimtyUnitType": "attribute",
"target": {
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name": "Year"
},
"aggregation": "first_in_fact",
"filtering": "absolute",
"groupBy": true
},
{
"dimtyUnitType": "role",
"target": {
"objectId": "2437C03311D5BD85C000F98A4CC5F24F",
"subType": "role_transformation",
"name": "Last Quarter's"
}
}
],
"excludeAttribute": false,
"allowAddingUnit": true
},
"conditionality": {
"filter": {
"objectId": "E638359211D5C49EC0000C881FDA1A4F",
"subType": "filter",
"name": "Select a Quarter"
},
"embedMethod": "metric_into_report_filter",
"removeElements": true
},
"metricSubtotals": [
{
"definition": {
"objectId": "96C487AF4D12472A910C1ACACFB56EFB",
"subType": "system_subtotal",
"name": "Total"
},
"implementation": {
"objectId": "B328C60462634223B2387D4ADABEEB53",
"subType": "system_subtotal",
"name": "Average"
}
},
{
"definition": {
"objectId": "078C50834B484EE29948FA9DD5300ADF",
"subType": "system_subtotal",
"name": "Count"
}
},
{
"definition": {
"objectId": "B328C60462634223B2387D4ADABEEB53",
"subType": "system_subtotal",
"name": "Average"
}
},
{
"definition": {
"objectId": "00B7BFFF967F42C4B71A4B53D90FB095",
"subType": "system_subtotal",
"name": "Minimum"
}
},
{
"definition": {
"objectId": "B1F4AA7DE683441BA559AA6453C5113E",
"subType": "system_subtotal",
"name": "Maximum"
}
},
{
"definition": {
"objectId": "F225147A4CA0BB97368A5689D9675E73",
"subType": "system_subtotal",
"name": "Aggregation"
},
"implementation": {
"objectId": "078C50834B484EE29948FA9DD5300ADF",
"subType": "system_subtotal",
"name": "Count"
}
}
],
"aggregateFromBase": false,
"formulaJoinType": "inner",
"smartTotal": "decomposable_false",
"dataType": { "type": "int64", "precision": 0, "scale": 0 },
"format": {
"header": [
{ "type": "number_category", "value": "0" },
{ "type": "number_decimal_places", "value": "2" },
{ "type": "number_thousand_separator", "value": "true" },
{ "type": "number_currency_symbol", "value": "$" },
{ "type": "number_currency_position", "value": "0" },
{ "type": "number_format", "value": "#,##0.00;(#,##0.00)" },
{ "type": "number_negative_numbers", "value": "3" },
{ "type": "background_fill_color", "value": "3355443" },
{ "type": "background_pattern_style", "value": "1" },
{ "type": "background_fill_style", "value": "0" },
{ "type": "background_gradient_angle", "value": "0" },
{ "type": "background_gradient_x_offset", "value": "0" },
{ "type": "series_fill_style", "value": "0" },
{ "type": "series_fill_color", "value": "8388608" },
{ "type": "series_gradient_angle", "value": "0" },
{ "type": "series_gradient_x_offset", "value": "0" }
],
"values": [
{ "type": "number_category", "value": "0" },
{ "type": "number_decimal_places", "value": "0" },
{ "type": "number_format", "value": "#,##0;(#,##0)" }
]
},
"subtotalFromBase": false,
"columnNameAlias": "test",
"metricFormatType": "reserved",
"thresholds": [],
"advancedProperties": {
"vldbProperties": {
"[AnalyticalEngineProperties].[NullCheckingForAnalyticalEngine]": {
"name": "NullCheckingForAnalyticalEngine",
"type": "int32",
"value": "2",
"resolvedLocation": "default",
"isInherited": true
}
}
}
}
Sample Curl:
curl -X POST \
'http://demo.microstrategy.com/MicroStrategyLibrary/api/model/metrics?showExpressionAs=tree&showAdvancedProperties=true' \
-H 'accept: application/json' \
-H 'X-MSTR-AuthToken: 29as2a20136fma9ebcr4qq5nnj' \
-H 'X-MSTR-MS-Changeset: 68E300BC4B6E43AC98B36AFF03786FB3' \
-H 'Content-Type: application/json' \
-d '{
"information": {
"destinationFolderId": "1031D6F04D13AE5E24EF08944D5745AD",
"subType": "metric",
"name": "Cost Comparison"
},
"expression": {
"text": "Sum(Cost)",
"tokens": [
{
"level": "resolved",
"state": "initial",
"value": "Sum",
"type": "function",
"target": {
"dateCreated": "2001-01-02T20:47:35.000Z",
"dateModified": "2021-02-26T03:18:40.000Z",
"versionId": "93B1FFD040F7CBECF3C3378D5391AA35",
"primaryLocale": "en-US",
"objectId": "8107C31BDD9911D3B98100C04F2233EA",
"subType": "function",
"name": "Sum",
"description": "Returns the sum of all values in the ValueList. This is a group-value function."
}
},
{
"level": "resolved",
"state": "initial",
"value": "<",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "UseLookupForAttributes",
"type": "identifier"
},
{
"level": "resolved",
"state": "initial",
"value": "=",
"type": "function"
},
{
"level": "resolved",
"state": "initial",
"value": "False",
"type": "boolean"
},
{
"level": "resolved",
"state": "initial",
"value": ">",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "(",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "Cost",
"type": "object_reference",
"target": {
"dateCreated": "2001-09-18T20:21:56.000Z",
"dateModified": "2021-02-26T03:18:52.000Z",
"versionId": "66BBCD784D52223085BBC2BC81EB8F16",
"primaryLocale": "en-US",
"objectId": "7A4ABE9111D5AC6FC000D98A4CC5F24F",
"subType": "fact",
"name": "Cost"
}
},
{
"level": "resolved",
"state": "initial",
"value": ")",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "{",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "~",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "+",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": ",",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "<|",
"type": "other"
},
{
"level": "resolved",
"state": "initial",
"value": "Year",
"type": "object_reference",
"target": {
"dateCreated": "2001-01-02T20:48:10.000Z",
"dateModified": "2021-02-26T03:18:50.000Z",
"versionId": "CF8EEF064DCB3A0CFFC3439EF5ADEE47",
"primaryLocale": "en-US",
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name": "Year"
}
},
{
"level": "resolved",
"state": "initial",
"value": "*",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "}",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "<",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "[Select a Quarter]",
"type": "object_reference",
"target": {
"dateCreated": "2001-10-19T16:59:45.000Z",
"dateModified": "2016-02-02T21:42:28.000Z",
"versionId": "BC17244611E5C05100000080EF75F6D3",
"primaryLocale": "en-US",
"objectId": "E638359211D5C49EC0000C881FDA1A4F",
"subType": "filter",
"name": "Select a Quarter"
}
},
{
"level": "resolved",
"state": "initial",
"value": ";",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "@",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "3",
"type": "integer"
},
{
"level": "resolved",
"state": "initial",
"value": ">",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "|",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "[Last Quarter's]",
"type": "object_reference",
"target": {
"dateCreated": "2001-10-10T13:50:20.000Z",
"dateModified": "2021-02-26T03:18:51.000Z",
"versionId": "28EA303A4A885EC20F1BC3BBD1AACD20",
"primaryLocale": "en-US",
"objectId": "2437C03311D5BD85C000F98A4CC5F24F",
"subType": "role_transformation",
"name": "Last Quarter's",
"description": "Transforms Quarter to Last Quarter, Month to Last Quarter's Month, Day to Last Quarter's Day"
}
},
{
"level": "resolved",
"state": "initial",
"value": "|",
"type": "character"
},
{
"level": "resolved",
"state": "initial",
"value": "",
"type": "end_of_text"
}
]
},
"dimty": {
"dimtyUnits": [
{
"dimtyUnitType": "report_base_level",
"aggregation": "normal",
"filtering": "apply",
"groupBy": true
},
{
"dimtyUnitType": "attribute",
"target": {
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name": "Year"
},
"aggregation": "first_in_fact",
"filtering": "absolute",
"groupBy": true
},
{
"dimtyUnitType": "role",
"target": {
"objectId": "2437C03311D5BD85C000F98A4CC5F24F",
"subType": "role_transformation",
"name": "Last Quarter's"
}
}
],
"excludeAttribute": false,
"allowAddingUnit": true
},
"conditionality": {
"filter": {
"objectId": "E638359211D5C49EC0000C881FDA1A4F",
"subType": "filter",
"name": "Select a Quarter"
},
"embedMethod": "metric_into_report_filter",
"removeElements": true
},
"metricSubtotals": [
{
"definition": {
"objectId": "96C487AF4D12472A910C1ACACFB56EFB",
"subType": "system_subtotal",
"name": "Total"
},
"implementation": {
"objectId": "B328C60462634223B2387D4ADABEEB53",
"subType": "system_subtotal",
"name": "Average"
}
},
{
"definition": {
"objectId": "078C50834B484EE29948FA9DD5300ADF",
"subType": "system_subtotal",
"name": "Count"
}
},
{
"definition": {
"objectId": "B328C60462634223B2387D4ADABEEB53",
"subType": "system_subtotal",
"name": "Average"
}
},
{
"definition": {
"objectId": "00B7BFFF967F42C4B71A4B53D90FB095",
"subType": "system_subtotal",
"name": "Minimum"
}
},
{
"definition": {
"objectId": "B1F4AA7DE683441BA559AA6453C5113E",
"subType": "system_subtotal",
"name": "Maximum"
}
},
{
"definition": {
"objectId": "F225147A4CA0BB97368A5689D9675E73",
"subType": "system_subtotal",
"name": "Aggregation"
},
"implementation": {
"objectId": "078C50834B484EE29948FA9DD5300ADF",
"subType": "system_subtotal",
"name": "Count"
}
}
],
"aggregateFromBase": false,
"formulaJoinType": "inner",
"smartTotal": "decomposable_false",
"dataType": {
"type": "int64",
"precision": 0,
"scale": 0
},
"format": {
"header": [
{
"type": "number_category",
"value": "0"
},
{
"type": "number_decimal_places",
"value": "2"
},
{
"type": "number_thousand_separator",
"value": "true"
},
{
"type": "number_currency_symbol",
"value": "$"
},
{
"type": "number_currency_position",
"value": "0"
},
{
"type": "number_format",
"value": "#,##0.00;(#,##0.00)"
},
{
"type": "number_negative_numbers",
"value": "3"
},
{
"type": "background_fill_color",
"value": "3355443"
},
{
"type": "background_pattern_style",
"value": "1"
},
{
"type": "background_fill_style",
"value": "0"
},
{
"type": "background_gradient_angle",
"value": "0"
},
{
"type": "background_gradient_x_offset",
"value": "0"
},
{
"type": "series_fill_style",
"value": "0"
},
{
"type": "series_fill_color",
"value": "8388608"
},
{
"type": "series_gradient_angle",
"value": "0"
},
{
"type": "series_gradient_x_offset",
"value": "0"
}
],
"values": [
{
"type": "number_category",
"value": "0"
},
{
"type": "number_decimal_places",
"value": "0"
},
{
"type": "number_format",
"value": "#,##0;(#,##0)"
}
]
},
"subtotalFromBase": false,
"columnNameAlias": "test",
"metricFormatType": "reserved",
"thresholds": [],
"advancedProperties": {
"vldbProperties": {
"[AnalyticalEngineProperties].[NullCheckingForAnalyticalEngine]": {
"name": "NullCheckingForAnalyticalEngine",
"type": "int32",
"value": "2",
"resolvedLocation": "default",
"isInherited": true
}
}
}
}'
Sample Response Body:
You can view the new metric's definition in the body of the response.
{
"information": {
"versionId": "ABF987FAB5E543E48C18F0501B51BE1C",
"primaryLocale": "en-US",
"objectId": "F7EB9001C876490DAD0F79B00E9B96FE",
"subType": "metric",
"name": "Cost Comparison",
"destinationFolderId": "1031D6F04D13AE5E24EF08944D5745AD"
},
"expression": {
"text": "Sum(Cost)",
"tree": {
"type": "object_reference",
"target": {
"objectId": "B9E3AEAA4D9DF42F6683EB8D7185825C",
"subType": "agg_metric",
"isEmbedded": true
},
"isIndependent": 0
}
},
"dimty": {
"dimtyUnits": [
{
"dimtyUnitType": "report_base_level",
"aggregation": "normal",
"filtering": "apply",
"groupBy": true
},
{
"dimtyUnitType": "attribute",
"target": {
"objectId": "8D679D5111D3E4981000E787EC6DE8A4",
"subType": "attribute",
"name": "Year"
},
"aggregation": "first_in_fact",
"filtering": "absolute",
"groupBy": true
},
{
"dimtyUnitType": "role",
"target": {
"objectId": "2437C03311D5BD85C000F98A4CC5F24F",
"subType": "role_transformation",
"name": "Last Quarter's"
}
}
],
"excludeAttribute": false,
"allowAddingUnit": true
},
"conditionality": {
"filter": {
"objectId": "E638359211D5C49EC0000C881FDA1A4F",
"subType": "filter",
"name": "Select a Quarter"
},
"embedMethod": "metric_into_report_filter",
"removeElements": true
},
"metricSubtotals": [
{
"definition": {
"objectId": "96C487AF4D12472A910C1ACACFB56EFB",
"subType": "system_subtotal",
"name": "Total"
},
"implementation": {
"objectId": "B328C60462634223B2387D4ADABEEB53",
"subType": "system_subtotal",
"name": "Average"
}
},
{
"definition": {
"objectId": "078C50834B484EE29948FA9DD5300ADF",
"subType": "system_subtotal",
"name": "Count"
}
},
{
"definition": {
"objectId": "B328C60462634223B2387D4ADABEEB53",
"subType": "system_subtotal",
"name": "Average"
}
},
{
"definition": {
"objectId": "00B7BFFF967F42C4B71A4B53D90FB095",
"subType": "system_subtotal",
"name": "Minimum"
}
},
{
"definition": {
"objectId": "B1F4AA7DE683441BA559AA6453C5113E",
"subType": "system_subtotal",
"name": "Maximum"
}
},
{
"definition": {
"objectId": "F225147A4CA0BB97368A5689D9675E73",
"subType": "system_subtotal",
"name": "Aggregation"
},
"implementation": {
"objectId": "078C50834B484EE29948FA9DD5300ADF",
"subType": "system_subtotal",
"name": "Count"
}
}
],
"aggregateFromBase": false,
"formulaJoinType": "inner",
"smartTotal": "decomposable_false",
"dataType": { "type": "int64", "precision": 0, "scale": 0 },
"format": {
"header": [
{ "type": "number_category", "value": "0" },
{ "type": "number_decimal_places", "value": "2" },
{ "type": "number_thousand_separator", "value": "true" },
{ "type": "number_currency_symbol", "value": "$" },
{ "type": "number_currency_position", "value": "0" },
{ "type": "number_format", "value": "#,##0.00;(#,##0.00)" },
{ "type": "number_negative_numbers", "value": "3" },
{ "type": "background_fill_color", "value": "3355443" },
{ "type": "background_pattern_style", "value": "1" },
{ "type": "background_fill_style", "value": "0" },
{ "type": "background_gradient_angle", "value": "0" },
{ "type": "background_gradient_x_offset", "value": "0" },
{ "type": "series_fill_style", "value": "0" },
{ "type": "series_fill_color", "value": "8388608" },
{ "type": "series_gradient_angle", "value": "0" },
{ "type": "series_gradient_x_offset", "value": "0" }
],
"values": [
{ "type": "number_category", "value": "0" },
{ "type": "number_decimal_places", "value": "0" },
{ "type": "number_format", "value": "#,##0;(#,##0)" }
]
},
"subtotalFromBase": false,
"columnNameAlias": "test",
"metricFormatType": "reserved",
"thresholds": [],
"advancedProperties": {
"vldbProperties": {
"[AnalyticalEngineProperties].[NullCheckingForAnalyticalEngine]": {
"name": "NullCheckingForAnalyticalEngine",
"type": "int32",
"value": "2",
"resolvedLocation": "default",
"isInherited": true
},
"[AnalyticalEngineProperties].[SubtotalDimensionalityAware]": {
"name": "SubtotalDimensionalityAware",
"type": "boolean",
"value": "true",
"resolvedLocation": "default",
"isInherited": true
},
"[VLDB Function].[Null Check]": {
"name": "Null Check",
"type": "int32",
"value": "2",
"resolvedLocation": "default",
"isInherited": true
},
"[VLDB Function].[Zero Check]": {
"name": "Zero Check",
"type": "int32",
"value": "1",
"resolvedLocation": "default",
"isInherited": true
},
"[VLDB Report].[Count Distinct with Partitions]": {
"name": "Count Distinct with Partitions",
"type": "int32",
"value": "0",
"resolvedLocation": "default",
"isInherited": true
},
"[VLDB Select].[Integer Constant In Metric]": {
"name": "Integer Constant In Metric",
"type": "int32",
"value": "1",
"resolvedLocation": "dbms",
"isInherited": true,
"nextValue": "0",
"nextResolvedLocation": "default"
},
"[VLDB Select].[Metric Join Type]": {
"name": "Metric Join Type",
"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].[Smart Metric Transformation]": {
"name": "Smart Metric Transformation",
"type": "int32",
"value": "0",
"resolvedLocation": "default",
"isInherited": true
},
"[VLDB Select].[Transformable AggMetric]": {
"name": "Transformable AggMetric",
"type": "int32",
"value": "0",
"resolvedLocation": "default",
"isInherited": true
},
"[VLDB Select].[Use Subtotal Dimty for Dynamic Aggregation]": {
"name": "Use Subtotal Dimty for Dynamic Aggregation",
"type": "int32",
"value": "0",
"resolvedLocation": "default",
"isInherited": true
}
}
}
}
Response Code: 201 (A new Metric is created successfully in the changeset.)
The model for the definition of a metric can be updated with the following fields:
| Fields | Name | Description | Data Type | Required? |
|---|---|---|---|---|
| information | name | Name of the metric. This is the most user-friendly value that can be used to identify the metric. | String | Yes |
| destinationFolderId | Folder ID where the new metric is saved. | String | Yes | |
| expression | text | A human readable, but non-parsable text, that describes the expression. | String | No |
| tree | A tree data structure that fully defines the expression. | List<ObjectInfoReference> | No | |
| tokens | A list of parsed tokens. | List<ObjectInfoReference> | No | |
| dimty | dimtyUnits | Dimty contains a list of DimtyUnit, which describes the level that the metric can be calculated. | List<ObjectInfoReference> | No |
| excludeAttribute | If true, exclude attributes absent in report or level. If false, do not exclude. | Boolean | No | |
| allowAddingUnit | This setting allows other users to add extra units to this definition. | Boolean | No | |
| prompt | This points to the level prompt. | ObjectInfoReference | No | |
| conditionality | filter | The reference to a filter. | ObjectInfoReference | No |
| prompt | The reference to an object prompt. | ObjectInfoReference | No | |
| embedMethod | Indicates the embedding method for the filter with report filter. | EnumDSSEmbedMethod | No | |
| removeElements | Indicates whether to remove related report filter elements. Enter true to remove. | Boolean | No | |
| metricSubtotals | definition | An object reference that references to the subtotal object. | ObjectInfoReference | Yes, if metricSubtotals is provided . |
| implementation | When the total subtotal function is set to one object, this field will reference to that object only when the definition field references to Total. When the dynamic aggregation function is set to one object, this field will reference to that object only when the definition field references to Aggregation. For subtotals except Total and Aggregation, this field should be empty. | ObjectInfoReference | No | |
| aggregateFromBase | aggregateFromBase | Indicates the aggregation type. Enter true to aggregate from base. | Boolean | No |
| FormulaJoinType | formulaJoinType | Indicates formula join type with three options: Default, Inner, or Outer | String | No |
| data type | type | Indicates the data type. | String | No |
| precision | Indicates the precision. | Integer | No | |
| scale | Indicates the scale. | Integer | No | |
| smartTotal | smartTotal | Indicates the calculation type of total. | String | No |
| format | format | Contains the header format and value format. | Format | No |
| subtotalFromBase | subtotalFromBase | Indicates the subtotal type. Enter true to subtotal from base. | Boolean | No |
| columnNameAlias | columnNameAlias | This name is used in SQL generation. | String | No |
| metricFormatType | metricFormatType | Indicates the metric format type. | String | No |
| thresholds | format | A list of FormatProperty that defines the format. | List<FormatProperty> | No |
| condition | The filter expression for the threshold. | Expression | Yes, if thresholds is provided. | |
| name | The name of the threshold. | String | No | |
| replaceText | The text used to replace the metric value. | String | No | |
| semantics | Indicates the semantics used by the threshold. | EnumDSSBaseFormType | No | |
| scope | Indicates the scope applied by the threshold. | EnumDSSBaseFormType | No | |
| enable | A boolean value that indicates whether this threshold is enabled. | Boolean | No | |
| advancedProperties | vldbProperties | The VLDB Properties that are applicable to metric and their values. | LinkedHashMap<String, PropertyWithValue> | No |
info
objectID, dateCreated, dateModified, and versionId are generated automatically. Currently, only en-US is available for primaryLocale.