@astrato-io/visualizations 0.0.0-stage → 0.6.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +23 -0
- package/LICENSE +93 -0
- package/README.md +843 -2
- package/THIRD_PARTY_NOTICES.md +8477 -0
- package/VISUALIZATION_DEFINITIONS.md +2378 -0
- package/chunks/ClickAwayListener-BbeNMAvj.js +52 -0
- package/chunks/LinearProgress-B1FeWaen.js +253 -0
- package/chunks/accessors-DemrDevR.js +128 -0
- package/chunks/app-filter-bar.compiler-BGJ7HAbr.js +64 -0
- package/chunks/bar.compiler-CT0ZbQKc.js +374 -0
- package/chunks/builder-B6dWSIdD.js +12289 -0
- package/chunks/color-settings-ZIvgNTq1.js +10 -0
- package/chunks/coloring-B1XAfg6b.js +664 -0
- package/chunks/debounce-fn-CUixuz45.js +7 -0
- package/chunks/definitions-D3OVqmXl.js +2102 -0
- package/chunks/escobar-eDjtGpkC.js +34606 -0
- package/chunks/events-WZut5Ow6.js +4 -0
- package/chunks/extend-BKUkc4_i.js +37 -0
- package/chunks/filter.compiler-DBsyRBJt.js +70 -0
- package/chunks/filtering-tqjAyJH5.js +1072 -0
- package/chunks/grouping-type-On4s9Thj.js +3 -0
- package/chunks/handlers-VTBfIZYZ.js +13072 -0
- package/chunks/isEqual-BDxAhUo8.js +7514 -0
- package/chunks/line.compiler-CzdM5Ld0.js +198 -0
- package/chunks/metadata-BGElBy5Z.js +28 -0
- package/chunks/number.compiler-G-R7y16P.js +53 -0
- package/chunks/operations-CTNUX6Sy.js +26249 -0
- package/chunks/range-CiwTbMig.js +22 -0
- package/chunks/registry-CsQQzukD.js +920 -0
- package/chunks/requirements-DYjZCFyf.js +6 -0
- package/chunks/rolldown-runtime-DleVn1XH.js +28 -0
- package/chunks/set-coloring-datafield-B3uIS1Pe.js +8 -0
- package/chunks/shared-CBvcC5YV.js +1218 -0
- package/chunks/src-BOS6SqkZ.js +67 -0
- package/chunks/src-D9XogOrc.js +422 -0
- package/chunks/standalone-0M4HlmDW2.js +3944 -0
- package/chunks/standalone-0ashe9w1.js +411 -0
- package/chunks/standalone-B7jax8wa.js +339 -0
- package/chunks/standalone-BK0VYU-l.js +463 -0
- package/chunks/standalone-BMIbT1b2.js +4619 -0
- package/chunks/standalone-BZV5vOwA.js +6 -0
- package/chunks/standalone-BhDrWj4p.js +1980 -0
- package/chunks/standalone-BtSHCp2U2.js +673 -0
- package/chunks/standalone-BvaKdky9.js +344 -0
- package/chunks/standalone-BwtM31-f.js +2 -0
- package/chunks/standalone-C3gg736V.js +1129 -0
- package/chunks/standalone-CC1VUjO32.js +299 -0
- package/chunks/standalone-C_rYnZ0N.js +741 -0
- package/chunks/standalone-CoLrAxRV.js +13198 -0
- package/chunks/standalone-DC-aUgXC.js +3855 -0
- package/chunks/standalone-DCtRoTWg.js +675 -0
- package/chunks/standalone-DUDFTBqL.js +833 -0
- package/chunks/standalone-DhZkX9Td.js +2 -0
- package/chunks/standalone-DtLElfuM.js +512 -0
- package/chunks/standalone-G9Q4Uczu.js +726 -0
- package/chunks/standalone-JuLF-OoH.js +1762 -0
- package/chunks/standalone-_DeX21JJ.js +383 -0
- package/chunks/standalone-gFhKZh8m.js +179 -0
- package/chunks/standalone-tDNy-SFH.js +281 -0
- package/chunks/standalone-v1oxfU20.js +68 -0
- package/chunks/standalone-vzBY6q0I2.js +140 -0
- package/chunks/stroke-dash-UgMEcCS4.js +6 -0
- package/chunks/table.compiler-tb914oj3.js +222 -0
- package/chunks/typeof-CJDtcySz.js +13 -0
- package/chunks/ui-DQWtv2iM.js +63551 -0
- package/chunks/url-utils-B17gj_mr.js +5501 -0
- package/chunks/useFieldName-BvdcoJRl.js +7 -0
- package/chunks/utils-Bg7K-t6K.js +32379 -0
- package/chunks/view-Bn83C8d9.js +12466 -0
- package/definitions.js +3 -0
- package/docs/operations/astrato-app-filter-bar.md +161 -0
- package/docs/operations/bar.md +6968 -0
- package/docs/operations/combo.md +5804 -0
- package/docs/operations/date-picker.md +644 -0
- package/docs/operations/distribution-gauge.md +3082 -0
- package/docs/operations/dot.md +5570 -0
- package/docs/operations/filter.md +1483 -0
- package/docs/operations/gauge.md +3316 -0
- package/docs/operations/heatMap.md +5944 -0
- package/docs/operations/histogram.md +1856 -0
- package/docs/operations/iframe.md +56 -0
- package/docs/operations/image.md +177 -0
- package/docs/operations/index.md +46 -0
- package/docs/operations/line.md +6391 -0
- package/docs/operations/number.md +3903 -0
- package/docs/operations/pie.md +5956 -0
- package/docs/operations/radar.md +4566 -0
- package/docs/operations/sankey.md +3088 -0
- package/docs/operations/scatter.md +5969 -0
- package/docs/operations/shape.md +315 -0
- package/docs/operations/simpleTextObject.md +699 -0
- package/docs/operations/slider.md +220 -0
- package/docs/operations/table.md +8800 -0
- package/docs/operations/tree.md +2867 -0
- package/docs/operations/treemap.md +3527 -0
- package/docs/operations/waterfall.md +2928 -0
- package/docs/operations/word-cloud.md +3000 -0
- package/getters.js +18 -0
- package/index.js +1183 -0
- package/metadata.js +20 -0
- package/operations.js +64 -0
- package/package.json +185 -4
- package/src/definitions/index.d.ts +2 -0
- package/src/definitions/model/definitions/available-fields.d.ts +35 -0
- package/src/definitions/model/definitions/compilers/compile.d.ts +7 -0
- package/src/definitions/model/definitions/data-item-resolution.d.ts +19 -0
- package/src/definitions/model/definitions/descriptors/descriptor-metadata.d.ts +1341 -0
- package/src/definitions/model/definitions/descriptors/json-schema.d.ts +2 -0
- package/src/definitions/model/definitions/diagnostics.d.ts +5 -0
- package/src/definitions/model/definitions/field-suggestions.d.ts +2 -0
- package/src/definitions/model/definitions/index.d.ts +23 -0
- package/src/definitions/model/definitions/registry/compile.d.ts +2 -0
- package/src/definitions/model/definitions/registry/descriptor-registry.d.ts +3 -0
- package/src/definitions/model/definitions/schema-registry.d.ts +660 -0
- package/src/definitions/model/definitions/schemas/app-filter-bar.schema.d.ts +22 -0
- package/src/definitions/model/definitions/schemas/bar.schema.d.ts +73 -0
- package/src/definitions/model/definitions/schemas/broad-chart.schema.d.ts +68 -0
- package/src/definitions/model/definitions/schemas/common.schema.d.ts +303 -0
- package/src/definitions/model/definitions/schemas/filter.schema.d.ts +22 -0
- package/src/definitions/model/definitions/schemas/index.d.ts +9 -0
- package/src/definitions/model/definitions/schemas/line.schema.d.ts +72 -0
- package/src/definitions/model/definitions/schemas/number.schema.d.ts +21 -0
- package/src/definitions/model/definitions/schemas/object.schema.d.ts +215 -0
- package/src/definitions/model/definitions/schemas/table.schema.d.ts +458 -0
- package/src/definitions/model/definitions/types/compilation.types.d.ts +36 -0
- package/src/definitions/model/definitions/types/definition.types.d.ts +2 -0
- package/src/definitions/model/definitions/types/descriptor.types.d.ts +39 -0
- package/src/definitions/model/definitions/types/index.d.ts +3 -0
- package/src/definitions/model/definitions/validation.d.ts +3 -0
- package/src/getters/index.d.ts +30 -0
- package/src/index.d.ts +4 -0
- package/src/metadata/index.d.ts +4 -0
- package/src/operations/index.d.ts +30 -0
- package/src/registry/index.d.ts +6 -0
- package/src/runtime/index.d.ts +2 -0
- package/src/types.d.ts +307 -0
- package/src/visualization-catalog.d.ts +82 -0
- package/src/web-components/index.d.ts +12 -0
- package/styles.css +2 -0
|
@@ -0,0 +1,4566 @@
|
|
|
1
|
+
<!-- Generated from operation manifests. Do not edit this file manually. -->
|
|
2
|
+
|
|
3
|
+
# `radar` operations
|
|
4
|
+
|
|
5
|
+
Reference for `@astrato-io/visualizations@0.6.5`.
|
|
6
|
+
|
|
7
|
+
[All visualization types](./index.md)
|
|
8
|
+
|
|
9
|
+
Use each schema below for the request’s `payload`, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.
|
|
10
|
+
|
|
11
|
+
## Available operations
|
|
12
|
+
|
|
13
|
+
- [`addColoringOverwrite`](#addcoloringoverwrite)
|
|
14
|
+
- [`addDimension`](#adddimension)
|
|
15
|
+
- [`addMeasure`](#addmeasure)
|
|
16
|
+
- [`addMeasureAdvancedAdditionalDimensionDataField`](#addmeasureadvancedadditionaldimensiondatafield)
|
|
17
|
+
- [`addMeasureAdvancedDimensionDataField`](#addmeasureadvanceddimensiondatafield)
|
|
18
|
+
- [`addMeasureFilter`](#addmeasurefilter)
|
|
19
|
+
- [`addResultFilter`](#addresultfilter)
|
|
20
|
+
- [`changeMeasureAggregation`](#changemeasureaggregation)
|
|
21
|
+
- [`clearMeasureFilter`](#clearmeasurefilter)
|
|
22
|
+
- [`clearResultFilter`](#clearresultfilter)
|
|
23
|
+
- [`duplicateDimension`](#duplicatedimension)
|
|
24
|
+
- [`duplicateMeasure`](#duplicatemeasure)
|
|
25
|
+
- [`removeColoringOverwrite`](#removecoloringoverwrite)
|
|
26
|
+
- [`removeDimension`](#removedimension)
|
|
27
|
+
- [`removeMeasure`](#removemeasure)
|
|
28
|
+
- [`removeMeasureAdvancedAdditionalDimensionDataField`](#removemeasureadvancedadditionaldimensiondatafield)
|
|
29
|
+
- [`removeMeasureAdvancedCompareMeasure`](#removemeasureadvancedcomparemeasure)
|
|
30
|
+
- [`removeMeasureAdvancedDimensionDataField`](#removemeasureadvanceddimensiondatafield)
|
|
31
|
+
- [`resetChartPaletteToThemeDefault`](#resetchartpalettetothemedefault)
|
|
32
|
+
- [`setAnimationEnabled`](#setanimationenabled)
|
|
33
|
+
- [`setChartPalette`](#setchartpalette)
|
|
34
|
+
- [`setColoringColor`](#setcoloringcolor)
|
|
35
|
+
- [`setColoringOverwrites`](#setcoloringoverwrites)
|
|
36
|
+
- [`setColoringPersistentColors`](#setcoloringpersistentcolors)
|
|
37
|
+
- [`setColoringSortOrder`](#setcoloringsortorder)
|
|
38
|
+
- [`setColoringType`](#setcoloringtype)
|
|
39
|
+
- [`setCustomPaletteColors`](#setcustompalettecolors)
|
|
40
|
+
- [`setDimensionFormatString`](#setdimensionformatstring)
|
|
41
|
+
- [`setDimensionFormatType`](#setdimensionformattype)
|
|
42
|
+
- [`setDimensionTemporalGrouping`](#setdimensiontemporalgrouping)
|
|
43
|
+
- [`setLegendEnabled`](#setlegendenabled)
|
|
44
|
+
- [`setLegendItemLabelFill`](#setlegenditemlabelfill)
|
|
45
|
+
- [`setLegendItemLabelFontSize`](#setlegenditemlabelfontsize)
|
|
46
|
+
- [`setLegendItemLabelLimitCharacters`](#setlegenditemlabellimitcharacters)
|
|
47
|
+
- [`setLegendItemLabelMaxGlyphCount`](#setlegenditemlabelmaxglyphcount)
|
|
48
|
+
- [`setLegendPosition`](#setlegendposition)
|
|
49
|
+
- [`setLegendTitle`](#setlegendtitle)
|
|
50
|
+
- [`setMeasureAdvancedAdditionalAggregation`](#setmeasureadvancedadditionalaggregation)
|
|
51
|
+
- [`setMeasureAdvancedAggregation`](#setmeasureadvancedaggregation)
|
|
52
|
+
- [`setMeasureAdvancedCalculationType`](#setmeasureadvancedcalculationtype)
|
|
53
|
+
- [`setMeasureAdvancedCompareMeasure`](#setmeasureadvancedcomparemeasure)
|
|
54
|
+
- [`setMeasureAdvancedComparisonType`](#setmeasureadvancedcomparisontype)
|
|
55
|
+
- [`setMeasureAdvancedDense`](#setmeasureadvanceddense)
|
|
56
|
+
- [`setMeasureAdvancedDimensionsIds`](#setmeasureadvanceddimensionsids)
|
|
57
|
+
- [`setMeasureAdvancedGroupType`](#setmeasureadvancedgrouptype)
|
|
58
|
+
- [`setMeasureAdvancedNonTimePeriod`](#setmeasureadvancednontimeperiod)
|
|
59
|
+
- [`setMeasureAdvancedNonTimePeriodGranularity`](#setmeasureadvancednontimeperiodgranularity)
|
|
60
|
+
- [`setMeasureAdvancedNullIfNotEnoughValues`](#setmeasureadvancednullifnotenoughvalues)
|
|
61
|
+
- [`setMeasureAdvancedOffset`](#setmeasureadvancedoffset)
|
|
62
|
+
- [`setMeasureAdvancedParameter`](#setmeasureadvancedparameter)
|
|
63
|
+
- [`setMeasureAdvancedPercentileApprox`](#setmeasureadvancedpercentileapprox)
|
|
64
|
+
- [`setMeasureAdvancedPercentileContinuous`](#setmeasureadvancedpercentilecontinuous)
|
|
65
|
+
- [`setMeasureAdvancedPercentileValue`](#setmeasureadvancedpercentilevalue)
|
|
66
|
+
- [`setMeasureAdvancedPeriodsPerYear`](#setmeasureadvancedperiodsperyear)
|
|
67
|
+
- [`setMeasureAdvancedRangesComparisonEnabled`](#setmeasureadvancedrangescomparisonenabled)
|
|
68
|
+
- [`setMeasureAdvancedRangesComparisonFirstRangeEnd`](#setmeasureadvancedrangescomparisonfirstrangeend)
|
|
69
|
+
- [`setMeasureAdvancedRangesComparisonFirstRangeStart`](#setmeasureadvancedrangescomparisonfirstrangestart)
|
|
70
|
+
- [`setMeasureAdvancedRangesComparisonSecondRangeEnd`](#setmeasureadvancedrangescomparisonsecondrangeend)
|
|
71
|
+
- [`setMeasureAdvancedRangesComparisonSecondRangeStart`](#setmeasureadvancedrangescomparisonsecondrangestart)
|
|
72
|
+
- [`setMeasureAdvancedRangesComparisonType`](#setmeasureadvancedrangescomparisontype)
|
|
73
|
+
- [`setMeasureAdvancedRankSortDirection`](#setmeasureadvancedranksortdirection)
|
|
74
|
+
- [`setMeasureAdvancedSortingOrder`](#setmeasureadvancedsortingorder)
|
|
75
|
+
- [`setMeasureAdvancedStandardDeviations`](#setmeasureadvancedstandarddeviations)
|
|
76
|
+
- [`setMeasureAdvancedWindowBegin`](#setmeasureadvancedwindowbegin)
|
|
77
|
+
- [`setMeasureAdvancedWindowEnd`](#setmeasureadvancedwindowend)
|
|
78
|
+
- [`setMeasureCurrency`](#setmeasurecurrency)
|
|
79
|
+
- [`setMeasureCurrencyIsPrefix`](#setmeasurecurrencyisprefix)
|
|
80
|
+
- [`setMeasureDefinedParameter`](#setmeasuredefinedparameter)
|
|
81
|
+
- [`setMeasureFilter`](#setmeasurefilter)
|
|
82
|
+
- [`setMeasureFormatString`](#setmeasureformatstring)
|
|
83
|
+
- [`setMeasureFormatType`](#setmeasureformattype)
|
|
84
|
+
- [`setMeasureNegativeType`](#setmeasurenegativetype)
|
|
85
|
+
- [`setResultFilter`](#setresultfilter)
|
|
86
|
+
- [`setSortingDirection`](#setsortingdirection)
|
|
87
|
+
- [`setSortingEnabled`](#setsortingenabled)
|
|
88
|
+
- [`setStaticFilterGroup`](#setstaticfiltergroup)
|
|
89
|
+
- [`toggleDimension`](#toggledimension)
|
|
90
|
+
- [`toggleDimensionOrMeasureByName`](#toggledimensionormeasurebyname)
|
|
91
|
+
- [`toggleMeasure`](#togglemeasure)
|
|
92
|
+
- [`updateDimension`](#updatedimension)
|
|
93
|
+
- [`updateMeasure`](#updatemeasure)
|
|
94
|
+
|
|
95
|
+
## `addColoringOverwrite`
|
|
96
|
+
|
|
97
|
+
Add value color
|
|
98
|
+
|
|
99
|
+
Append one value color, eg. color the dimension value "Happy" dark teal. Value colors take priority over the coloring type and palette, so they apply whatever setColoringType is set to. An existing entry for the same dimension, operator and value is replaced. Earlier entries win when several match. Requires at least two enabled dimensions; with fewer, only removing value colors (including an empty list) is accepted.
|
|
100
|
+
|
|
101
|
+
**Payload schema**
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
106
|
+
"anyOf": [
|
|
107
|
+
{
|
|
108
|
+
"type": "object",
|
|
109
|
+
"properties": {
|
|
110
|
+
"dimension": {
|
|
111
|
+
"description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension",
|
|
112
|
+
"type": "object",
|
|
113
|
+
"properties": {
|
|
114
|
+
"dataItemInternalKey": {
|
|
115
|
+
"type": "string",
|
|
116
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
117
|
+
},
|
|
118
|
+
"dataItemUniqueSignature": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
124
|
+
"additionalProperties": false
|
|
125
|
+
},
|
|
126
|
+
"color": {
|
|
127
|
+
"type": "string",
|
|
128
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
129
|
+
"description": "Color applied when the condition matches, eg. \"#0F766E\""
|
|
130
|
+
},
|
|
131
|
+
"operator": {
|
|
132
|
+
"description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
|
|
133
|
+
"type": "string",
|
|
134
|
+
"enum": ["equals", "contains", "startsWith", "endsWith", "greater", "less", "greater-equals", "less-equals"]
|
|
135
|
+
},
|
|
136
|
+
"value": {
|
|
137
|
+
"description": "Value to compare against",
|
|
138
|
+
"type": ["string", "number"]
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
"required": ["color", "value"],
|
|
142
|
+
"additionalProperties": false
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"type": "object",
|
|
146
|
+
"properties": {
|
|
147
|
+
"dimension": {
|
|
148
|
+
"description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension",
|
|
149
|
+
"type": "object",
|
|
150
|
+
"properties": {
|
|
151
|
+
"dataItemInternalKey": {
|
|
152
|
+
"type": "string",
|
|
153
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
154
|
+
},
|
|
155
|
+
"dataItemUniqueSignature": {
|
|
156
|
+
"type": "string",
|
|
157
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
161
|
+
"additionalProperties": false
|
|
162
|
+
},
|
|
163
|
+
"color": {
|
|
164
|
+
"type": "string",
|
|
165
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
166
|
+
"description": "Color applied when the condition matches, eg. \"#0F766E\""
|
|
167
|
+
},
|
|
168
|
+
"operator": {
|
|
169
|
+
"type": "string",
|
|
170
|
+
"const": "between",
|
|
171
|
+
"description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)"
|
|
172
|
+
},
|
|
173
|
+
"value": {
|
|
174
|
+
"description": "Lower bound of the range",
|
|
175
|
+
"type": ["string", "number"]
|
|
176
|
+
},
|
|
177
|
+
"secondValue": {
|
|
178
|
+
"description": "Upper bound of the range",
|
|
179
|
+
"type": ["string", "number"]
|
|
180
|
+
}
|
|
181
|
+
},
|
|
182
|
+
"required": ["color", "operator", "value", "secondValue"],
|
|
183
|
+
"additionalProperties": false
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"type": "object",
|
|
187
|
+
"properties": {
|
|
188
|
+
"dimension": {
|
|
189
|
+
"description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension",
|
|
190
|
+
"type": "object",
|
|
191
|
+
"properties": {
|
|
192
|
+
"dataItemInternalKey": {
|
|
193
|
+
"type": "string",
|
|
194
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
195
|
+
},
|
|
196
|
+
"dataItemUniqueSignature": {
|
|
197
|
+
"type": "string",
|
|
198
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
202
|
+
"additionalProperties": false
|
|
203
|
+
},
|
|
204
|
+
"color": {
|
|
205
|
+
"type": "string",
|
|
206
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
207
|
+
"description": "Color applied when the condition matches, eg. \"#0F766E\""
|
|
208
|
+
},
|
|
209
|
+
"operator": {
|
|
210
|
+
"type": "string",
|
|
211
|
+
"enum": ["inList", "notInList"],
|
|
212
|
+
"description": "Match (inList) or exclude (notInList) every value in values"
|
|
213
|
+
},
|
|
214
|
+
"values": {
|
|
215
|
+
"minItems": 1,
|
|
216
|
+
"type": "array",
|
|
217
|
+
"items": {
|
|
218
|
+
"type": ["string", "number"]
|
|
219
|
+
},
|
|
220
|
+
"description": "Values to match"
|
|
221
|
+
},
|
|
222
|
+
"delimiter": {
|
|
223
|
+
"description": "Separator the values are stored with; defaults to \",\". No value may contain it",
|
|
224
|
+
"type": "string",
|
|
225
|
+
"minLength": 1
|
|
226
|
+
}
|
|
227
|
+
},
|
|
228
|
+
"required": ["color", "operator", "values"],
|
|
229
|
+
"additionalProperties": false
|
|
230
|
+
}
|
|
231
|
+
],
|
|
232
|
+
"title": "Add coloring overwrite schema"
|
|
233
|
+
}
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## `addDimension`
|
|
237
|
+
|
|
238
|
+
Add dimension
|
|
239
|
+
|
|
240
|
+
Add a new dimension to the chart
|
|
241
|
+
|
|
242
|
+
**Payload schema**
|
|
243
|
+
|
|
244
|
+
```json
|
|
245
|
+
{
|
|
246
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
247
|
+
"type": "object",
|
|
248
|
+
"properties": {
|
|
249
|
+
"key": {
|
|
250
|
+
"type": "string",
|
|
251
|
+
"description": "Engine key of the field to be added as a dimension, eg. \"[Cars].[Horsepower]\""
|
|
252
|
+
}
|
|
253
|
+
},
|
|
254
|
+
"required": ["key"],
|
|
255
|
+
"additionalProperties": false,
|
|
256
|
+
"title": "Add dimension schema"
|
|
257
|
+
}
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
## `addMeasure`
|
|
261
|
+
|
|
262
|
+
Add measure
|
|
263
|
+
|
|
264
|
+
Add a new measure to the chart
|
|
265
|
+
|
|
266
|
+
**Payload schema**
|
|
267
|
+
|
|
268
|
+
```json
|
|
269
|
+
{
|
|
270
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
271
|
+
"oneOf": [
|
|
272
|
+
{
|
|
273
|
+
"type": "object",
|
|
274
|
+
"properties": {
|
|
275
|
+
"sourceKind": {
|
|
276
|
+
"type": "string",
|
|
277
|
+
"const": "field",
|
|
278
|
+
"description": "Raw database field from available data `fields`."
|
|
279
|
+
},
|
|
280
|
+
"key": {
|
|
281
|
+
"type": "string",
|
|
282
|
+
"description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
|
|
283
|
+
},
|
|
284
|
+
"aggregation": {
|
|
285
|
+
"type": "string",
|
|
286
|
+
"description": "Required for raw database fields. Use one of the aggregation names returned for that field."
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
"required": ["sourceKind", "key", "aggregation"],
|
|
290
|
+
"additionalProperties": false
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
"type": "object",
|
|
294
|
+
"properties": {
|
|
295
|
+
"sourceKind": {
|
|
296
|
+
"type": "string",
|
|
297
|
+
"const": "measure",
|
|
298
|
+
"description": "Predefined/user-defined measure from available data `measures`."
|
|
299
|
+
},
|
|
300
|
+
"key": {
|
|
301
|
+
"type": "string",
|
|
302
|
+
"description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
|
|
303
|
+
}
|
|
304
|
+
},
|
|
305
|
+
"required": ["sourceKind", "key"],
|
|
306
|
+
"additionalProperties": false
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
"type": "object",
|
|
310
|
+
"properties": {
|
|
311
|
+
"sourceKind": {
|
|
312
|
+
"type": "string",
|
|
313
|
+
"const": "calculation",
|
|
314
|
+
"description": "Predefined calculation from available data `measures`."
|
|
315
|
+
},
|
|
316
|
+
"key": {
|
|
317
|
+
"type": "string",
|
|
318
|
+
"description": "Engine key of the item to be added as a measure, eg. \"[Cars].[Horsepower]\""
|
|
319
|
+
}
|
|
320
|
+
},
|
|
321
|
+
"required": ["sourceKind", "key"],
|
|
322
|
+
"additionalProperties": false
|
|
323
|
+
}
|
|
324
|
+
],
|
|
325
|
+
"title": "Add measure schema"
|
|
326
|
+
}
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
## `addMeasureAdvancedAdditionalDimensionDataField`
|
|
330
|
+
|
|
331
|
+
Add advanced bottom dimension
|
|
332
|
+
|
|
333
|
+
Add bottom dimension field for nested ratio advanced calculation
|
|
334
|
+
|
|
335
|
+
**Payload schema**
|
|
336
|
+
|
|
337
|
+
```json
|
|
338
|
+
{
|
|
339
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
340
|
+
"type": "object",
|
|
341
|
+
"properties": {
|
|
342
|
+
"dataItemInternalKey": {
|
|
343
|
+
"type": "string",
|
|
344
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
345
|
+
},
|
|
346
|
+
"dataItemUniqueSignature": {
|
|
347
|
+
"type": "string",
|
|
348
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
349
|
+
},
|
|
350
|
+
"collectionKey": {
|
|
351
|
+
"description": "Measure collection key",
|
|
352
|
+
"type": "string",
|
|
353
|
+
"enum": ["measures", "supportingMeasures"]
|
|
354
|
+
},
|
|
355
|
+
"advancedOperationKey": {
|
|
356
|
+
"description": "Advanced operation key",
|
|
357
|
+
"type": "string",
|
|
358
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
359
|
+
},
|
|
360
|
+
"key": {
|
|
361
|
+
"type": "string",
|
|
362
|
+
"description": "Engine key of the bottom dimension field to be added"
|
|
363
|
+
}
|
|
364
|
+
},
|
|
365
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
|
|
366
|
+
"additionalProperties": false,
|
|
367
|
+
"title": "Add measure advanced additional dimension field schema"
|
|
368
|
+
}
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
## `addMeasureAdvancedDimensionDataField`
|
|
372
|
+
|
|
373
|
+
Add advanced additional dimension
|
|
374
|
+
|
|
375
|
+
Add additional dimension field for nested advanced calculations
|
|
376
|
+
|
|
377
|
+
**Payload schema**
|
|
378
|
+
|
|
379
|
+
```json
|
|
380
|
+
{
|
|
381
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
382
|
+
"type": "object",
|
|
383
|
+
"properties": {
|
|
384
|
+
"dataItemInternalKey": {
|
|
385
|
+
"type": "string",
|
|
386
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
387
|
+
},
|
|
388
|
+
"dataItemUniqueSignature": {
|
|
389
|
+
"type": "string",
|
|
390
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
391
|
+
},
|
|
392
|
+
"collectionKey": {
|
|
393
|
+
"description": "Measure collection key",
|
|
394
|
+
"type": "string",
|
|
395
|
+
"enum": ["measures", "supportingMeasures"]
|
|
396
|
+
},
|
|
397
|
+
"advancedOperationKey": {
|
|
398
|
+
"description": "Advanced operation key",
|
|
399
|
+
"type": "string",
|
|
400
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
401
|
+
},
|
|
402
|
+
"key": {
|
|
403
|
+
"type": "string",
|
|
404
|
+
"description": "Engine key of the dimension field to be added"
|
|
405
|
+
}
|
|
406
|
+
},
|
|
407
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "key"],
|
|
408
|
+
"additionalProperties": false,
|
|
409
|
+
"title": "Add measure advanced dimension field schema"
|
|
410
|
+
}
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
## `addMeasureFilter`
|
|
414
|
+
|
|
415
|
+
Add measure filter
|
|
416
|
+
|
|
417
|
+
Add another measure filter before aggregation. Keeps existing filters.
|
|
418
|
+
|
|
419
|
+
**Payload schema**
|
|
420
|
+
|
|
421
|
+
```json
|
|
422
|
+
{
|
|
423
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
424
|
+
"anyOf": [
|
|
425
|
+
{
|
|
426
|
+
"type": "object",
|
|
427
|
+
"properties": {
|
|
428
|
+
"measureName": {
|
|
429
|
+
"type": "string",
|
|
430
|
+
"description": "Visible measure name or label"
|
|
431
|
+
},
|
|
432
|
+
"fieldKey": {
|
|
433
|
+
"type": "string",
|
|
434
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
435
|
+
},
|
|
436
|
+
"operator": {
|
|
437
|
+
"type": "string",
|
|
438
|
+
"enum": [
|
|
439
|
+
"equals",
|
|
440
|
+
"doesNotEqual",
|
|
441
|
+
"greaterThan",
|
|
442
|
+
"lessThan",
|
|
443
|
+
"greaterThanOrEqualTo",
|
|
444
|
+
"lessThanOrEqualTo",
|
|
445
|
+
"contains",
|
|
446
|
+
"excludes",
|
|
447
|
+
"like",
|
|
448
|
+
"notLike",
|
|
449
|
+
"startsWith",
|
|
450
|
+
"endsWith"
|
|
451
|
+
],
|
|
452
|
+
"description": "Filter operator that requires a value"
|
|
453
|
+
},
|
|
454
|
+
"value": {
|
|
455
|
+
"anyOf": [
|
|
456
|
+
{
|
|
457
|
+
"type": "string"
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"type": "object",
|
|
461
|
+
"properties": {
|
|
462
|
+
"type": {
|
|
463
|
+
"type": "string",
|
|
464
|
+
"const": "variable"
|
|
465
|
+
},
|
|
466
|
+
"variableName": {
|
|
467
|
+
"type": "string"
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
"required": ["type", "variableName"],
|
|
471
|
+
"additionalProperties": false
|
|
472
|
+
}
|
|
473
|
+
],
|
|
474
|
+
"description": "Filter value"
|
|
475
|
+
}
|
|
476
|
+
},
|
|
477
|
+
"required": ["measureName", "fieldKey", "operator", "value"],
|
|
478
|
+
"additionalProperties": false
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
"type": "object",
|
|
482
|
+
"properties": {
|
|
483
|
+
"measureName": {
|
|
484
|
+
"type": "string",
|
|
485
|
+
"description": "Visible measure name or label"
|
|
486
|
+
},
|
|
487
|
+
"fieldKey": {
|
|
488
|
+
"type": "string",
|
|
489
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
490
|
+
},
|
|
491
|
+
"operator": {
|
|
492
|
+
"type": "string",
|
|
493
|
+
"enum": ["isBetween", "isNotBetween"],
|
|
494
|
+
"description": "Filter operator that requires valueFrom and valueTo"
|
|
495
|
+
},
|
|
496
|
+
"valueFrom": {
|
|
497
|
+
"anyOf": [
|
|
498
|
+
{
|
|
499
|
+
"type": "string"
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"type": "object",
|
|
503
|
+
"properties": {
|
|
504
|
+
"type": {
|
|
505
|
+
"type": "string",
|
|
506
|
+
"const": "variable"
|
|
507
|
+
},
|
|
508
|
+
"variableName": {
|
|
509
|
+
"type": "string"
|
|
510
|
+
}
|
|
511
|
+
},
|
|
512
|
+
"required": ["type", "variableName"],
|
|
513
|
+
"additionalProperties": false
|
|
514
|
+
}
|
|
515
|
+
],
|
|
516
|
+
"description": "Lower filter value"
|
|
517
|
+
},
|
|
518
|
+
"valueTo": {
|
|
519
|
+
"anyOf": [
|
|
520
|
+
{
|
|
521
|
+
"type": "string"
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"type": "object",
|
|
525
|
+
"properties": {
|
|
526
|
+
"type": {
|
|
527
|
+
"type": "string",
|
|
528
|
+
"const": "variable"
|
|
529
|
+
},
|
|
530
|
+
"variableName": {
|
|
531
|
+
"type": "string"
|
|
532
|
+
}
|
|
533
|
+
},
|
|
534
|
+
"required": ["type", "variableName"],
|
|
535
|
+
"additionalProperties": false
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
"description": "Upper filter value"
|
|
539
|
+
}
|
|
540
|
+
},
|
|
541
|
+
"required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
|
|
542
|
+
"additionalProperties": false
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"type": "object",
|
|
546
|
+
"properties": {
|
|
547
|
+
"measureName": {
|
|
548
|
+
"type": "string",
|
|
549
|
+
"description": "Visible measure name or label"
|
|
550
|
+
},
|
|
551
|
+
"fieldKey": {
|
|
552
|
+
"type": "string",
|
|
553
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
554
|
+
},
|
|
555
|
+
"operator": {
|
|
556
|
+
"type": "string",
|
|
557
|
+
"enum": ["inList", "excludedFromList"],
|
|
558
|
+
"description": "Filter operator that requires a list of values"
|
|
559
|
+
},
|
|
560
|
+
"values": {
|
|
561
|
+
"minItems": 1,
|
|
562
|
+
"type": "array",
|
|
563
|
+
"items": {
|
|
564
|
+
"type": "string"
|
|
565
|
+
},
|
|
566
|
+
"description": "Filter values"
|
|
567
|
+
}
|
|
568
|
+
},
|
|
569
|
+
"required": ["measureName", "fieldKey", "operator", "values"],
|
|
570
|
+
"additionalProperties": false
|
|
571
|
+
},
|
|
572
|
+
{
|
|
573
|
+
"type": "object",
|
|
574
|
+
"properties": {
|
|
575
|
+
"measureName": {
|
|
576
|
+
"type": "string",
|
|
577
|
+
"description": "Visible measure name or label"
|
|
578
|
+
},
|
|
579
|
+
"fieldKey": {
|
|
580
|
+
"type": "string",
|
|
581
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
582
|
+
},
|
|
583
|
+
"operator": {
|
|
584
|
+
"type": "string",
|
|
585
|
+
"enum": ["isNull", "notNull"],
|
|
586
|
+
"description": "Filter operator that does not require values"
|
|
587
|
+
}
|
|
588
|
+
},
|
|
589
|
+
"required": ["measureName", "fieldKey", "operator"],
|
|
590
|
+
"additionalProperties": false
|
|
591
|
+
}
|
|
592
|
+
],
|
|
593
|
+
"description": "Add another measure filter before aggregation. Keeps existing filters.",
|
|
594
|
+
"title": "Add measure filter schema"
|
|
595
|
+
}
|
|
596
|
+
```
|
|
597
|
+
|
|
598
|
+
## `addResultFilter`
|
|
599
|
+
|
|
600
|
+
Add result filter
|
|
601
|
+
|
|
602
|
+
Add another result filter after aggregation. Keeps existing result filters.
|
|
603
|
+
|
|
604
|
+
**Payload schema**
|
|
605
|
+
|
|
606
|
+
```json
|
|
607
|
+
{
|
|
608
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
609
|
+
"anyOf": [
|
|
610
|
+
{
|
|
611
|
+
"type": "object",
|
|
612
|
+
"properties": {
|
|
613
|
+
"measureName": {
|
|
614
|
+
"type": "string",
|
|
615
|
+
"description": "Visible measure name or label"
|
|
616
|
+
},
|
|
617
|
+
"operator": {
|
|
618
|
+
"type": "string",
|
|
619
|
+
"enum": [
|
|
620
|
+
"equals",
|
|
621
|
+
"doesNotEqual",
|
|
622
|
+
"greaterThan",
|
|
623
|
+
"lessThan",
|
|
624
|
+
"greaterThanOrEqualTo",
|
|
625
|
+
"lessThanOrEqualTo",
|
|
626
|
+
"contains",
|
|
627
|
+
"excludes",
|
|
628
|
+
"like",
|
|
629
|
+
"notLike",
|
|
630
|
+
"startsWith",
|
|
631
|
+
"endsWith"
|
|
632
|
+
],
|
|
633
|
+
"description": "Filter operator that requires a value"
|
|
634
|
+
},
|
|
635
|
+
"value": {
|
|
636
|
+
"anyOf": [
|
|
637
|
+
{
|
|
638
|
+
"type": "string"
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"type": "object",
|
|
642
|
+
"properties": {
|
|
643
|
+
"type": {
|
|
644
|
+
"type": "string",
|
|
645
|
+
"const": "variable"
|
|
646
|
+
},
|
|
647
|
+
"variableName": {
|
|
648
|
+
"type": "string"
|
|
649
|
+
}
|
|
650
|
+
},
|
|
651
|
+
"required": ["type", "variableName"],
|
|
652
|
+
"additionalProperties": false
|
|
653
|
+
}
|
|
654
|
+
],
|
|
655
|
+
"description": "Filter value"
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
"required": ["measureName", "operator", "value"],
|
|
659
|
+
"additionalProperties": false
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"type": "object",
|
|
663
|
+
"properties": {
|
|
664
|
+
"measureName": {
|
|
665
|
+
"type": "string",
|
|
666
|
+
"description": "Visible measure name or label"
|
|
667
|
+
},
|
|
668
|
+
"operator": {
|
|
669
|
+
"type": "string",
|
|
670
|
+
"enum": ["isBetween", "isNotBetween"],
|
|
671
|
+
"description": "Filter operator that requires valueFrom and valueTo"
|
|
672
|
+
},
|
|
673
|
+
"valueFrom": {
|
|
674
|
+
"anyOf": [
|
|
675
|
+
{
|
|
676
|
+
"type": "string"
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"type": "object",
|
|
680
|
+
"properties": {
|
|
681
|
+
"type": {
|
|
682
|
+
"type": "string",
|
|
683
|
+
"const": "variable"
|
|
684
|
+
},
|
|
685
|
+
"variableName": {
|
|
686
|
+
"type": "string"
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
"required": ["type", "variableName"],
|
|
690
|
+
"additionalProperties": false
|
|
691
|
+
}
|
|
692
|
+
],
|
|
693
|
+
"description": "Lower filter value"
|
|
694
|
+
},
|
|
695
|
+
"valueTo": {
|
|
696
|
+
"anyOf": [
|
|
697
|
+
{
|
|
698
|
+
"type": "string"
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"type": "object",
|
|
702
|
+
"properties": {
|
|
703
|
+
"type": {
|
|
704
|
+
"type": "string",
|
|
705
|
+
"const": "variable"
|
|
706
|
+
},
|
|
707
|
+
"variableName": {
|
|
708
|
+
"type": "string"
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
"required": ["type", "variableName"],
|
|
712
|
+
"additionalProperties": false
|
|
713
|
+
}
|
|
714
|
+
],
|
|
715
|
+
"description": "Upper filter value"
|
|
716
|
+
}
|
|
717
|
+
},
|
|
718
|
+
"required": ["measureName", "operator", "valueFrom", "valueTo"],
|
|
719
|
+
"additionalProperties": false
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"type": "object",
|
|
723
|
+
"properties": {
|
|
724
|
+
"measureName": {
|
|
725
|
+
"type": "string",
|
|
726
|
+
"description": "Visible measure name or label"
|
|
727
|
+
},
|
|
728
|
+
"operator": {
|
|
729
|
+
"type": "string",
|
|
730
|
+
"enum": ["inList", "excludedFromList"],
|
|
731
|
+
"description": "Filter operator that requires a list of values"
|
|
732
|
+
},
|
|
733
|
+
"values": {
|
|
734
|
+
"minItems": 1,
|
|
735
|
+
"type": "array",
|
|
736
|
+
"items": {
|
|
737
|
+
"type": "string"
|
|
738
|
+
},
|
|
739
|
+
"description": "Filter values"
|
|
740
|
+
}
|
|
741
|
+
},
|
|
742
|
+
"required": ["measureName", "operator", "values"],
|
|
743
|
+
"additionalProperties": false
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"type": "object",
|
|
747
|
+
"properties": {
|
|
748
|
+
"measureName": {
|
|
749
|
+
"type": "string",
|
|
750
|
+
"description": "Visible measure name or label"
|
|
751
|
+
},
|
|
752
|
+
"operator": {
|
|
753
|
+
"type": "string",
|
|
754
|
+
"enum": ["isNull", "notNull"],
|
|
755
|
+
"description": "Filter operator that does not require values"
|
|
756
|
+
}
|
|
757
|
+
},
|
|
758
|
+
"required": ["measureName", "operator"],
|
|
759
|
+
"additionalProperties": false
|
|
760
|
+
}
|
|
761
|
+
],
|
|
762
|
+
"description": "Add another result filter after aggregation. Keeps existing result filters.",
|
|
763
|
+
"title": "Add result filter schema"
|
|
764
|
+
}
|
|
765
|
+
```
|
|
766
|
+
|
|
767
|
+
## `changeMeasureAggregation`
|
|
768
|
+
|
|
769
|
+
Measure aggregation
|
|
770
|
+
|
|
771
|
+
Change how a measure is aggregated
|
|
772
|
+
|
|
773
|
+
**Payload schema**
|
|
774
|
+
|
|
775
|
+
```json
|
|
776
|
+
{
|
|
777
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
778
|
+
"type": "object",
|
|
779
|
+
"properties": {
|
|
780
|
+
"dataItemInternalKey": {
|
|
781
|
+
"type": "string",
|
|
782
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
783
|
+
},
|
|
784
|
+
"dataItemUniqueSignature": {
|
|
785
|
+
"type": "string",
|
|
786
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
787
|
+
},
|
|
788
|
+
"aggregation": {
|
|
789
|
+
"type": "string",
|
|
790
|
+
"minLength": 1,
|
|
791
|
+
"description": "Aggregation function to be used for the measure"
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
|
|
795
|
+
"additionalProperties": false,
|
|
796
|
+
"title": "Change measure aggregation schema"
|
|
797
|
+
}
|
|
798
|
+
```
|
|
799
|
+
|
|
800
|
+
## `clearMeasureFilter`
|
|
801
|
+
|
|
802
|
+
Clear measure filter
|
|
803
|
+
|
|
804
|
+
Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.
|
|
805
|
+
|
|
806
|
+
**Payload schema**
|
|
807
|
+
|
|
808
|
+
```json
|
|
809
|
+
{
|
|
810
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
811
|
+
"type": "object",
|
|
812
|
+
"properties": {
|
|
813
|
+
"measureName": {
|
|
814
|
+
"type": "string",
|
|
815
|
+
"description": "Visible measure name or label"
|
|
816
|
+
},
|
|
817
|
+
"fieldKey": {
|
|
818
|
+
"type": "string",
|
|
819
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label. Omit to clear all filters on the measure."
|
|
820
|
+
}
|
|
821
|
+
},
|
|
822
|
+
"required": ["measureName"],
|
|
823
|
+
"additionalProperties": false,
|
|
824
|
+
"description": "Clear measure filters before aggregation. Use fieldKey for one field; omit it for all.",
|
|
825
|
+
"title": "Clear measure filter schema"
|
|
826
|
+
}
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
## `clearResultFilter`
|
|
830
|
+
|
|
831
|
+
Clear result filter
|
|
832
|
+
|
|
833
|
+
Clear all result filters for one measure.
|
|
834
|
+
|
|
835
|
+
**Payload schema**
|
|
836
|
+
|
|
837
|
+
```json
|
|
838
|
+
{
|
|
839
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
840
|
+
"type": "object",
|
|
841
|
+
"properties": {
|
|
842
|
+
"measureName": {
|
|
843
|
+
"type": "string",
|
|
844
|
+
"description": "Visible measure name or label"
|
|
845
|
+
}
|
|
846
|
+
},
|
|
847
|
+
"required": ["measureName"],
|
|
848
|
+
"additionalProperties": false,
|
|
849
|
+
"description": "Clear all result filters for one measure.",
|
|
850
|
+
"title": "Clear result filter schema"
|
|
851
|
+
}
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
## `duplicateDimension`
|
|
855
|
+
|
|
856
|
+
Duplicate dimension
|
|
857
|
+
|
|
858
|
+
Create a copy of an existing dimension
|
|
859
|
+
|
|
860
|
+
**Payload schema**
|
|
861
|
+
|
|
862
|
+
```json
|
|
863
|
+
{
|
|
864
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
865
|
+
"type": "object",
|
|
866
|
+
"properties": {
|
|
867
|
+
"dataItemInternalKey": {
|
|
868
|
+
"type": "string",
|
|
869
|
+
"description": "Internal key of the data item of the dimension to be duplicated"
|
|
870
|
+
},
|
|
871
|
+
"dataItemUniqueSignature": {
|
|
872
|
+
"type": "string",
|
|
873
|
+
"description": "Unique signature of the data item of the dimension to be duplicated"
|
|
874
|
+
}
|
|
875
|
+
},
|
|
876
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
877
|
+
"additionalProperties": false,
|
|
878
|
+
"title": "Duplicate dimension schema"
|
|
879
|
+
}
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
## `duplicateMeasure`
|
|
883
|
+
|
|
884
|
+
Duplicate measure
|
|
885
|
+
|
|
886
|
+
Create a copy of an existing measure
|
|
887
|
+
|
|
888
|
+
**Payload schema**
|
|
889
|
+
|
|
890
|
+
```json
|
|
891
|
+
{
|
|
892
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
893
|
+
"type": "object",
|
|
894
|
+
"properties": {
|
|
895
|
+
"dataItemInternalKey": {
|
|
896
|
+
"type": "string",
|
|
897
|
+
"description": "Internal key of the data item of the measure to be duplicated"
|
|
898
|
+
},
|
|
899
|
+
"dataItemUniqueSignature": {
|
|
900
|
+
"type": "string",
|
|
901
|
+
"description": "Unique signature of the data item of the measure to be duplicated"
|
|
902
|
+
}
|
|
903
|
+
},
|
|
904
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
905
|
+
"additionalProperties": false,
|
|
906
|
+
"title": "Duplicate measure schema"
|
|
907
|
+
}
|
|
908
|
+
```
|
|
909
|
+
|
|
910
|
+
## `removeColoringOverwrite`
|
|
911
|
+
|
|
912
|
+
Remove value color
|
|
913
|
+
|
|
914
|
+
Remove one value color by its position, as returned by getColoringOverwrites
|
|
915
|
+
|
|
916
|
+
**Payload schema**
|
|
917
|
+
|
|
918
|
+
```json
|
|
919
|
+
{
|
|
920
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
921
|
+
"type": "object",
|
|
922
|
+
"properties": {
|
|
923
|
+
"index": {
|
|
924
|
+
"type": "integer",
|
|
925
|
+
"minimum": 0,
|
|
926
|
+
"maximum": 9007199254740991,
|
|
927
|
+
"description": "Zero-based position of the entry to remove"
|
|
928
|
+
}
|
|
929
|
+
},
|
|
930
|
+
"required": ["index"],
|
|
931
|
+
"additionalProperties": false,
|
|
932
|
+
"title": "Remove coloring overwrite schema"
|
|
933
|
+
}
|
|
934
|
+
```
|
|
935
|
+
|
|
936
|
+
## `removeDimension`
|
|
937
|
+
|
|
938
|
+
Remove dimension
|
|
939
|
+
|
|
940
|
+
Remove a dimension from the chart
|
|
941
|
+
|
|
942
|
+
**Payload schema**
|
|
943
|
+
|
|
944
|
+
```json
|
|
945
|
+
{
|
|
946
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
947
|
+
"type": "object",
|
|
948
|
+
"properties": {
|
|
949
|
+
"dataItemInternalKey": {
|
|
950
|
+
"type": "string",
|
|
951
|
+
"description": "Internal key of the data item of the dimension to be removed"
|
|
952
|
+
},
|
|
953
|
+
"dataItemUniqueSignature": {
|
|
954
|
+
"type": "string",
|
|
955
|
+
"description": "Unique signature of the data item of the dimension to be removed"
|
|
956
|
+
}
|
|
957
|
+
},
|
|
958
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
959
|
+
"additionalProperties": false,
|
|
960
|
+
"title": "Remove dimension schema"
|
|
961
|
+
}
|
|
962
|
+
```
|
|
963
|
+
|
|
964
|
+
## `removeMeasure`
|
|
965
|
+
|
|
966
|
+
Remove measure
|
|
967
|
+
|
|
968
|
+
Remove a measure from the chart
|
|
969
|
+
|
|
970
|
+
**Payload schema**
|
|
971
|
+
|
|
972
|
+
```json
|
|
973
|
+
{
|
|
974
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
975
|
+
"type": "object",
|
|
976
|
+
"properties": {
|
|
977
|
+
"dataItemInternalKey": {
|
|
978
|
+
"type": "string",
|
|
979
|
+
"description": "Internal key of the data item of the measure to be removed"
|
|
980
|
+
},
|
|
981
|
+
"dataItemUniqueSignature": {
|
|
982
|
+
"type": "string",
|
|
983
|
+
"description": "Unique signature of the data item of the measure to be removed"
|
|
984
|
+
}
|
|
985
|
+
},
|
|
986
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
987
|
+
"additionalProperties": false,
|
|
988
|
+
"title": "Remove measure schema"
|
|
989
|
+
}
|
|
990
|
+
```
|
|
991
|
+
|
|
992
|
+
## `removeMeasureAdvancedAdditionalDimensionDataField`
|
|
993
|
+
|
|
994
|
+
Remove advanced bottom dimension
|
|
995
|
+
|
|
996
|
+
Remove bottom dimension field from nested ratio advanced calculation
|
|
997
|
+
|
|
998
|
+
**Payload schema**
|
|
999
|
+
|
|
1000
|
+
```json
|
|
1001
|
+
{
|
|
1002
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1003
|
+
"type": "object",
|
|
1004
|
+
"properties": {
|
|
1005
|
+
"dataItemInternalKey": {
|
|
1006
|
+
"type": "string",
|
|
1007
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1008
|
+
},
|
|
1009
|
+
"dataItemUniqueSignature": {
|
|
1010
|
+
"type": "string",
|
|
1011
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1012
|
+
},
|
|
1013
|
+
"collectionKey": {
|
|
1014
|
+
"description": "Measure collection key",
|
|
1015
|
+
"type": "string",
|
|
1016
|
+
"enum": ["measures", "supportingMeasures"]
|
|
1017
|
+
},
|
|
1018
|
+
"advancedOperationKey": {
|
|
1019
|
+
"description": "Advanced operation key",
|
|
1020
|
+
"type": "string",
|
|
1021
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
1022
|
+
},
|
|
1023
|
+
"internalKey": {
|
|
1024
|
+
"type": "string",
|
|
1025
|
+
"description": "Internal key of the bottom dimension field to be removed"
|
|
1026
|
+
}
|
|
1027
|
+
},
|
|
1028
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
|
|
1029
|
+
"additionalProperties": false,
|
|
1030
|
+
"title": "Remove measure advanced additional dimension field schema"
|
|
1031
|
+
}
|
|
1032
|
+
```
|
|
1033
|
+
|
|
1034
|
+
## `removeMeasureAdvancedCompareMeasure`
|
|
1035
|
+
|
|
1036
|
+
Remove advanced compare measure
|
|
1037
|
+
|
|
1038
|
+
Remove compare measure from advanced calculation
|
|
1039
|
+
|
|
1040
|
+
**Payload schema**
|
|
1041
|
+
|
|
1042
|
+
```json
|
|
1043
|
+
{
|
|
1044
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1045
|
+
"type": "object",
|
|
1046
|
+
"properties": {
|
|
1047
|
+
"dataItemInternalKey": {
|
|
1048
|
+
"type": "string",
|
|
1049
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1050
|
+
},
|
|
1051
|
+
"dataItemUniqueSignature": {
|
|
1052
|
+
"type": "string",
|
|
1053
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1054
|
+
},
|
|
1055
|
+
"collectionKey": {
|
|
1056
|
+
"description": "Measure collection key",
|
|
1057
|
+
"type": "string",
|
|
1058
|
+
"enum": ["measures", "supportingMeasures"]
|
|
1059
|
+
},
|
|
1060
|
+
"advancedOperationKey": {
|
|
1061
|
+
"description": "Advanced operation key",
|
|
1062
|
+
"type": "string",
|
|
1063
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
1064
|
+
}
|
|
1065
|
+
},
|
|
1066
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
1067
|
+
"additionalProperties": false,
|
|
1068
|
+
"title": "Remove measure advanced compare measure schema"
|
|
1069
|
+
}
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
## `removeMeasureAdvancedDimensionDataField`
|
|
1073
|
+
|
|
1074
|
+
Remove advanced additional dimension
|
|
1075
|
+
|
|
1076
|
+
Remove additional dimension field from nested advanced calculations
|
|
1077
|
+
|
|
1078
|
+
**Payload schema**
|
|
1079
|
+
|
|
1080
|
+
```json
|
|
1081
|
+
{
|
|
1082
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1083
|
+
"type": "object",
|
|
1084
|
+
"properties": {
|
|
1085
|
+
"dataItemInternalKey": {
|
|
1086
|
+
"type": "string",
|
|
1087
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1088
|
+
},
|
|
1089
|
+
"dataItemUniqueSignature": {
|
|
1090
|
+
"type": "string",
|
|
1091
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1092
|
+
},
|
|
1093
|
+
"collectionKey": {
|
|
1094
|
+
"description": "Measure collection key",
|
|
1095
|
+
"type": "string",
|
|
1096
|
+
"enum": ["measures", "supportingMeasures"]
|
|
1097
|
+
},
|
|
1098
|
+
"advancedOperationKey": {
|
|
1099
|
+
"description": "Advanced operation key",
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
1102
|
+
},
|
|
1103
|
+
"internalKey": {
|
|
1104
|
+
"type": "string",
|
|
1105
|
+
"description": "Internal key of the dimension field to be removed"
|
|
1106
|
+
}
|
|
1107
|
+
},
|
|
1108
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "internalKey"],
|
|
1109
|
+
"additionalProperties": false,
|
|
1110
|
+
"title": "Remove measure advanced dimension field schema"
|
|
1111
|
+
}
|
|
1112
|
+
```
|
|
1113
|
+
|
|
1114
|
+
## `resetChartPaletteToThemeDefault`
|
|
1115
|
+
|
|
1116
|
+
Reset chart palette
|
|
1117
|
+
|
|
1118
|
+
Reset the chart palette back to the workbook theme default
|
|
1119
|
+
|
|
1120
|
+
**Payload schema**
|
|
1121
|
+
|
|
1122
|
+
```json
|
|
1123
|
+
{
|
|
1124
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1125
|
+
"type": "object",
|
|
1126
|
+
"properties": {},
|
|
1127
|
+
"additionalProperties": false,
|
|
1128
|
+
"title": "Reset chart palette schema"
|
|
1129
|
+
}
|
|
1130
|
+
```
|
|
1131
|
+
|
|
1132
|
+
## `setAnimationEnabled`
|
|
1133
|
+
|
|
1134
|
+
Animations
|
|
1135
|
+
|
|
1136
|
+
Turn the chart animations on or off. They are on by default; the host can still disable them regardless of this setting
|
|
1137
|
+
|
|
1138
|
+
**Payload schema**
|
|
1139
|
+
|
|
1140
|
+
```json
|
|
1141
|
+
{
|
|
1142
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1143
|
+
"type": "object",
|
|
1144
|
+
"properties": {
|
|
1145
|
+
"enabled": {
|
|
1146
|
+
"type": "boolean",
|
|
1147
|
+
"description": "Whether the chart animates when it first renders and when its data changes"
|
|
1148
|
+
}
|
|
1149
|
+
},
|
|
1150
|
+
"required": ["enabled"],
|
|
1151
|
+
"additionalProperties": false,
|
|
1152
|
+
"title": "Set animation enabled schema"
|
|
1153
|
+
}
|
|
1154
|
+
```
|
|
1155
|
+
|
|
1156
|
+
## `setChartPalette`
|
|
1157
|
+
|
|
1158
|
+
Chart palette
|
|
1159
|
+
|
|
1160
|
+
Apply an existing palette using a built-in palette name or a theme palette label like "theme palette 2". Built-in categorical palettes: astrato, classic, spectrum, flat, neon, instant, brewer, alternate, dark, bright. Built-in gradient palettes (gradient coloring): viridis, instant, coral, yellowred, greenblue, bluepurple, redpurple. Requires a palette-based coloring type. Your own colors are set with setCustomPaletteColors or setCustomGradientColors, on charts that offer them
|
|
1161
|
+
|
|
1162
|
+
**Payload schema**
|
|
1163
|
+
|
|
1164
|
+
```json
|
|
1165
|
+
{
|
|
1166
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1167
|
+
"type": "string",
|
|
1168
|
+
"minLength": 1,
|
|
1169
|
+
"title": "Chart palette schema"
|
|
1170
|
+
}
|
|
1171
|
+
```
|
|
1172
|
+
|
|
1173
|
+
## `setColoringColor`
|
|
1174
|
+
|
|
1175
|
+
Coloring color
|
|
1176
|
+
|
|
1177
|
+
Set the single color used by the chart
|
|
1178
|
+
|
|
1179
|
+
**Payload schema**
|
|
1180
|
+
|
|
1181
|
+
```json
|
|
1182
|
+
{
|
|
1183
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1184
|
+
"type": "string",
|
|
1185
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
1186
|
+
"title": "Coloring color schema"
|
|
1187
|
+
}
|
|
1188
|
+
```
|
|
1189
|
+
|
|
1190
|
+
## `setColoringOverwrites`
|
|
1191
|
+
|
|
1192
|
+
Value colors
|
|
1193
|
+
|
|
1194
|
+
Replace all value colors, eg. color the dimension value "Happy" dark teal. Value colors take priority over the coloring type and palette, so they apply whatever setColoringType is set to. For ordered bands, add one entry per band with colors taken along a ramp. Requires at least two enabled dimensions; with fewer, only removing value colors (including an empty list) is accepted.
|
|
1195
|
+
|
|
1196
|
+
**Payload schema**
|
|
1197
|
+
|
|
1198
|
+
```json
|
|
1199
|
+
{
|
|
1200
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1201
|
+
"type": "object",
|
|
1202
|
+
"properties": {
|
|
1203
|
+
"overwrites": {
|
|
1204
|
+
"type": "array",
|
|
1205
|
+
"items": {
|
|
1206
|
+
"anyOf": [
|
|
1207
|
+
{
|
|
1208
|
+
"type": "object",
|
|
1209
|
+
"properties": {
|
|
1210
|
+
"dimension": {
|
|
1211
|
+
"description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension",
|
|
1212
|
+
"type": "object",
|
|
1213
|
+
"properties": {
|
|
1214
|
+
"dataItemInternalKey": {
|
|
1215
|
+
"type": "string",
|
|
1216
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1217
|
+
},
|
|
1218
|
+
"dataItemUniqueSignature": {
|
|
1219
|
+
"type": "string",
|
|
1220
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1221
|
+
}
|
|
1222
|
+
},
|
|
1223
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
1224
|
+
"additionalProperties": false
|
|
1225
|
+
},
|
|
1226
|
+
"color": {
|
|
1227
|
+
"type": "string",
|
|
1228
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
1229
|
+
"description": "Color applied when the condition matches, eg. \"#0F766E\""
|
|
1230
|
+
},
|
|
1231
|
+
"operator": {
|
|
1232
|
+
"description": "How the dimension value is compared; defaults to equals. contains, startsWith and endsWith compare text, greater and less compare numbers",
|
|
1233
|
+
"type": "string",
|
|
1234
|
+
"enum": [
|
|
1235
|
+
"equals",
|
|
1236
|
+
"contains",
|
|
1237
|
+
"startsWith",
|
|
1238
|
+
"endsWith",
|
|
1239
|
+
"greater",
|
|
1240
|
+
"less",
|
|
1241
|
+
"greater-equals",
|
|
1242
|
+
"less-equals"
|
|
1243
|
+
]
|
|
1244
|
+
},
|
|
1245
|
+
"value": {
|
|
1246
|
+
"description": "Value to compare against",
|
|
1247
|
+
"type": ["string", "number"]
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
"required": ["color", "value"],
|
|
1251
|
+
"additionalProperties": false
|
|
1252
|
+
},
|
|
1253
|
+
{
|
|
1254
|
+
"type": "object",
|
|
1255
|
+
"properties": {
|
|
1256
|
+
"dimension": {
|
|
1257
|
+
"description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension",
|
|
1258
|
+
"type": "object",
|
|
1259
|
+
"properties": {
|
|
1260
|
+
"dataItemInternalKey": {
|
|
1261
|
+
"type": "string",
|
|
1262
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1263
|
+
},
|
|
1264
|
+
"dataItemUniqueSignature": {
|
|
1265
|
+
"type": "string",
|
|
1266
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1267
|
+
}
|
|
1268
|
+
},
|
|
1269
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
1270
|
+
"additionalProperties": false
|
|
1271
|
+
},
|
|
1272
|
+
"color": {
|
|
1273
|
+
"type": "string",
|
|
1274
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
1275
|
+
"description": "Color applied when the condition matches, eg. \"#0F766E\""
|
|
1276
|
+
},
|
|
1277
|
+
"operator": {
|
|
1278
|
+
"type": "string",
|
|
1279
|
+
"const": "between",
|
|
1280
|
+
"description": "Matches numeric values from value (inclusive) up to secondValue (exclusive)"
|
|
1281
|
+
},
|
|
1282
|
+
"value": {
|
|
1283
|
+
"description": "Lower bound of the range",
|
|
1284
|
+
"type": ["string", "number"]
|
|
1285
|
+
},
|
|
1286
|
+
"secondValue": {
|
|
1287
|
+
"description": "Upper bound of the range",
|
|
1288
|
+
"type": ["string", "number"]
|
|
1289
|
+
}
|
|
1290
|
+
},
|
|
1291
|
+
"required": ["color", "operator", "value", "secondValue"],
|
|
1292
|
+
"additionalProperties": false
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"type": "object",
|
|
1296
|
+
"properties": {
|
|
1297
|
+
"dimension": {
|
|
1298
|
+
"description": "Sankey only, where it is required: the dimension whose values are compared. Other charts match the value against every dimension of a mark and refuse a dimension",
|
|
1299
|
+
"type": "object",
|
|
1300
|
+
"properties": {
|
|
1301
|
+
"dataItemInternalKey": {
|
|
1302
|
+
"type": "string",
|
|
1303
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1304
|
+
},
|
|
1305
|
+
"dataItemUniqueSignature": {
|
|
1306
|
+
"type": "string",
|
|
1307
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1308
|
+
}
|
|
1309
|
+
},
|
|
1310
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
1311
|
+
"additionalProperties": false
|
|
1312
|
+
},
|
|
1313
|
+
"color": {
|
|
1314
|
+
"type": "string",
|
|
1315
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
|
|
1316
|
+
"description": "Color applied when the condition matches, eg. \"#0F766E\""
|
|
1317
|
+
},
|
|
1318
|
+
"operator": {
|
|
1319
|
+
"type": "string",
|
|
1320
|
+
"enum": ["inList", "notInList"],
|
|
1321
|
+
"description": "Match (inList) or exclude (notInList) every value in values"
|
|
1322
|
+
},
|
|
1323
|
+
"values": {
|
|
1324
|
+
"minItems": 1,
|
|
1325
|
+
"type": "array",
|
|
1326
|
+
"items": {
|
|
1327
|
+
"type": ["string", "number"]
|
|
1328
|
+
},
|
|
1329
|
+
"description": "Values to match"
|
|
1330
|
+
},
|
|
1331
|
+
"delimiter": {
|
|
1332
|
+
"description": "Separator the values are stored with; defaults to \",\". No value may contain it",
|
|
1333
|
+
"type": "string",
|
|
1334
|
+
"minLength": 1
|
|
1335
|
+
}
|
|
1336
|
+
},
|
|
1337
|
+
"required": ["color", "operator", "values"],
|
|
1338
|
+
"additionalProperties": false
|
|
1339
|
+
}
|
|
1340
|
+
]
|
|
1341
|
+
},
|
|
1342
|
+
"description": "Ordered list of value colors; the first matching entry wins. An empty list removes them all"
|
|
1343
|
+
}
|
|
1344
|
+
},
|
|
1345
|
+
"required": ["overwrites"],
|
|
1346
|
+
"additionalProperties": false,
|
|
1347
|
+
"title": "Set coloring overwrites schema"
|
|
1348
|
+
}
|
|
1349
|
+
```
|
|
1350
|
+
|
|
1351
|
+
## `setColoringPersistentColors`
|
|
1352
|
+
|
|
1353
|
+
Persistent colors
|
|
1354
|
+
|
|
1355
|
+
Enable or disable persistent categorical coloring
|
|
1356
|
+
|
|
1357
|
+
**Payload schema**
|
|
1358
|
+
|
|
1359
|
+
```json
|
|
1360
|
+
{
|
|
1361
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1362
|
+
"description": "Enable persistent colors",
|
|
1363
|
+
"title": "Persistent colors schema",
|
|
1364
|
+
"type": "boolean"
|
|
1365
|
+
}
|
|
1366
|
+
```
|
|
1367
|
+
|
|
1368
|
+
## `setColoringSortOrder`
|
|
1369
|
+
|
|
1370
|
+
Coloring sort order
|
|
1371
|
+
|
|
1372
|
+
Set the order categorical colors and legend items follow: "alpha-asc" sorts ascending by value (numbers numerically, text A to Z), "data" keeps the order of the data. Fails when the chart cannot use categorical coloring with its current dimensions and measures
|
|
1373
|
+
|
|
1374
|
+
**Payload schema**
|
|
1375
|
+
|
|
1376
|
+
```json
|
|
1377
|
+
{
|
|
1378
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"enum": ["alpha-asc", "data"],
|
|
1381
|
+
"title": "Coloring sort order schema"
|
|
1382
|
+
}
|
|
1383
|
+
```
|
|
1384
|
+
|
|
1385
|
+
## `setColoringType`
|
|
1386
|
+
|
|
1387
|
+
Coloring type
|
|
1388
|
+
|
|
1389
|
+
Set how colors are applied to the chart
|
|
1390
|
+
|
|
1391
|
+
**Payload schema**
|
|
1392
|
+
|
|
1393
|
+
```json
|
|
1394
|
+
{
|
|
1395
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1396
|
+
"type": "string",
|
|
1397
|
+
"enum": ["single", "categorical", "gradient", "perEachMeasure", "perEachDimension"],
|
|
1398
|
+
"title": "Coloring type schema"
|
|
1399
|
+
}
|
|
1400
|
+
```
|
|
1401
|
+
|
|
1402
|
+
## `setCustomPaletteColors`
|
|
1403
|
+
|
|
1404
|
+
Custom palette colors
|
|
1405
|
+
|
|
1406
|
+
Replace the whole custom categorical palette with a provided list of colors and switch the chart to the custom palette in the same step, so setChartPalette does not need to be called first. Requires categorical or perEachMeasure or perEachDimension coloring; set the coloring type first if the chart uses single coloring. For gradient coloring use setCustomGradientColors instead
|
|
1407
|
+
|
|
1408
|
+
**Payload schema**
|
|
1409
|
+
|
|
1410
|
+
```json
|
|
1411
|
+
{
|
|
1412
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1413
|
+
"type": "object",
|
|
1414
|
+
"properties": {
|
|
1415
|
+
"colors": {
|
|
1416
|
+
"minItems": 1,
|
|
1417
|
+
"type": "array",
|
|
1418
|
+
"items": {
|
|
1419
|
+
"type": "string",
|
|
1420
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
|
|
1421
|
+
}
|
|
1422
|
+
}
|
|
1423
|
+
},
|
|
1424
|
+
"required": ["colors"],
|
|
1425
|
+
"additionalProperties": false,
|
|
1426
|
+
"title": "Custom palette colors schema"
|
|
1427
|
+
}
|
|
1428
|
+
```
|
|
1429
|
+
|
|
1430
|
+
## `setDimensionFormatString`
|
|
1431
|
+
|
|
1432
|
+
Dimension format string
|
|
1433
|
+
|
|
1434
|
+
Set the custom display format string for a dimension. This changes label formatting only and does not change temporal grouping.
|
|
1435
|
+
|
|
1436
|
+
**Payload schema**
|
|
1437
|
+
|
|
1438
|
+
```json
|
|
1439
|
+
{
|
|
1440
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1441
|
+
"type": "object",
|
|
1442
|
+
"properties": {
|
|
1443
|
+
"dataItemInternalKey": {
|
|
1444
|
+
"type": "string",
|
|
1445
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1446
|
+
},
|
|
1447
|
+
"dataItemUniqueSignature": {
|
|
1448
|
+
"type": "string",
|
|
1449
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1450
|
+
},
|
|
1451
|
+
"formatString": {
|
|
1452
|
+
"anyOf": [
|
|
1453
|
+
{
|
|
1454
|
+
"type": "string"
|
|
1455
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
"type": "object",
|
|
1458
|
+
"properties": {
|
|
1459
|
+
"type": {
|
|
1460
|
+
"type": "string",
|
|
1461
|
+
"const": "variable"
|
|
1462
|
+
},
|
|
1463
|
+
"variableName": {
|
|
1464
|
+
"type": "string"
|
|
1465
|
+
}
|
|
1466
|
+
},
|
|
1467
|
+
"required": ["type", "variableName"],
|
|
1468
|
+
"additionalProperties": false
|
|
1469
|
+
}
|
|
1470
|
+
]
|
|
1471
|
+
}
|
|
1472
|
+
},
|
|
1473
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
1474
|
+
"additionalProperties": false,
|
|
1475
|
+
"title": "Dimension format string schema"
|
|
1476
|
+
}
|
|
1477
|
+
```
|
|
1478
|
+
|
|
1479
|
+
## `setDimensionFormatType`
|
|
1480
|
+
|
|
1481
|
+
Dimension format type
|
|
1482
|
+
|
|
1483
|
+
Set the display format type used by a dimension. This changes label formatting only and does not change temporal grouping.
|
|
1484
|
+
|
|
1485
|
+
**Payload schema**
|
|
1486
|
+
|
|
1487
|
+
```json
|
|
1488
|
+
{
|
|
1489
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1490
|
+
"type": "object",
|
|
1491
|
+
"properties": {
|
|
1492
|
+
"dataItemInternalKey": {
|
|
1493
|
+
"type": "string",
|
|
1494
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1495
|
+
},
|
|
1496
|
+
"dataItemUniqueSignature": {
|
|
1497
|
+
"type": "string",
|
|
1498
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1499
|
+
},
|
|
1500
|
+
"formatType": {
|
|
1501
|
+
"anyOf": [
|
|
1502
|
+
{
|
|
1503
|
+
"type": "string",
|
|
1504
|
+
"enum": [
|
|
1505
|
+
"custom",
|
|
1506
|
+
"inherit",
|
|
1507
|
+
"none",
|
|
1508
|
+
"defaultNumber",
|
|
1509
|
+
"defaultMoney",
|
|
1510
|
+
"numberNoDecimal",
|
|
1511
|
+
"number1Decimal",
|
|
1512
|
+
"number2Decimal",
|
|
1513
|
+
"abbreviationAuto",
|
|
1514
|
+
"abbreviationNoDecimal",
|
|
1515
|
+
"abbreviation1Decimal",
|
|
1516
|
+
"abbreviation2Decimal",
|
|
1517
|
+
"percentageNoDecimal",
|
|
1518
|
+
"percentage1Decimal",
|
|
1519
|
+
"percentage2Decimal",
|
|
1520
|
+
"money0Decimal",
|
|
1521
|
+
"money2Decimal",
|
|
1522
|
+
"durationDays",
|
|
1523
|
+
"durationHours",
|
|
1524
|
+
"durationMinutes",
|
|
1525
|
+
"durationSeconds"
|
|
1526
|
+
]
|
|
1527
|
+
},
|
|
1528
|
+
{
|
|
1529
|
+
"type": "string",
|
|
1530
|
+
"enum": [
|
|
1531
|
+
"defaultDate",
|
|
1532
|
+
"defaultDatetime",
|
|
1533
|
+
"defaultTime",
|
|
1534
|
+
"ddmmyyyy",
|
|
1535
|
+
"ddmmyyyy2",
|
|
1536
|
+
"ddmmyyyy3",
|
|
1537
|
+
"yyyymmdd",
|
|
1538
|
+
"mmddyyyy",
|
|
1539
|
+
"mmddyyyy2",
|
|
1540
|
+
"ddmmmmyyyy",
|
|
1541
|
+
"ddmmmyyyy",
|
|
1542
|
+
"ddmmmyy",
|
|
1543
|
+
"mmmmddyyyy",
|
|
1544
|
+
"yyyy",
|
|
1545
|
+
"yy",
|
|
1546
|
+
"mmmyyyy",
|
|
1547
|
+
"yyyymmm",
|
|
1548
|
+
"yyyymmmm",
|
|
1549
|
+
"mmyyyy",
|
|
1550
|
+
"yyyymm",
|
|
1551
|
+
"mmmmyyyy",
|
|
1552
|
+
"yyyywn",
|
|
1553
|
+
"wnyyyy",
|
|
1554
|
+
"yywn",
|
|
1555
|
+
"yyyyq",
|
|
1556
|
+
"qyyyy",
|
|
1557
|
+
"yyyymmddhhmmss",
|
|
1558
|
+
"yyyymmddhmmss",
|
|
1559
|
+
"yyyymmddhhmm",
|
|
1560
|
+
"yyyymmddhh",
|
|
1561
|
+
"yyyymmddhmm",
|
|
1562
|
+
"yyyymmddh",
|
|
1563
|
+
"ddmmmyyyyhhmmss",
|
|
1564
|
+
"ddmmmyyyyhmmss",
|
|
1565
|
+
"ddmmmyyyyhhmm",
|
|
1566
|
+
"ddmmmyyyyhmm",
|
|
1567
|
+
"ddmmmyyyyh",
|
|
1568
|
+
"hhmmss",
|
|
1569
|
+
"hhmm",
|
|
1570
|
+
"hmm",
|
|
1571
|
+
"h",
|
|
1572
|
+
"hh",
|
|
1573
|
+
"hmmss",
|
|
1574
|
+
"month",
|
|
1575
|
+
"month2",
|
|
1576
|
+
"monthn",
|
|
1577
|
+
"month3",
|
|
1578
|
+
"quarter",
|
|
1579
|
+
"quarter2",
|
|
1580
|
+
"week1",
|
|
1581
|
+
"week2",
|
|
1582
|
+
"week3",
|
|
1583
|
+
"day",
|
|
1584
|
+
"dayOfWeek",
|
|
1585
|
+
"hhn",
|
|
1586
|
+
"hn"
|
|
1587
|
+
]
|
|
1588
|
+
}
|
|
1589
|
+
]
|
|
1590
|
+
}
|
|
1591
|
+
},
|
|
1592
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
|
|
1593
|
+
"additionalProperties": false,
|
|
1594
|
+
"title": "Dimension format type schema"
|
|
1595
|
+
}
|
|
1596
|
+
```
|
|
1597
|
+
|
|
1598
|
+
## `setDimensionTemporalGrouping`
|
|
1599
|
+
|
|
1600
|
+
Dimension temporal grouping
|
|
1601
|
+
|
|
1602
|
+
Set the temporal grouping of a date dimension. Use mode "level" with dateLevel for year-aware buckets such as month-over-time, mode "part" with datePart for date parts such as month-of-year, or mode "none" to clear temporal grouping.
|
|
1603
|
+
|
|
1604
|
+
**Payload schema**
|
|
1605
|
+
|
|
1606
|
+
```json
|
|
1607
|
+
{
|
|
1608
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1609
|
+
"oneOf": [
|
|
1610
|
+
{
|
|
1611
|
+
"type": "object",
|
|
1612
|
+
"properties": {
|
|
1613
|
+
"dataItemInternalKey": {
|
|
1614
|
+
"type": "string",
|
|
1615
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1616
|
+
},
|
|
1617
|
+
"dataItemUniqueSignature": {
|
|
1618
|
+
"type": "string",
|
|
1619
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1620
|
+
},
|
|
1621
|
+
"mode": {
|
|
1622
|
+
"type": "string",
|
|
1623
|
+
"const": "none"
|
|
1624
|
+
}
|
|
1625
|
+
},
|
|
1626
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode"],
|
|
1627
|
+
"additionalProperties": false
|
|
1628
|
+
},
|
|
1629
|
+
{
|
|
1630
|
+
"type": "object",
|
|
1631
|
+
"properties": {
|
|
1632
|
+
"dataItemInternalKey": {
|
|
1633
|
+
"type": "string",
|
|
1634
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1635
|
+
},
|
|
1636
|
+
"dataItemUniqueSignature": {
|
|
1637
|
+
"type": "string",
|
|
1638
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1639
|
+
},
|
|
1640
|
+
"mode": {
|
|
1641
|
+
"type": "string",
|
|
1642
|
+
"const": "level"
|
|
1643
|
+
},
|
|
1644
|
+
"dateLevel": {
|
|
1645
|
+
"type": "string",
|
|
1646
|
+
"enum": [
|
|
1647
|
+
"year",
|
|
1648
|
+
"year-end",
|
|
1649
|
+
"quarter",
|
|
1650
|
+
"quarter-end",
|
|
1651
|
+
"month",
|
|
1652
|
+
"month-end",
|
|
1653
|
+
"week",
|
|
1654
|
+
"week-end",
|
|
1655
|
+
"day",
|
|
1656
|
+
"hour",
|
|
1657
|
+
"minute",
|
|
1658
|
+
"second"
|
|
1659
|
+
]
|
|
1660
|
+
}
|
|
1661
|
+
},
|
|
1662
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "dateLevel"],
|
|
1663
|
+
"additionalProperties": false
|
|
1664
|
+
},
|
|
1665
|
+
{
|
|
1666
|
+
"type": "object",
|
|
1667
|
+
"properties": {
|
|
1668
|
+
"dataItemInternalKey": {
|
|
1669
|
+
"type": "string",
|
|
1670
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
1671
|
+
},
|
|
1672
|
+
"dataItemUniqueSignature": {
|
|
1673
|
+
"type": "string",
|
|
1674
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
1675
|
+
},
|
|
1676
|
+
"mode": {
|
|
1677
|
+
"type": "string",
|
|
1678
|
+
"const": "part"
|
|
1679
|
+
},
|
|
1680
|
+
"datePart": {
|
|
1681
|
+
"type": "string",
|
|
1682
|
+
"enum": [
|
|
1683
|
+
"year",
|
|
1684
|
+
"month",
|
|
1685
|
+
"day",
|
|
1686
|
+
"dayofweekiso",
|
|
1687
|
+
"dayofyear",
|
|
1688
|
+
"weekiso",
|
|
1689
|
+
"quarter",
|
|
1690
|
+
"yearofweekiso",
|
|
1691
|
+
"hour",
|
|
1692
|
+
"minute",
|
|
1693
|
+
"second"
|
|
1694
|
+
]
|
|
1695
|
+
}
|
|
1696
|
+
},
|
|
1697
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "mode", "datePart"],
|
|
1698
|
+
"additionalProperties": false
|
|
1699
|
+
}
|
|
1700
|
+
],
|
|
1701
|
+
"title": "Dimension temporal grouping schema"
|
|
1702
|
+
}
|
|
1703
|
+
```
|
|
1704
|
+
|
|
1705
|
+
## `setLegendEnabled`
|
|
1706
|
+
|
|
1707
|
+
Legend enabled
|
|
1708
|
+
|
|
1709
|
+
Show or hide the chart legend
|
|
1710
|
+
|
|
1711
|
+
**Payload schema**
|
|
1712
|
+
|
|
1713
|
+
```json
|
|
1714
|
+
{
|
|
1715
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1716
|
+
"type": "boolean",
|
|
1717
|
+
"description": "Enable legend",
|
|
1718
|
+
"title": "Legend enabled schema"
|
|
1719
|
+
}
|
|
1720
|
+
```
|
|
1721
|
+
|
|
1722
|
+
## `setLegendItemLabelFill`
|
|
1723
|
+
|
|
1724
|
+
Legend label color
|
|
1725
|
+
|
|
1726
|
+
Change the color of legend text labels
|
|
1727
|
+
|
|
1728
|
+
**Payload schema**
|
|
1729
|
+
|
|
1730
|
+
```json
|
|
1731
|
+
{
|
|
1732
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1733
|
+
"anyOf": [
|
|
1734
|
+
{
|
|
1735
|
+
"type": "string",
|
|
1736
|
+
"pattern": "^#([0-9a-fA-F]{6}|[0-9a-fA-F]{8})$"
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
"type": "null"
|
|
1740
|
+
}
|
|
1741
|
+
],
|
|
1742
|
+
"description": "Legend item label font color (hexadecimal color code)",
|
|
1743
|
+
"title": "Legend item label fill schema"
|
|
1744
|
+
}
|
|
1745
|
+
```
|
|
1746
|
+
|
|
1747
|
+
## `setLegendItemLabelFontSize`
|
|
1748
|
+
|
|
1749
|
+
Legend label font size
|
|
1750
|
+
|
|
1751
|
+
Adjust the font size of legend labels
|
|
1752
|
+
|
|
1753
|
+
**Payload schema**
|
|
1754
|
+
|
|
1755
|
+
```json
|
|
1756
|
+
{
|
|
1757
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1758
|
+
"type": "number",
|
|
1759
|
+
"title": "Legend item label font size schema"
|
|
1760
|
+
}
|
|
1761
|
+
```
|
|
1762
|
+
|
|
1763
|
+
## `setLegendItemLabelLimitCharacters`
|
|
1764
|
+
|
|
1765
|
+
Enable legend label characters limit
|
|
1766
|
+
|
|
1767
|
+
Enable or disable character limit for legend labels
|
|
1768
|
+
|
|
1769
|
+
**Payload schema**
|
|
1770
|
+
|
|
1771
|
+
```json
|
|
1772
|
+
{
|
|
1773
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1774
|
+
"description": "Limit characters by maxGlyphCount",
|
|
1775
|
+
"title": "Legend item label limit characters schema",
|
|
1776
|
+
"type": "boolean"
|
|
1777
|
+
}
|
|
1778
|
+
```
|
|
1779
|
+
|
|
1780
|
+
## `setLegendItemLabelMaxGlyphCount`
|
|
1781
|
+
|
|
1782
|
+
Legend label characters limit
|
|
1783
|
+
|
|
1784
|
+
Set the maximum number of characters shown in legend labels
|
|
1785
|
+
|
|
1786
|
+
**Payload schema**
|
|
1787
|
+
|
|
1788
|
+
```json
|
|
1789
|
+
{
|
|
1790
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1791
|
+
"description": "Maximum number of glyphs in the legend item label",
|
|
1792
|
+
"title": "Legend item label max glyph count schema",
|
|
1793
|
+
"type": ["number", "null"]
|
|
1794
|
+
}
|
|
1795
|
+
```
|
|
1796
|
+
|
|
1797
|
+
## `setLegendPosition`
|
|
1798
|
+
|
|
1799
|
+
Legend position
|
|
1800
|
+
|
|
1801
|
+
Change where the legend appears on the chart
|
|
1802
|
+
|
|
1803
|
+
**Payload schema**
|
|
1804
|
+
|
|
1805
|
+
```json
|
|
1806
|
+
{
|
|
1807
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1808
|
+
"type": "string",
|
|
1809
|
+
"enum": ["left", "right", "top", "bottom"],
|
|
1810
|
+
"description": "Legend position",
|
|
1811
|
+
"title": "Legend position schema"
|
|
1812
|
+
}
|
|
1813
|
+
```
|
|
1814
|
+
|
|
1815
|
+
## `setLegendTitle`
|
|
1816
|
+
|
|
1817
|
+
Legend title
|
|
1818
|
+
|
|
1819
|
+
Set a custom title for the legend
|
|
1820
|
+
|
|
1821
|
+
**Payload schema**
|
|
1822
|
+
|
|
1823
|
+
```json
|
|
1824
|
+
{
|
|
1825
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1826
|
+
"description": "Legend title text",
|
|
1827
|
+
"title": "Legend title schema",
|
|
1828
|
+
"type": ["string", "null"]
|
|
1829
|
+
}
|
|
1830
|
+
```
|
|
1831
|
+
|
|
1832
|
+
## `setMeasureAdvancedAdditionalAggregation`
|
|
1833
|
+
|
|
1834
|
+
Advanced additional aggregation
|
|
1835
|
+
|
|
1836
|
+
Set additional aggregation used by nested ratio advanced calculation
|
|
1837
|
+
|
|
1838
|
+
**Payload schema**
|
|
1839
|
+
|
|
1840
|
+
```json
|
|
1841
|
+
{
|
|
1842
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1843
|
+
"type": "object",
|
|
1844
|
+
"properties": {
|
|
1845
|
+
"dataItemInternalKey": {
|
|
1846
|
+
"type": "string",
|
|
1847
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1848
|
+
},
|
|
1849
|
+
"dataItemUniqueSignature": {
|
|
1850
|
+
"type": "string",
|
|
1851
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1852
|
+
},
|
|
1853
|
+
"collectionKey": {
|
|
1854
|
+
"description": "Measure collection key",
|
|
1855
|
+
"type": "string",
|
|
1856
|
+
"enum": ["measures", "supportingMeasures"]
|
|
1857
|
+
},
|
|
1858
|
+
"advancedOperationKey": {
|
|
1859
|
+
"description": "Advanced operation key",
|
|
1860
|
+
"type": "string",
|
|
1861
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
1862
|
+
},
|
|
1863
|
+
"additionalAggregation": {
|
|
1864
|
+
"type": "string",
|
|
1865
|
+
"enum": ["SUM", "AVG", "MIN", "MAX"]
|
|
1866
|
+
}
|
|
1867
|
+
},
|
|
1868
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "additionalAggregation"],
|
|
1869
|
+
"additionalProperties": false,
|
|
1870
|
+
"title": "Measure advanced additional aggregation schema"
|
|
1871
|
+
}
|
|
1872
|
+
```
|
|
1873
|
+
|
|
1874
|
+
## `setMeasureAdvancedAggregation`
|
|
1875
|
+
|
|
1876
|
+
Advanced aggregation
|
|
1877
|
+
|
|
1878
|
+
Set aggregation used by advanced calculation for a measure
|
|
1879
|
+
|
|
1880
|
+
**Payload schema**
|
|
1881
|
+
|
|
1882
|
+
```json
|
|
1883
|
+
{
|
|
1884
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1885
|
+
"type": "object",
|
|
1886
|
+
"properties": {
|
|
1887
|
+
"dataItemInternalKey": {
|
|
1888
|
+
"type": "string",
|
|
1889
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1890
|
+
},
|
|
1891
|
+
"dataItemUniqueSignature": {
|
|
1892
|
+
"type": "string",
|
|
1893
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1894
|
+
},
|
|
1895
|
+
"collectionKey": {
|
|
1896
|
+
"description": "Measure collection key",
|
|
1897
|
+
"type": "string",
|
|
1898
|
+
"enum": ["measures", "supportingMeasures"]
|
|
1899
|
+
},
|
|
1900
|
+
"advancedOperationKey": {
|
|
1901
|
+
"description": "Advanced operation key",
|
|
1902
|
+
"type": "string",
|
|
1903
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
1904
|
+
},
|
|
1905
|
+
"aggregation": {
|
|
1906
|
+
"type": "string",
|
|
1907
|
+
"enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
|
|
1908
|
+
}
|
|
1909
|
+
},
|
|
1910
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "aggregation"],
|
|
1911
|
+
"additionalProperties": false,
|
|
1912
|
+
"title": "Measure advanced aggregation schema"
|
|
1913
|
+
}
|
|
1914
|
+
```
|
|
1915
|
+
|
|
1916
|
+
## `setMeasureAdvancedCalculationType`
|
|
1917
|
+
|
|
1918
|
+
Advanced calculation type
|
|
1919
|
+
|
|
1920
|
+
Set advanced calculation type for a measure
|
|
1921
|
+
|
|
1922
|
+
**Payload schema**
|
|
1923
|
+
|
|
1924
|
+
```json
|
|
1925
|
+
{
|
|
1926
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1927
|
+
"type": "object",
|
|
1928
|
+
"properties": {
|
|
1929
|
+
"dataItemInternalKey": {
|
|
1930
|
+
"type": "string",
|
|
1931
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1932
|
+
},
|
|
1933
|
+
"dataItemUniqueSignature": {
|
|
1934
|
+
"type": "string",
|
|
1935
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1936
|
+
},
|
|
1937
|
+
"collectionKey": {
|
|
1938
|
+
"description": "Measure collection key",
|
|
1939
|
+
"type": "string",
|
|
1940
|
+
"enum": ["measures", "supportingMeasures"]
|
|
1941
|
+
},
|
|
1942
|
+
"advancedOperationKey": {
|
|
1943
|
+
"description": "Advanced operation key",
|
|
1944
|
+
"type": "string",
|
|
1945
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
1946
|
+
},
|
|
1947
|
+
"advancedCalculationType": {
|
|
1948
|
+
"type": "string",
|
|
1949
|
+
"enum": [
|
|
1950
|
+
"none",
|
|
1951
|
+
"movingCalculation",
|
|
1952
|
+
"runningTotal",
|
|
1953
|
+
"runningRate",
|
|
1954
|
+
"accumulatedGrowth",
|
|
1955
|
+
"rank",
|
|
1956
|
+
"total",
|
|
1957
|
+
"shareTotal",
|
|
1958
|
+
"nestedCalculation",
|
|
1959
|
+
"nestedRatio",
|
|
1960
|
+
"nestedCorrelation",
|
|
1961
|
+
"value",
|
|
1962
|
+
"diff",
|
|
1963
|
+
"ratio",
|
|
1964
|
+
"growth",
|
|
1965
|
+
"apg",
|
|
1966
|
+
"cagr",
|
|
1967
|
+
"periodOverCorrelation",
|
|
1968
|
+
"udf",
|
|
1969
|
+
"customUdf"
|
|
1970
|
+
]
|
|
1971
|
+
}
|
|
1972
|
+
},
|
|
1973
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "advancedCalculationType"],
|
|
1974
|
+
"additionalProperties": false,
|
|
1975
|
+
"title": "Measure advanced calculation type schema"
|
|
1976
|
+
}
|
|
1977
|
+
```
|
|
1978
|
+
|
|
1979
|
+
## `setMeasureAdvancedCompareMeasure`
|
|
1980
|
+
|
|
1981
|
+
Advanced compare measure
|
|
1982
|
+
|
|
1983
|
+
Set compare measure used by accumulated growth or nested correlation
|
|
1984
|
+
|
|
1985
|
+
**Payload schema**
|
|
1986
|
+
|
|
1987
|
+
```json
|
|
1988
|
+
{
|
|
1989
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1990
|
+
"type": "object",
|
|
1991
|
+
"properties": {
|
|
1992
|
+
"dataItemInternalKey": {
|
|
1993
|
+
"type": "string",
|
|
1994
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
1995
|
+
},
|
|
1996
|
+
"dataItemUniqueSignature": {
|
|
1997
|
+
"type": "string",
|
|
1998
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
1999
|
+
},
|
|
2000
|
+
"collectionKey": {
|
|
2001
|
+
"description": "Measure collection key",
|
|
2002
|
+
"type": "string",
|
|
2003
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2004
|
+
},
|
|
2005
|
+
"advancedOperationKey": {
|
|
2006
|
+
"description": "Advanced operation key",
|
|
2007
|
+
"type": "string",
|
|
2008
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2009
|
+
},
|
|
2010
|
+
"key": {
|
|
2011
|
+
"type": "string",
|
|
2012
|
+
"description": "Engine key of the compare measure field"
|
|
2013
|
+
},
|
|
2014
|
+
"aggregation": {
|
|
2015
|
+
"type": "string",
|
|
2016
|
+
"enum": ["SUM", "AVG", "MIN", "MAX", "PERCENTILE", "OUTLIERS", "CONTROL_VALUE"]
|
|
2017
|
+
},
|
|
2018
|
+
"parameters": {
|
|
2019
|
+
"anyOf": [
|
|
2020
|
+
{
|
|
2021
|
+
"type": "object",
|
|
2022
|
+
"propertyNames": {
|
|
2023
|
+
"type": "string"
|
|
2024
|
+
},
|
|
2025
|
+
"additionalProperties": {
|
|
2026
|
+
"type": "object",
|
|
2027
|
+
"properties": {
|
|
2028
|
+
"value": {
|
|
2029
|
+
"anyOf": [
|
|
2030
|
+
{
|
|
2031
|
+
"anyOf": [
|
|
2032
|
+
{
|
|
2033
|
+
"type": "string"
|
|
2034
|
+
},
|
|
2035
|
+
{
|
|
2036
|
+
"type": "object",
|
|
2037
|
+
"properties": {
|
|
2038
|
+
"type": {
|
|
2039
|
+
"type": "string",
|
|
2040
|
+
"const": "variable"
|
|
2041
|
+
},
|
|
2042
|
+
"variableName": {
|
|
2043
|
+
"type": "string"
|
|
2044
|
+
}
|
|
2045
|
+
},
|
|
2046
|
+
"required": ["type", "variableName"],
|
|
2047
|
+
"additionalProperties": false
|
|
2048
|
+
}
|
|
2049
|
+
]
|
|
2050
|
+
},
|
|
2051
|
+
{
|
|
2052
|
+
"anyOf": [
|
|
2053
|
+
{
|
|
2054
|
+
"type": "number"
|
|
2055
|
+
},
|
|
2056
|
+
{
|
|
2057
|
+
"type": "object",
|
|
2058
|
+
"properties": {
|
|
2059
|
+
"type": {
|
|
2060
|
+
"type": "string",
|
|
2061
|
+
"const": "variable"
|
|
2062
|
+
},
|
|
2063
|
+
"variableName": {
|
|
2064
|
+
"type": "string"
|
|
2065
|
+
}
|
|
2066
|
+
},
|
|
2067
|
+
"required": ["type", "variableName"],
|
|
2068
|
+
"additionalProperties": false
|
|
2069
|
+
}
|
|
2070
|
+
]
|
|
2071
|
+
},
|
|
2072
|
+
{
|
|
2073
|
+
"anyOf": [
|
|
2074
|
+
{
|
|
2075
|
+
"type": "boolean"
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
"type": "object",
|
|
2079
|
+
"properties": {
|
|
2080
|
+
"type": {
|
|
2081
|
+
"type": "string",
|
|
2082
|
+
"const": "variable"
|
|
2083
|
+
},
|
|
2084
|
+
"variableName": {
|
|
2085
|
+
"type": "string"
|
|
2086
|
+
}
|
|
2087
|
+
},
|
|
2088
|
+
"required": ["type", "variableName"],
|
|
2089
|
+
"additionalProperties": false
|
|
2090
|
+
}
|
|
2091
|
+
]
|
|
2092
|
+
}
|
|
2093
|
+
]
|
|
2094
|
+
},
|
|
2095
|
+
"dataType": {
|
|
2096
|
+
"type": "string",
|
|
2097
|
+
"enum": [
|
|
2098
|
+
"string",
|
|
2099
|
+
"int",
|
|
2100
|
+
"float",
|
|
2101
|
+
"boolean",
|
|
2102
|
+
"date",
|
|
2103
|
+
"millisec",
|
|
2104
|
+
"millisec_tz",
|
|
2105
|
+
"timestamp",
|
|
2106
|
+
"timestamp_tz"
|
|
2107
|
+
]
|
|
2108
|
+
}
|
|
2109
|
+
},
|
|
2110
|
+
"required": ["value"],
|
|
2111
|
+
"additionalProperties": false
|
|
2112
|
+
}
|
|
2113
|
+
},
|
|
2114
|
+
{
|
|
2115
|
+
"type": "null"
|
|
2116
|
+
}
|
|
2117
|
+
]
|
|
2118
|
+
}
|
|
2119
|
+
},
|
|
2120
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "key", "aggregation"],
|
|
2121
|
+
"additionalProperties": false,
|
|
2122
|
+
"title": "Set measure advanced compare measure schema"
|
|
2123
|
+
}
|
|
2124
|
+
```
|
|
2125
|
+
|
|
2126
|
+
## `setMeasureAdvancedComparisonType`
|
|
2127
|
+
|
|
2128
|
+
Advanced comparison type
|
|
2129
|
+
|
|
2130
|
+
Set comparison type for period-over-correlation
|
|
2131
|
+
|
|
2132
|
+
**Payload schema**
|
|
2133
|
+
|
|
2134
|
+
```json
|
|
2135
|
+
{
|
|
2136
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2137
|
+
"type": "object",
|
|
2138
|
+
"properties": {
|
|
2139
|
+
"dataItemInternalKey": {
|
|
2140
|
+
"type": "string",
|
|
2141
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2142
|
+
},
|
|
2143
|
+
"dataItemUniqueSignature": {
|
|
2144
|
+
"type": "string",
|
|
2145
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2146
|
+
},
|
|
2147
|
+
"collectionKey": {
|
|
2148
|
+
"description": "Measure collection key",
|
|
2149
|
+
"type": "string",
|
|
2150
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2151
|
+
},
|
|
2152
|
+
"advancedOperationKey": {
|
|
2153
|
+
"description": "Advanced operation key",
|
|
2154
|
+
"type": "string",
|
|
2155
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2156
|
+
},
|
|
2157
|
+
"comparisonType": {
|
|
2158
|
+
"type": "string",
|
|
2159
|
+
"enum": ["absolute", "percentage", "naturalLog"]
|
|
2160
|
+
}
|
|
2161
|
+
},
|
|
2162
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "comparisonType"],
|
|
2163
|
+
"additionalProperties": false,
|
|
2164
|
+
"title": "Measure advanced comparison type schema"
|
|
2165
|
+
}
|
|
2166
|
+
```
|
|
2167
|
+
|
|
2168
|
+
## `setMeasureAdvancedDense`
|
|
2169
|
+
|
|
2170
|
+
Advanced dense rank
|
|
2171
|
+
|
|
2172
|
+
Enable or disable dense rank
|
|
2173
|
+
|
|
2174
|
+
**Payload schema**
|
|
2175
|
+
|
|
2176
|
+
```json
|
|
2177
|
+
{
|
|
2178
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2179
|
+
"type": "object",
|
|
2180
|
+
"properties": {
|
|
2181
|
+
"dataItemInternalKey": {
|
|
2182
|
+
"type": "string",
|
|
2183
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2184
|
+
},
|
|
2185
|
+
"dataItemUniqueSignature": {
|
|
2186
|
+
"type": "string",
|
|
2187
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2188
|
+
},
|
|
2189
|
+
"collectionKey": {
|
|
2190
|
+
"description": "Measure collection key",
|
|
2191
|
+
"type": "string",
|
|
2192
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2193
|
+
},
|
|
2194
|
+
"advancedOperationKey": {
|
|
2195
|
+
"description": "Advanced operation key",
|
|
2196
|
+
"type": "string",
|
|
2197
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2198
|
+
},
|
|
2199
|
+
"dense": {
|
|
2200
|
+
"type": "boolean"
|
|
2201
|
+
}
|
|
2202
|
+
},
|
|
2203
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "dense"],
|
|
2204
|
+
"additionalProperties": false,
|
|
2205
|
+
"title": "Measure advanced dense schema"
|
|
2206
|
+
}
|
|
2207
|
+
```
|
|
2208
|
+
|
|
2209
|
+
## `setMeasureAdvancedDimensionsIds`
|
|
2210
|
+
|
|
2211
|
+
Advanced dimensions
|
|
2212
|
+
|
|
2213
|
+
Set dimensions used by advanced calculation
|
|
2214
|
+
|
|
2215
|
+
**Payload schema**
|
|
2216
|
+
|
|
2217
|
+
```json
|
|
2218
|
+
{
|
|
2219
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2220
|
+
"type": "object",
|
|
2221
|
+
"properties": {
|
|
2222
|
+
"dataItemInternalKey": {
|
|
2223
|
+
"type": "string",
|
|
2224
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2225
|
+
},
|
|
2226
|
+
"dataItemUniqueSignature": {
|
|
2227
|
+
"type": "string",
|
|
2228
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2229
|
+
},
|
|
2230
|
+
"collectionKey": {
|
|
2231
|
+
"description": "Measure collection key",
|
|
2232
|
+
"type": "string",
|
|
2233
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2234
|
+
},
|
|
2235
|
+
"advancedOperationKey": {
|
|
2236
|
+
"description": "Advanced operation key",
|
|
2237
|
+
"type": "string",
|
|
2238
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2239
|
+
},
|
|
2240
|
+
"dimensionsIds": {
|
|
2241
|
+
"type": "array",
|
|
2242
|
+
"items": {
|
|
2243
|
+
"type": "string"
|
|
2244
|
+
}
|
|
2245
|
+
}
|
|
2246
|
+
},
|
|
2247
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "dimensionsIds"],
|
|
2248
|
+
"additionalProperties": false,
|
|
2249
|
+
"title": "Measure advanced dimensions schema"
|
|
2250
|
+
}
|
|
2251
|
+
```
|
|
2252
|
+
|
|
2253
|
+
## `setMeasureAdvancedGroupType`
|
|
2254
|
+
|
|
2255
|
+
Advanced group type
|
|
2256
|
+
|
|
2257
|
+
Set comparison group type for share total advanced calculation
|
|
2258
|
+
|
|
2259
|
+
**Payload schema**
|
|
2260
|
+
|
|
2261
|
+
```json
|
|
2262
|
+
{
|
|
2263
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2264
|
+
"type": "object",
|
|
2265
|
+
"properties": {
|
|
2266
|
+
"dataItemInternalKey": {
|
|
2267
|
+
"type": "string",
|
|
2268
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2269
|
+
},
|
|
2270
|
+
"dataItemUniqueSignature": {
|
|
2271
|
+
"type": "string",
|
|
2272
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2273
|
+
},
|
|
2274
|
+
"collectionKey": {
|
|
2275
|
+
"description": "Measure collection key",
|
|
2276
|
+
"type": "string",
|
|
2277
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2278
|
+
},
|
|
2279
|
+
"advancedOperationKey": {
|
|
2280
|
+
"description": "Advanced operation key",
|
|
2281
|
+
"type": "string",
|
|
2282
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2283
|
+
},
|
|
2284
|
+
"groupType": {
|
|
2285
|
+
"type": "string",
|
|
2286
|
+
"enum": ["value", "diff", "ratio", "growth"]
|
|
2287
|
+
}
|
|
2288
|
+
},
|
|
2289
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "groupType"],
|
|
2290
|
+
"additionalProperties": false,
|
|
2291
|
+
"title": "Measure advanced group type schema"
|
|
2292
|
+
}
|
|
2293
|
+
```
|
|
2294
|
+
|
|
2295
|
+
## `setMeasureAdvancedNonTimePeriod`
|
|
2296
|
+
|
|
2297
|
+
Advanced nested time dimension
|
|
2298
|
+
|
|
2299
|
+
Enable or disable nested time dimension
|
|
2300
|
+
|
|
2301
|
+
**Payload schema**
|
|
2302
|
+
|
|
2303
|
+
```json
|
|
2304
|
+
{
|
|
2305
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2306
|
+
"type": "object",
|
|
2307
|
+
"properties": {
|
|
2308
|
+
"dataItemInternalKey": {
|
|
2309
|
+
"type": "string",
|
|
2310
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2311
|
+
},
|
|
2312
|
+
"dataItemUniqueSignature": {
|
|
2313
|
+
"type": "string",
|
|
2314
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2315
|
+
},
|
|
2316
|
+
"collectionKey": {
|
|
2317
|
+
"description": "Measure collection key",
|
|
2318
|
+
"type": "string",
|
|
2319
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2320
|
+
},
|
|
2321
|
+
"advancedOperationKey": {
|
|
2322
|
+
"description": "Advanced operation key",
|
|
2323
|
+
"type": "string",
|
|
2324
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2325
|
+
},
|
|
2326
|
+
"nonTimePeriod": {
|
|
2327
|
+
"type": "boolean"
|
|
2328
|
+
}
|
|
2329
|
+
},
|
|
2330
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriod"],
|
|
2331
|
+
"additionalProperties": false,
|
|
2332
|
+
"title": "Measure advanced nested time dimension schema"
|
|
2333
|
+
}
|
|
2334
|
+
```
|
|
2335
|
+
|
|
2336
|
+
## `setMeasureAdvancedNonTimePeriodGranularity`
|
|
2337
|
+
|
|
2338
|
+
Advanced non-time period granularity
|
|
2339
|
+
|
|
2340
|
+
Set non-time period granularity for inter-record calculations
|
|
2341
|
+
|
|
2342
|
+
**Payload schema**
|
|
2343
|
+
|
|
2344
|
+
```json
|
|
2345
|
+
{
|
|
2346
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2347
|
+
"type": "object",
|
|
2348
|
+
"properties": {
|
|
2349
|
+
"dataItemInternalKey": {
|
|
2350
|
+
"type": "string",
|
|
2351
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2352
|
+
},
|
|
2353
|
+
"dataItemUniqueSignature": {
|
|
2354
|
+
"type": "string",
|
|
2355
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2356
|
+
},
|
|
2357
|
+
"collectionKey": {
|
|
2358
|
+
"description": "Measure collection key",
|
|
2359
|
+
"type": "string",
|
|
2360
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2361
|
+
},
|
|
2362
|
+
"advancedOperationKey": {
|
|
2363
|
+
"description": "Advanced operation key",
|
|
2364
|
+
"type": "string",
|
|
2365
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2366
|
+
},
|
|
2367
|
+
"nonTimePeriodGranularity": {
|
|
2368
|
+
"type": "string",
|
|
2369
|
+
"enum": ["day", "week", "month", "quarter", "year"]
|
|
2370
|
+
}
|
|
2371
|
+
},
|
|
2372
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "nonTimePeriodGranularity"],
|
|
2373
|
+
"additionalProperties": false,
|
|
2374
|
+
"title": "Measure advanced non-time period granularity schema"
|
|
2375
|
+
}
|
|
2376
|
+
```
|
|
2377
|
+
|
|
2378
|
+
## `setMeasureAdvancedNullIfNotEnoughValues`
|
|
2379
|
+
|
|
2380
|
+
Advanced null if not enough values
|
|
2381
|
+
|
|
2382
|
+
Enable or disable null-if-not-enough-values for moving calculation
|
|
2383
|
+
|
|
2384
|
+
**Payload schema**
|
|
2385
|
+
|
|
2386
|
+
```json
|
|
2387
|
+
{
|
|
2388
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2389
|
+
"type": "object",
|
|
2390
|
+
"properties": {
|
|
2391
|
+
"dataItemInternalKey": {
|
|
2392
|
+
"type": "string",
|
|
2393
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2394
|
+
},
|
|
2395
|
+
"dataItemUniqueSignature": {
|
|
2396
|
+
"type": "string",
|
|
2397
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2398
|
+
},
|
|
2399
|
+
"collectionKey": {
|
|
2400
|
+
"description": "Measure collection key",
|
|
2401
|
+
"type": "string",
|
|
2402
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2403
|
+
},
|
|
2404
|
+
"advancedOperationKey": {
|
|
2405
|
+
"description": "Advanced operation key",
|
|
2406
|
+
"type": "string",
|
|
2407
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2408
|
+
},
|
|
2409
|
+
"nullIfNotEnoughValues": {
|
|
2410
|
+
"type": "boolean"
|
|
2411
|
+
}
|
|
2412
|
+
},
|
|
2413
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "nullIfNotEnoughValues"],
|
|
2414
|
+
"additionalProperties": false,
|
|
2415
|
+
"title": "Measure advanced null if not enough values schema"
|
|
2416
|
+
}
|
|
2417
|
+
```
|
|
2418
|
+
|
|
2419
|
+
## `setMeasureAdvancedOffset`
|
|
2420
|
+
|
|
2421
|
+
Advanced compare with period offset
|
|
2422
|
+
|
|
2423
|
+
Set compare-with-period offset for advanced calculation
|
|
2424
|
+
|
|
2425
|
+
**Payload schema**
|
|
2426
|
+
|
|
2427
|
+
```json
|
|
2428
|
+
{
|
|
2429
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2430
|
+
"type": "object",
|
|
2431
|
+
"properties": {
|
|
2432
|
+
"dataItemInternalKey": {
|
|
2433
|
+
"type": "string",
|
|
2434
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2435
|
+
},
|
|
2436
|
+
"dataItemUniqueSignature": {
|
|
2437
|
+
"type": "string",
|
|
2438
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2439
|
+
},
|
|
2440
|
+
"collectionKey": {
|
|
2441
|
+
"description": "Measure collection key",
|
|
2442
|
+
"type": "string",
|
|
2443
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2444
|
+
},
|
|
2445
|
+
"advancedOperationKey": {
|
|
2446
|
+
"description": "Advanced operation key",
|
|
2447
|
+
"type": "string",
|
|
2448
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2449
|
+
},
|
|
2450
|
+
"offset": {
|
|
2451
|
+
"anyOf": [
|
|
2452
|
+
{
|
|
2453
|
+
"type": "number"
|
|
2454
|
+
},
|
|
2455
|
+
{
|
|
2456
|
+
"type": "object",
|
|
2457
|
+
"properties": {
|
|
2458
|
+
"type": {
|
|
2459
|
+
"type": "string",
|
|
2460
|
+
"const": "variable"
|
|
2461
|
+
},
|
|
2462
|
+
"variableName": {
|
|
2463
|
+
"type": "string"
|
|
2464
|
+
}
|
|
2465
|
+
},
|
|
2466
|
+
"required": ["type", "variableName"],
|
|
2467
|
+
"additionalProperties": false
|
|
2468
|
+
}
|
|
2469
|
+
]
|
|
2470
|
+
}
|
|
2471
|
+
},
|
|
2472
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "offset"],
|
|
2473
|
+
"additionalProperties": false,
|
|
2474
|
+
"title": "Measure advanced offset schema"
|
|
2475
|
+
}
|
|
2476
|
+
```
|
|
2477
|
+
|
|
2478
|
+
## `setMeasureAdvancedParameter`
|
|
2479
|
+
|
|
2480
|
+
Advanced parameter
|
|
2481
|
+
|
|
2482
|
+
Set value for advanced operation parameter
|
|
2483
|
+
|
|
2484
|
+
**Payload schema**
|
|
2485
|
+
|
|
2486
|
+
```json
|
|
2487
|
+
{
|
|
2488
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2489
|
+
"type": "object",
|
|
2490
|
+
"properties": {
|
|
2491
|
+
"dataItemInternalKey": {
|
|
2492
|
+
"type": "string",
|
|
2493
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2494
|
+
},
|
|
2495
|
+
"dataItemUniqueSignature": {
|
|
2496
|
+
"type": "string",
|
|
2497
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2498
|
+
},
|
|
2499
|
+
"collectionKey": {
|
|
2500
|
+
"description": "Measure collection key",
|
|
2501
|
+
"type": "string",
|
|
2502
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2503
|
+
},
|
|
2504
|
+
"advancedOperationKey": {
|
|
2505
|
+
"description": "Advanced operation key",
|
|
2506
|
+
"type": "string",
|
|
2507
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2508
|
+
},
|
|
2509
|
+
"variableName": {
|
|
2510
|
+
"type": "string",
|
|
2511
|
+
"description": "Name of advanced operation parameter to update"
|
|
2512
|
+
},
|
|
2513
|
+
"value": {
|
|
2514
|
+
"type": "object",
|
|
2515
|
+
"properties": {
|
|
2516
|
+
"value": {
|
|
2517
|
+
"anyOf": [
|
|
2518
|
+
{
|
|
2519
|
+
"anyOf": [
|
|
2520
|
+
{
|
|
2521
|
+
"type": "string"
|
|
2522
|
+
},
|
|
2523
|
+
{
|
|
2524
|
+
"type": "object",
|
|
2525
|
+
"properties": {
|
|
2526
|
+
"type": {
|
|
2527
|
+
"type": "string",
|
|
2528
|
+
"const": "variable"
|
|
2529
|
+
},
|
|
2530
|
+
"variableName": {
|
|
2531
|
+
"type": "string"
|
|
2532
|
+
}
|
|
2533
|
+
},
|
|
2534
|
+
"required": ["type", "variableName"],
|
|
2535
|
+
"additionalProperties": false
|
|
2536
|
+
}
|
|
2537
|
+
]
|
|
2538
|
+
},
|
|
2539
|
+
{
|
|
2540
|
+
"anyOf": [
|
|
2541
|
+
{
|
|
2542
|
+
"type": "number"
|
|
2543
|
+
},
|
|
2544
|
+
{
|
|
2545
|
+
"type": "object",
|
|
2546
|
+
"properties": {
|
|
2547
|
+
"type": {
|
|
2548
|
+
"type": "string",
|
|
2549
|
+
"const": "variable"
|
|
2550
|
+
},
|
|
2551
|
+
"variableName": {
|
|
2552
|
+
"type": "string"
|
|
2553
|
+
}
|
|
2554
|
+
},
|
|
2555
|
+
"required": ["type", "variableName"],
|
|
2556
|
+
"additionalProperties": false
|
|
2557
|
+
}
|
|
2558
|
+
]
|
|
2559
|
+
},
|
|
2560
|
+
{
|
|
2561
|
+
"anyOf": [
|
|
2562
|
+
{
|
|
2563
|
+
"type": "boolean"
|
|
2564
|
+
},
|
|
2565
|
+
{
|
|
2566
|
+
"type": "object",
|
|
2567
|
+
"properties": {
|
|
2568
|
+
"type": {
|
|
2569
|
+
"type": "string",
|
|
2570
|
+
"const": "variable"
|
|
2571
|
+
},
|
|
2572
|
+
"variableName": {
|
|
2573
|
+
"type": "string"
|
|
2574
|
+
}
|
|
2575
|
+
},
|
|
2576
|
+
"required": ["type", "variableName"],
|
|
2577
|
+
"additionalProperties": false
|
|
2578
|
+
}
|
|
2579
|
+
]
|
|
2580
|
+
}
|
|
2581
|
+
]
|
|
2582
|
+
},
|
|
2583
|
+
"dataType": {
|
|
2584
|
+
"type": "string",
|
|
2585
|
+
"enum": ["string", "int", "float", "boolean", "date", "millisec", "millisec_tz", "timestamp", "timestamp_tz"]
|
|
2586
|
+
}
|
|
2587
|
+
},
|
|
2588
|
+
"required": ["value"],
|
|
2589
|
+
"additionalProperties": false
|
|
2590
|
+
}
|
|
2591
|
+
},
|
|
2592
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "variableName", "value"],
|
|
2593
|
+
"additionalProperties": false,
|
|
2594
|
+
"title": "Set measure advanced parameter schema"
|
|
2595
|
+
}
|
|
2596
|
+
```
|
|
2597
|
+
|
|
2598
|
+
## `setMeasureAdvancedPercentileApprox`
|
|
2599
|
+
|
|
2600
|
+
Advanced percentile approx
|
|
2601
|
+
|
|
2602
|
+
Enable or disable approximate percentile mode
|
|
2603
|
+
|
|
2604
|
+
**Payload schema**
|
|
2605
|
+
|
|
2606
|
+
```json
|
|
2607
|
+
{
|
|
2608
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2609
|
+
"type": "object",
|
|
2610
|
+
"properties": {
|
|
2611
|
+
"dataItemInternalKey": {
|
|
2612
|
+
"type": "string",
|
|
2613
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2614
|
+
},
|
|
2615
|
+
"dataItemUniqueSignature": {
|
|
2616
|
+
"type": "string",
|
|
2617
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2618
|
+
},
|
|
2619
|
+
"collectionKey": {
|
|
2620
|
+
"description": "Measure collection key",
|
|
2621
|
+
"type": "string",
|
|
2622
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2623
|
+
},
|
|
2624
|
+
"advancedOperationKey": {
|
|
2625
|
+
"description": "Advanced operation key",
|
|
2626
|
+
"type": "string",
|
|
2627
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2628
|
+
},
|
|
2629
|
+
"percentileApprox": {
|
|
2630
|
+
"type": "boolean"
|
|
2631
|
+
}
|
|
2632
|
+
},
|
|
2633
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileApprox"],
|
|
2634
|
+
"additionalProperties": false,
|
|
2635
|
+
"title": "Measure advanced percentile approx schema"
|
|
2636
|
+
}
|
|
2637
|
+
```
|
|
2638
|
+
|
|
2639
|
+
## `setMeasureAdvancedPercentileContinuous`
|
|
2640
|
+
|
|
2641
|
+
Advanced percentile continuous
|
|
2642
|
+
|
|
2643
|
+
Enable or disable continuous percentile mode
|
|
2644
|
+
|
|
2645
|
+
**Payload schema**
|
|
2646
|
+
|
|
2647
|
+
```json
|
|
2648
|
+
{
|
|
2649
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2650
|
+
"type": "object",
|
|
2651
|
+
"properties": {
|
|
2652
|
+
"dataItemInternalKey": {
|
|
2653
|
+
"type": "string",
|
|
2654
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2655
|
+
},
|
|
2656
|
+
"dataItemUniqueSignature": {
|
|
2657
|
+
"type": "string",
|
|
2658
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2659
|
+
},
|
|
2660
|
+
"collectionKey": {
|
|
2661
|
+
"description": "Measure collection key",
|
|
2662
|
+
"type": "string",
|
|
2663
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2664
|
+
},
|
|
2665
|
+
"advancedOperationKey": {
|
|
2666
|
+
"description": "Advanced operation key",
|
|
2667
|
+
"type": "string",
|
|
2668
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2669
|
+
},
|
|
2670
|
+
"percentileContinuous": {
|
|
2671
|
+
"type": "boolean"
|
|
2672
|
+
}
|
|
2673
|
+
},
|
|
2674
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileContinuous"],
|
|
2675
|
+
"additionalProperties": false,
|
|
2676
|
+
"title": "Measure advanced percentile continuous schema"
|
|
2677
|
+
}
|
|
2678
|
+
```
|
|
2679
|
+
|
|
2680
|
+
## `setMeasureAdvancedPercentileValue`
|
|
2681
|
+
|
|
2682
|
+
Advanced percentile value
|
|
2683
|
+
|
|
2684
|
+
Set percentile value for percentile aggregation
|
|
2685
|
+
|
|
2686
|
+
**Payload schema**
|
|
2687
|
+
|
|
2688
|
+
```json
|
|
2689
|
+
{
|
|
2690
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2691
|
+
"type": "object",
|
|
2692
|
+
"properties": {
|
|
2693
|
+
"dataItemInternalKey": {
|
|
2694
|
+
"type": "string",
|
|
2695
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2696
|
+
},
|
|
2697
|
+
"dataItemUniqueSignature": {
|
|
2698
|
+
"type": "string",
|
|
2699
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2700
|
+
},
|
|
2701
|
+
"collectionKey": {
|
|
2702
|
+
"description": "Measure collection key",
|
|
2703
|
+
"type": "string",
|
|
2704
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2705
|
+
},
|
|
2706
|
+
"advancedOperationKey": {
|
|
2707
|
+
"description": "Advanced operation key",
|
|
2708
|
+
"type": "string",
|
|
2709
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2710
|
+
},
|
|
2711
|
+
"percentileValue": {
|
|
2712
|
+
"anyOf": [
|
|
2713
|
+
{
|
|
2714
|
+
"type": "number"
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"type": "object",
|
|
2718
|
+
"properties": {
|
|
2719
|
+
"type": {
|
|
2720
|
+
"type": "string",
|
|
2721
|
+
"const": "variable"
|
|
2722
|
+
},
|
|
2723
|
+
"variableName": {
|
|
2724
|
+
"type": "string"
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
"required": ["type", "variableName"],
|
|
2728
|
+
"additionalProperties": false
|
|
2729
|
+
}
|
|
2730
|
+
]
|
|
2731
|
+
}
|
|
2732
|
+
},
|
|
2733
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "percentileValue"],
|
|
2734
|
+
"additionalProperties": false,
|
|
2735
|
+
"title": "Measure advanced percentile value schema"
|
|
2736
|
+
}
|
|
2737
|
+
```
|
|
2738
|
+
|
|
2739
|
+
## `setMeasureAdvancedPeriodsPerYear`
|
|
2740
|
+
|
|
2741
|
+
Advanced periods per year
|
|
2742
|
+
|
|
2743
|
+
Set number of periods in a year for annualized period growth
|
|
2744
|
+
|
|
2745
|
+
**Payload schema**
|
|
2746
|
+
|
|
2747
|
+
```json
|
|
2748
|
+
{
|
|
2749
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2750
|
+
"type": "object",
|
|
2751
|
+
"properties": {
|
|
2752
|
+
"dataItemInternalKey": {
|
|
2753
|
+
"type": "string",
|
|
2754
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2755
|
+
},
|
|
2756
|
+
"dataItemUniqueSignature": {
|
|
2757
|
+
"type": "string",
|
|
2758
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2759
|
+
},
|
|
2760
|
+
"collectionKey": {
|
|
2761
|
+
"description": "Measure collection key",
|
|
2762
|
+
"type": "string",
|
|
2763
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2764
|
+
},
|
|
2765
|
+
"advancedOperationKey": {
|
|
2766
|
+
"description": "Advanced operation key",
|
|
2767
|
+
"type": "string",
|
|
2768
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2769
|
+
},
|
|
2770
|
+
"periodsPerYear": {
|
|
2771
|
+
"anyOf": [
|
|
2772
|
+
{
|
|
2773
|
+
"type": "number"
|
|
2774
|
+
},
|
|
2775
|
+
{
|
|
2776
|
+
"type": "object",
|
|
2777
|
+
"properties": {
|
|
2778
|
+
"type": {
|
|
2779
|
+
"type": "string",
|
|
2780
|
+
"const": "variable"
|
|
2781
|
+
},
|
|
2782
|
+
"variableName": {
|
|
2783
|
+
"type": "string"
|
|
2784
|
+
}
|
|
2785
|
+
},
|
|
2786
|
+
"required": ["type", "variableName"],
|
|
2787
|
+
"additionalProperties": false
|
|
2788
|
+
}
|
|
2789
|
+
]
|
|
2790
|
+
}
|
|
2791
|
+
},
|
|
2792
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "periodsPerYear"],
|
|
2793
|
+
"additionalProperties": false,
|
|
2794
|
+
"title": "Measure advanced periods per year schema"
|
|
2795
|
+
}
|
|
2796
|
+
```
|
|
2797
|
+
|
|
2798
|
+
## `setMeasureAdvancedRangesComparisonEnabled`
|
|
2799
|
+
|
|
2800
|
+
Advanced ranges comparison enabled
|
|
2801
|
+
|
|
2802
|
+
Enable or disable ranges comparison
|
|
2803
|
+
|
|
2804
|
+
**Payload schema**
|
|
2805
|
+
|
|
2806
|
+
```json
|
|
2807
|
+
{
|
|
2808
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2809
|
+
"type": "object",
|
|
2810
|
+
"properties": {
|
|
2811
|
+
"dataItemInternalKey": {
|
|
2812
|
+
"type": "string",
|
|
2813
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2814
|
+
},
|
|
2815
|
+
"dataItemUniqueSignature": {
|
|
2816
|
+
"type": "string",
|
|
2817
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2818
|
+
},
|
|
2819
|
+
"collectionKey": {
|
|
2820
|
+
"description": "Measure collection key",
|
|
2821
|
+
"type": "string",
|
|
2822
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2823
|
+
},
|
|
2824
|
+
"advancedOperationKey": {
|
|
2825
|
+
"description": "Advanced operation key",
|
|
2826
|
+
"type": "string",
|
|
2827
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2828
|
+
},
|
|
2829
|
+
"enabled": {
|
|
2830
|
+
"type": "boolean"
|
|
2831
|
+
}
|
|
2832
|
+
},
|
|
2833
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
|
|
2834
|
+
"additionalProperties": false,
|
|
2835
|
+
"title": "Measure advanced ranges comparison enabled schema"
|
|
2836
|
+
}
|
|
2837
|
+
```
|
|
2838
|
+
|
|
2839
|
+
## `setMeasureAdvancedRangesComparisonFirstRangeEnd`
|
|
2840
|
+
|
|
2841
|
+
Advanced ranges first range end
|
|
2842
|
+
|
|
2843
|
+
Set first range end for ranges comparison
|
|
2844
|
+
|
|
2845
|
+
**Payload schema**
|
|
2846
|
+
|
|
2847
|
+
```json
|
|
2848
|
+
{
|
|
2849
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2850
|
+
"type": "object",
|
|
2851
|
+
"properties": {
|
|
2852
|
+
"dataItemInternalKey": {
|
|
2853
|
+
"type": "string",
|
|
2854
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2855
|
+
},
|
|
2856
|
+
"dataItemUniqueSignature": {
|
|
2857
|
+
"type": "string",
|
|
2858
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2859
|
+
},
|
|
2860
|
+
"collectionKey": {
|
|
2861
|
+
"description": "Measure collection key",
|
|
2862
|
+
"type": "string",
|
|
2863
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2864
|
+
},
|
|
2865
|
+
"advancedOperationKey": {
|
|
2866
|
+
"description": "Advanced operation key",
|
|
2867
|
+
"type": "string",
|
|
2868
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2869
|
+
},
|
|
2870
|
+
"firstRangeEnd": {
|
|
2871
|
+
"anyOf": [
|
|
2872
|
+
{
|
|
2873
|
+
"type": "number"
|
|
2874
|
+
},
|
|
2875
|
+
{
|
|
2876
|
+
"type": "object",
|
|
2877
|
+
"properties": {
|
|
2878
|
+
"type": {
|
|
2879
|
+
"type": "string",
|
|
2880
|
+
"const": "variable"
|
|
2881
|
+
},
|
|
2882
|
+
"variableName": {
|
|
2883
|
+
"type": "string"
|
|
2884
|
+
}
|
|
2885
|
+
},
|
|
2886
|
+
"required": ["type", "variableName"],
|
|
2887
|
+
"additionalProperties": false
|
|
2888
|
+
}
|
|
2889
|
+
]
|
|
2890
|
+
}
|
|
2891
|
+
},
|
|
2892
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeEnd"],
|
|
2893
|
+
"additionalProperties": false,
|
|
2894
|
+
"title": "Measure advanced ranges first range end schema"
|
|
2895
|
+
}
|
|
2896
|
+
```
|
|
2897
|
+
|
|
2898
|
+
## `setMeasureAdvancedRangesComparisonFirstRangeStart`
|
|
2899
|
+
|
|
2900
|
+
Advanced ranges first range start
|
|
2901
|
+
|
|
2902
|
+
Set first range start for ranges comparison
|
|
2903
|
+
|
|
2904
|
+
**Payload schema**
|
|
2905
|
+
|
|
2906
|
+
```json
|
|
2907
|
+
{
|
|
2908
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2909
|
+
"type": "object",
|
|
2910
|
+
"properties": {
|
|
2911
|
+
"dataItemInternalKey": {
|
|
2912
|
+
"type": "string",
|
|
2913
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2914
|
+
},
|
|
2915
|
+
"dataItemUniqueSignature": {
|
|
2916
|
+
"type": "string",
|
|
2917
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2918
|
+
},
|
|
2919
|
+
"collectionKey": {
|
|
2920
|
+
"description": "Measure collection key",
|
|
2921
|
+
"type": "string",
|
|
2922
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2923
|
+
},
|
|
2924
|
+
"advancedOperationKey": {
|
|
2925
|
+
"description": "Advanced operation key",
|
|
2926
|
+
"type": "string",
|
|
2927
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2928
|
+
},
|
|
2929
|
+
"firstRangeStart": {
|
|
2930
|
+
"anyOf": [
|
|
2931
|
+
{
|
|
2932
|
+
"type": "number"
|
|
2933
|
+
},
|
|
2934
|
+
{
|
|
2935
|
+
"type": "object",
|
|
2936
|
+
"properties": {
|
|
2937
|
+
"type": {
|
|
2938
|
+
"type": "string",
|
|
2939
|
+
"const": "variable"
|
|
2940
|
+
},
|
|
2941
|
+
"variableName": {
|
|
2942
|
+
"type": "string"
|
|
2943
|
+
}
|
|
2944
|
+
},
|
|
2945
|
+
"required": ["type", "variableName"],
|
|
2946
|
+
"additionalProperties": false
|
|
2947
|
+
}
|
|
2948
|
+
]
|
|
2949
|
+
}
|
|
2950
|
+
},
|
|
2951
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "firstRangeStart"],
|
|
2952
|
+
"additionalProperties": false,
|
|
2953
|
+
"title": "Measure advanced ranges first range start schema"
|
|
2954
|
+
}
|
|
2955
|
+
```
|
|
2956
|
+
|
|
2957
|
+
## `setMeasureAdvancedRangesComparisonSecondRangeEnd`
|
|
2958
|
+
|
|
2959
|
+
Advanced ranges second range end
|
|
2960
|
+
|
|
2961
|
+
Set second range end for ranges comparison
|
|
2962
|
+
|
|
2963
|
+
**Payload schema**
|
|
2964
|
+
|
|
2965
|
+
```json
|
|
2966
|
+
{
|
|
2967
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2968
|
+
"type": "object",
|
|
2969
|
+
"properties": {
|
|
2970
|
+
"dataItemInternalKey": {
|
|
2971
|
+
"type": "string",
|
|
2972
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
2973
|
+
},
|
|
2974
|
+
"dataItemUniqueSignature": {
|
|
2975
|
+
"type": "string",
|
|
2976
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
2977
|
+
},
|
|
2978
|
+
"collectionKey": {
|
|
2979
|
+
"description": "Measure collection key",
|
|
2980
|
+
"type": "string",
|
|
2981
|
+
"enum": ["measures", "supportingMeasures"]
|
|
2982
|
+
},
|
|
2983
|
+
"advancedOperationKey": {
|
|
2984
|
+
"description": "Advanced operation key",
|
|
2985
|
+
"type": "string",
|
|
2986
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
2987
|
+
},
|
|
2988
|
+
"secondRangeEnd": {
|
|
2989
|
+
"anyOf": [
|
|
2990
|
+
{
|
|
2991
|
+
"type": "number"
|
|
2992
|
+
},
|
|
2993
|
+
{
|
|
2994
|
+
"type": "object",
|
|
2995
|
+
"properties": {
|
|
2996
|
+
"type": {
|
|
2997
|
+
"type": "string",
|
|
2998
|
+
"const": "variable"
|
|
2999
|
+
},
|
|
3000
|
+
"variableName": {
|
|
3001
|
+
"type": "string"
|
|
3002
|
+
}
|
|
3003
|
+
},
|
|
3004
|
+
"required": ["type", "variableName"],
|
|
3005
|
+
"additionalProperties": false
|
|
3006
|
+
}
|
|
3007
|
+
]
|
|
3008
|
+
}
|
|
3009
|
+
},
|
|
3010
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeEnd"],
|
|
3011
|
+
"additionalProperties": false,
|
|
3012
|
+
"title": "Measure advanced ranges second range end schema"
|
|
3013
|
+
}
|
|
3014
|
+
```
|
|
3015
|
+
|
|
3016
|
+
## `setMeasureAdvancedRangesComparisonSecondRangeStart`
|
|
3017
|
+
|
|
3018
|
+
Advanced ranges second range start
|
|
3019
|
+
|
|
3020
|
+
Set second range start for ranges comparison
|
|
3021
|
+
|
|
3022
|
+
**Payload schema**
|
|
3023
|
+
|
|
3024
|
+
```json
|
|
3025
|
+
{
|
|
3026
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3027
|
+
"type": "object",
|
|
3028
|
+
"properties": {
|
|
3029
|
+
"dataItemInternalKey": {
|
|
3030
|
+
"type": "string",
|
|
3031
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3032
|
+
},
|
|
3033
|
+
"dataItemUniqueSignature": {
|
|
3034
|
+
"type": "string",
|
|
3035
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3036
|
+
},
|
|
3037
|
+
"collectionKey": {
|
|
3038
|
+
"description": "Measure collection key",
|
|
3039
|
+
"type": "string",
|
|
3040
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3041
|
+
},
|
|
3042
|
+
"advancedOperationKey": {
|
|
3043
|
+
"description": "Advanced operation key",
|
|
3044
|
+
"type": "string",
|
|
3045
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3046
|
+
},
|
|
3047
|
+
"secondRangeStart": {
|
|
3048
|
+
"anyOf": [
|
|
3049
|
+
{
|
|
3050
|
+
"type": "number"
|
|
3051
|
+
},
|
|
3052
|
+
{
|
|
3053
|
+
"type": "object",
|
|
3054
|
+
"properties": {
|
|
3055
|
+
"type": {
|
|
3056
|
+
"type": "string",
|
|
3057
|
+
"const": "variable"
|
|
3058
|
+
},
|
|
3059
|
+
"variableName": {
|
|
3060
|
+
"type": "string"
|
|
3061
|
+
}
|
|
3062
|
+
},
|
|
3063
|
+
"required": ["type", "variableName"],
|
|
3064
|
+
"additionalProperties": false
|
|
3065
|
+
}
|
|
3066
|
+
]
|
|
3067
|
+
}
|
|
3068
|
+
},
|
|
3069
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "secondRangeStart"],
|
|
3070
|
+
"additionalProperties": false,
|
|
3071
|
+
"title": "Measure advanced ranges second range start schema"
|
|
3072
|
+
}
|
|
3073
|
+
```
|
|
3074
|
+
|
|
3075
|
+
## `setMeasureAdvancedRangesComparisonType`
|
|
3076
|
+
|
|
3077
|
+
Advanced ranges comparison type
|
|
3078
|
+
|
|
3079
|
+
Set ranges comparison type
|
|
3080
|
+
|
|
3081
|
+
**Payload schema**
|
|
3082
|
+
|
|
3083
|
+
```json
|
|
3084
|
+
{
|
|
3085
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3086
|
+
"type": "object",
|
|
3087
|
+
"properties": {
|
|
3088
|
+
"dataItemInternalKey": {
|
|
3089
|
+
"type": "string",
|
|
3090
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3091
|
+
},
|
|
3092
|
+
"dataItemUniqueSignature": {
|
|
3093
|
+
"type": "string",
|
|
3094
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3095
|
+
},
|
|
3096
|
+
"collectionKey": {
|
|
3097
|
+
"description": "Measure collection key",
|
|
3098
|
+
"type": "string",
|
|
3099
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3100
|
+
},
|
|
3101
|
+
"advancedOperationKey": {
|
|
3102
|
+
"description": "Advanced operation key",
|
|
3103
|
+
"type": "string",
|
|
3104
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3105
|
+
},
|
|
3106
|
+
"type": {
|
|
3107
|
+
"type": "string",
|
|
3108
|
+
"enum": ["absolute", "percentage"]
|
|
3109
|
+
}
|
|
3110
|
+
},
|
|
3111
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "type"],
|
|
3112
|
+
"additionalProperties": false,
|
|
3113
|
+
"title": "Measure advanced ranges comparison type schema"
|
|
3114
|
+
}
|
|
3115
|
+
```
|
|
3116
|
+
|
|
3117
|
+
## `setMeasureAdvancedRankSortDirection`
|
|
3118
|
+
|
|
3119
|
+
Advanced rank sort direction
|
|
3120
|
+
|
|
3121
|
+
Set rank sort direction for rank advanced calculation
|
|
3122
|
+
|
|
3123
|
+
**Payload schema**
|
|
3124
|
+
|
|
3125
|
+
```json
|
|
3126
|
+
{
|
|
3127
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3128
|
+
"type": "object",
|
|
3129
|
+
"properties": {
|
|
3130
|
+
"dataItemInternalKey": {
|
|
3131
|
+
"type": "string",
|
|
3132
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3133
|
+
},
|
|
3134
|
+
"dataItemUniqueSignature": {
|
|
3135
|
+
"type": "string",
|
|
3136
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3137
|
+
},
|
|
3138
|
+
"collectionKey": {
|
|
3139
|
+
"description": "Measure collection key",
|
|
3140
|
+
"type": "string",
|
|
3141
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3142
|
+
},
|
|
3143
|
+
"advancedOperationKey": {
|
|
3144
|
+
"description": "Advanced operation key",
|
|
3145
|
+
"type": "string",
|
|
3146
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3147
|
+
},
|
|
3148
|
+
"rankSortDirection": {
|
|
3149
|
+
"type": "string",
|
|
3150
|
+
"enum": ["asc", "desc"]
|
|
3151
|
+
}
|
|
3152
|
+
},
|
|
3153
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "rankSortDirection"],
|
|
3154
|
+
"additionalProperties": false,
|
|
3155
|
+
"title": "Measure advanced rank sort direction schema"
|
|
3156
|
+
}
|
|
3157
|
+
```
|
|
3158
|
+
|
|
3159
|
+
## `setMeasureAdvancedSortingOrder`
|
|
3160
|
+
|
|
3161
|
+
Advanced sorting order
|
|
3162
|
+
|
|
3163
|
+
Set sorting order used by advanced calculation
|
|
3164
|
+
|
|
3165
|
+
**Payload schema**
|
|
3166
|
+
|
|
3167
|
+
```json
|
|
3168
|
+
{
|
|
3169
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3170
|
+
"type": "object",
|
|
3171
|
+
"properties": {
|
|
3172
|
+
"dataItemInternalKey": {
|
|
3173
|
+
"type": "string",
|
|
3174
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3175
|
+
},
|
|
3176
|
+
"dataItemUniqueSignature": {
|
|
3177
|
+
"type": "string",
|
|
3178
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3179
|
+
},
|
|
3180
|
+
"collectionKey": {
|
|
3181
|
+
"description": "Measure collection key",
|
|
3182
|
+
"type": "string",
|
|
3183
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3184
|
+
},
|
|
3185
|
+
"advancedOperationKey": {
|
|
3186
|
+
"description": "Advanced operation key",
|
|
3187
|
+
"type": "string",
|
|
3188
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3189
|
+
},
|
|
3190
|
+
"sortingOrder": {
|
|
3191
|
+
"type": "array",
|
|
3192
|
+
"items": {
|
|
3193
|
+
"type": "object",
|
|
3194
|
+
"properties": {
|
|
3195
|
+
"id": {
|
|
3196
|
+
"type": "string"
|
|
3197
|
+
},
|
|
3198
|
+
"sortDirection": {
|
|
3199
|
+
"type": "string",
|
|
3200
|
+
"enum": ["asc", "desc"]
|
|
3201
|
+
}
|
|
3202
|
+
},
|
|
3203
|
+
"required": ["id", "sortDirection"],
|
|
3204
|
+
"additionalProperties": false
|
|
3205
|
+
}
|
|
3206
|
+
}
|
|
3207
|
+
},
|
|
3208
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "sortingOrder"],
|
|
3209
|
+
"additionalProperties": false,
|
|
3210
|
+
"title": "Measure advanced sorting order schema"
|
|
3211
|
+
}
|
|
3212
|
+
```
|
|
3213
|
+
|
|
3214
|
+
## `setMeasureAdvancedStandardDeviations`
|
|
3215
|
+
|
|
3216
|
+
Advanced standard deviations
|
|
3217
|
+
|
|
3218
|
+
Set standard deviations for outliers aggregation
|
|
3219
|
+
|
|
3220
|
+
**Payload schema**
|
|
3221
|
+
|
|
3222
|
+
```json
|
|
3223
|
+
{
|
|
3224
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3225
|
+
"type": "object",
|
|
3226
|
+
"properties": {
|
|
3227
|
+
"dataItemInternalKey": {
|
|
3228
|
+
"type": "string",
|
|
3229
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3230
|
+
},
|
|
3231
|
+
"dataItemUniqueSignature": {
|
|
3232
|
+
"type": "string",
|
|
3233
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3234
|
+
},
|
|
3235
|
+
"collectionKey": {
|
|
3236
|
+
"description": "Measure collection key",
|
|
3237
|
+
"type": "string",
|
|
3238
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3239
|
+
},
|
|
3240
|
+
"advancedOperationKey": {
|
|
3241
|
+
"description": "Advanced operation key",
|
|
3242
|
+
"type": "string",
|
|
3243
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3244
|
+
},
|
|
3245
|
+
"standardDeviations": {
|
|
3246
|
+
"anyOf": [
|
|
3247
|
+
{
|
|
3248
|
+
"type": "number"
|
|
3249
|
+
},
|
|
3250
|
+
{
|
|
3251
|
+
"type": "object",
|
|
3252
|
+
"properties": {
|
|
3253
|
+
"type": {
|
|
3254
|
+
"type": "string",
|
|
3255
|
+
"const": "variable"
|
|
3256
|
+
},
|
|
3257
|
+
"variableName": {
|
|
3258
|
+
"type": "string"
|
|
3259
|
+
}
|
|
3260
|
+
},
|
|
3261
|
+
"required": ["type", "variableName"],
|
|
3262
|
+
"additionalProperties": false
|
|
3263
|
+
}
|
|
3264
|
+
]
|
|
3265
|
+
}
|
|
3266
|
+
},
|
|
3267
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "standardDeviations"],
|
|
3268
|
+
"additionalProperties": false,
|
|
3269
|
+
"title": "Measure advanced standard deviations schema"
|
|
3270
|
+
}
|
|
3271
|
+
```
|
|
3272
|
+
|
|
3273
|
+
## `setMeasureAdvancedWindowBegin`
|
|
3274
|
+
|
|
3275
|
+
Advanced periods before
|
|
3276
|
+
|
|
3277
|
+
Set periods before for moving calculation
|
|
3278
|
+
|
|
3279
|
+
**Payload schema**
|
|
3280
|
+
|
|
3281
|
+
```json
|
|
3282
|
+
{
|
|
3283
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3284
|
+
"type": "object",
|
|
3285
|
+
"properties": {
|
|
3286
|
+
"dataItemInternalKey": {
|
|
3287
|
+
"type": "string",
|
|
3288
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3289
|
+
},
|
|
3290
|
+
"dataItemUniqueSignature": {
|
|
3291
|
+
"type": "string",
|
|
3292
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3293
|
+
},
|
|
3294
|
+
"collectionKey": {
|
|
3295
|
+
"description": "Measure collection key",
|
|
3296
|
+
"type": "string",
|
|
3297
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3298
|
+
},
|
|
3299
|
+
"advancedOperationKey": {
|
|
3300
|
+
"description": "Advanced operation key",
|
|
3301
|
+
"type": "string",
|
|
3302
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3303
|
+
},
|
|
3304
|
+
"windowBegin": {
|
|
3305
|
+
"anyOf": [
|
|
3306
|
+
{
|
|
3307
|
+
"type": "number"
|
|
3308
|
+
},
|
|
3309
|
+
{
|
|
3310
|
+
"type": "object",
|
|
3311
|
+
"properties": {
|
|
3312
|
+
"type": {
|
|
3313
|
+
"type": "string",
|
|
3314
|
+
"const": "variable"
|
|
3315
|
+
},
|
|
3316
|
+
"variableName": {
|
|
3317
|
+
"type": "string"
|
|
3318
|
+
}
|
|
3319
|
+
},
|
|
3320
|
+
"required": ["type", "variableName"],
|
|
3321
|
+
"additionalProperties": false
|
|
3322
|
+
}
|
|
3323
|
+
]
|
|
3324
|
+
}
|
|
3325
|
+
},
|
|
3326
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowBegin"],
|
|
3327
|
+
"additionalProperties": false,
|
|
3328
|
+
"title": "Measure advanced window begin schema"
|
|
3329
|
+
}
|
|
3330
|
+
```
|
|
3331
|
+
|
|
3332
|
+
## `setMeasureAdvancedWindowEnd`
|
|
3333
|
+
|
|
3334
|
+
Advanced periods after
|
|
3335
|
+
|
|
3336
|
+
Set periods after for moving calculation
|
|
3337
|
+
|
|
3338
|
+
**Payload schema**
|
|
3339
|
+
|
|
3340
|
+
```json
|
|
3341
|
+
{
|
|
3342
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3343
|
+
"type": "object",
|
|
3344
|
+
"properties": {
|
|
3345
|
+
"dataItemInternalKey": {
|
|
3346
|
+
"type": "string",
|
|
3347
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3348
|
+
},
|
|
3349
|
+
"dataItemUniqueSignature": {
|
|
3350
|
+
"type": "string",
|
|
3351
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3352
|
+
},
|
|
3353
|
+
"collectionKey": {
|
|
3354
|
+
"description": "Measure collection key",
|
|
3355
|
+
"type": "string",
|
|
3356
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3357
|
+
},
|
|
3358
|
+
"advancedOperationKey": {
|
|
3359
|
+
"description": "Advanced operation key",
|
|
3360
|
+
"type": "string",
|
|
3361
|
+
"enum": ["advancedCalculation", "nestedCalculation"]
|
|
3362
|
+
},
|
|
3363
|
+
"windowEnd": {
|
|
3364
|
+
"anyOf": [
|
|
3365
|
+
{
|
|
3366
|
+
"type": "number"
|
|
3367
|
+
},
|
|
3368
|
+
{
|
|
3369
|
+
"type": "object",
|
|
3370
|
+
"properties": {
|
|
3371
|
+
"type": {
|
|
3372
|
+
"type": "string",
|
|
3373
|
+
"const": "variable"
|
|
3374
|
+
},
|
|
3375
|
+
"variableName": {
|
|
3376
|
+
"type": "string"
|
|
3377
|
+
}
|
|
3378
|
+
},
|
|
3379
|
+
"required": ["type", "variableName"],
|
|
3380
|
+
"additionalProperties": false
|
|
3381
|
+
}
|
|
3382
|
+
]
|
|
3383
|
+
}
|
|
3384
|
+
},
|
|
3385
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "windowEnd"],
|
|
3386
|
+
"additionalProperties": false,
|
|
3387
|
+
"title": "Measure advanced window end schema"
|
|
3388
|
+
}
|
|
3389
|
+
```
|
|
3390
|
+
|
|
3391
|
+
## `setMeasureCurrency`
|
|
3392
|
+
|
|
3393
|
+
Measure currency
|
|
3394
|
+
|
|
3395
|
+
Set the currency symbol used by a measure formatter
|
|
3396
|
+
|
|
3397
|
+
**Payload schema**
|
|
3398
|
+
|
|
3399
|
+
```json
|
|
3400
|
+
{
|
|
3401
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3402
|
+
"type": "object",
|
|
3403
|
+
"properties": {
|
|
3404
|
+
"dataItemInternalKey": {
|
|
3405
|
+
"type": "string",
|
|
3406
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3407
|
+
},
|
|
3408
|
+
"dataItemUniqueSignature": {
|
|
3409
|
+
"type": "string",
|
|
3410
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3411
|
+
},
|
|
3412
|
+
"currency": {
|
|
3413
|
+
"type": "string"
|
|
3414
|
+
}
|
|
3415
|
+
},
|
|
3416
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
3417
|
+
"additionalProperties": false,
|
|
3418
|
+
"title": "Measure currency schema"
|
|
3419
|
+
}
|
|
3420
|
+
```
|
|
3421
|
+
|
|
3422
|
+
## `setMeasureCurrencyIsPrefix`
|
|
3423
|
+
|
|
3424
|
+
Measure currency is prefix
|
|
3425
|
+
|
|
3426
|
+
Set whether measure currency symbol is prefixed
|
|
3427
|
+
|
|
3428
|
+
**Payload schema**
|
|
3429
|
+
|
|
3430
|
+
```json
|
|
3431
|
+
{
|
|
3432
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3433
|
+
"type": "object",
|
|
3434
|
+
"properties": {
|
|
3435
|
+
"dataItemInternalKey": {
|
|
3436
|
+
"type": "string",
|
|
3437
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3438
|
+
},
|
|
3439
|
+
"dataItemUniqueSignature": {
|
|
3440
|
+
"type": "string",
|
|
3441
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3442
|
+
},
|
|
3443
|
+
"currencyIsPrefix": {
|
|
3444
|
+
"type": "boolean"
|
|
3445
|
+
}
|
|
3446
|
+
},
|
|
3447
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
3448
|
+
"additionalProperties": false,
|
|
3449
|
+
"title": "Measure currency is prefix schema"
|
|
3450
|
+
}
|
|
3451
|
+
```
|
|
3452
|
+
|
|
3453
|
+
## `setMeasureDefinedParameter`
|
|
3454
|
+
|
|
3455
|
+
Measure defined parameter
|
|
3456
|
+
|
|
3457
|
+
Configure a Defined parameter of a custom measure using its default, a static value, or an existing compatible workbook variable
|
|
3458
|
+
|
|
3459
|
+
**Payload schema**
|
|
3460
|
+
|
|
3461
|
+
```json
|
|
3462
|
+
{
|
|
3463
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3464
|
+
"type": "object",
|
|
3465
|
+
"properties": {
|
|
3466
|
+
"dataItemInternalKey": {
|
|
3467
|
+
"type": "string",
|
|
3468
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3469
|
+
},
|
|
3470
|
+
"dataItemUniqueSignature": {
|
|
3471
|
+
"type": "string",
|
|
3472
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3473
|
+
},
|
|
3474
|
+
"collectionKey": {
|
|
3475
|
+
"description": "Measure collection to update. Defaults to primary measures.",
|
|
3476
|
+
"type": "string",
|
|
3477
|
+
"enum": ["measures", "supportingMeasures"]
|
|
3478
|
+
},
|
|
3479
|
+
"parameterName": {
|
|
3480
|
+
"type": "string",
|
|
3481
|
+
"minLength": 1,
|
|
3482
|
+
"description": "Exact name of a Defined parameter exposed by the measure"
|
|
3483
|
+
},
|
|
3484
|
+
"value": {
|
|
3485
|
+
"oneOf": [
|
|
3486
|
+
{
|
|
3487
|
+
"type": "object",
|
|
3488
|
+
"properties": {
|
|
3489
|
+
"type": {
|
|
3490
|
+
"type": "string",
|
|
3491
|
+
"const": "default"
|
|
3492
|
+
}
|
|
3493
|
+
},
|
|
3494
|
+
"required": ["type"],
|
|
3495
|
+
"additionalProperties": false
|
|
3496
|
+
},
|
|
3497
|
+
{
|
|
3498
|
+
"type": "object",
|
|
3499
|
+
"properties": {
|
|
3500
|
+
"type": {
|
|
3501
|
+
"type": "string",
|
|
3502
|
+
"const": "static"
|
|
3503
|
+
},
|
|
3504
|
+
"value": {
|
|
3505
|
+
"type": ["string", "number", "boolean"]
|
|
3506
|
+
}
|
|
3507
|
+
},
|
|
3508
|
+
"required": ["type", "value"],
|
|
3509
|
+
"additionalProperties": false
|
|
3510
|
+
},
|
|
3511
|
+
{
|
|
3512
|
+
"type": "object",
|
|
3513
|
+
"properties": {
|
|
3514
|
+
"type": {
|
|
3515
|
+
"type": "string",
|
|
3516
|
+
"const": "variable"
|
|
3517
|
+
},
|
|
3518
|
+
"variableName": {
|
|
3519
|
+
"type": "string",
|
|
3520
|
+
"minLength": 1,
|
|
3521
|
+
"description": "Exact name of an existing compatible workbook variable"
|
|
3522
|
+
}
|
|
3523
|
+
},
|
|
3524
|
+
"required": ["type", "variableName"],
|
|
3525
|
+
"additionalProperties": false
|
|
3526
|
+
}
|
|
3527
|
+
],
|
|
3528
|
+
"description": "Use default to remove the override, static for a literal value, or variable to bind a workbook variable"
|
|
3529
|
+
}
|
|
3530
|
+
},
|
|
3531
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "parameterName", "value"],
|
|
3532
|
+
"additionalProperties": false,
|
|
3533
|
+
"title": "Set measure defined parameter schema"
|
|
3534
|
+
}
|
|
3535
|
+
```
|
|
3536
|
+
|
|
3537
|
+
## `setMeasureFilter`
|
|
3538
|
+
|
|
3539
|
+
Set measure filter
|
|
3540
|
+
|
|
3541
|
+
Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.
|
|
3542
|
+
|
|
3543
|
+
**Payload schema**
|
|
3544
|
+
|
|
3545
|
+
```json
|
|
3546
|
+
{
|
|
3547
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3548
|
+
"anyOf": [
|
|
3549
|
+
{
|
|
3550
|
+
"type": "object",
|
|
3551
|
+
"properties": {
|
|
3552
|
+
"measureName": {
|
|
3553
|
+
"type": "string",
|
|
3554
|
+
"description": "Visible measure name or label"
|
|
3555
|
+
},
|
|
3556
|
+
"fieldKey": {
|
|
3557
|
+
"type": "string",
|
|
3558
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
3559
|
+
},
|
|
3560
|
+
"operator": {
|
|
3561
|
+
"type": "string",
|
|
3562
|
+
"enum": [
|
|
3563
|
+
"equals",
|
|
3564
|
+
"doesNotEqual",
|
|
3565
|
+
"greaterThan",
|
|
3566
|
+
"lessThan",
|
|
3567
|
+
"greaterThanOrEqualTo",
|
|
3568
|
+
"lessThanOrEqualTo",
|
|
3569
|
+
"contains",
|
|
3570
|
+
"excludes",
|
|
3571
|
+
"like",
|
|
3572
|
+
"notLike",
|
|
3573
|
+
"startsWith",
|
|
3574
|
+
"endsWith"
|
|
3575
|
+
],
|
|
3576
|
+
"description": "Filter operator that requires a value"
|
|
3577
|
+
},
|
|
3578
|
+
"value": {
|
|
3579
|
+
"anyOf": [
|
|
3580
|
+
{
|
|
3581
|
+
"type": "string"
|
|
3582
|
+
},
|
|
3583
|
+
{
|
|
3584
|
+
"type": "object",
|
|
3585
|
+
"properties": {
|
|
3586
|
+
"type": {
|
|
3587
|
+
"type": "string",
|
|
3588
|
+
"const": "variable"
|
|
3589
|
+
},
|
|
3590
|
+
"variableName": {
|
|
3591
|
+
"type": "string"
|
|
3592
|
+
}
|
|
3593
|
+
},
|
|
3594
|
+
"required": ["type", "variableName"],
|
|
3595
|
+
"additionalProperties": false
|
|
3596
|
+
}
|
|
3597
|
+
],
|
|
3598
|
+
"description": "Filter value"
|
|
3599
|
+
}
|
|
3600
|
+
},
|
|
3601
|
+
"required": ["measureName", "fieldKey", "operator", "value"],
|
|
3602
|
+
"additionalProperties": false
|
|
3603
|
+
},
|
|
3604
|
+
{
|
|
3605
|
+
"type": "object",
|
|
3606
|
+
"properties": {
|
|
3607
|
+
"measureName": {
|
|
3608
|
+
"type": "string",
|
|
3609
|
+
"description": "Visible measure name or label"
|
|
3610
|
+
},
|
|
3611
|
+
"fieldKey": {
|
|
3612
|
+
"type": "string",
|
|
3613
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
3614
|
+
},
|
|
3615
|
+
"operator": {
|
|
3616
|
+
"type": "string",
|
|
3617
|
+
"enum": ["isBetween", "isNotBetween"],
|
|
3618
|
+
"description": "Filter operator that requires valueFrom and valueTo"
|
|
3619
|
+
},
|
|
3620
|
+
"valueFrom": {
|
|
3621
|
+
"anyOf": [
|
|
3622
|
+
{
|
|
3623
|
+
"type": "string"
|
|
3624
|
+
},
|
|
3625
|
+
{
|
|
3626
|
+
"type": "object",
|
|
3627
|
+
"properties": {
|
|
3628
|
+
"type": {
|
|
3629
|
+
"type": "string",
|
|
3630
|
+
"const": "variable"
|
|
3631
|
+
},
|
|
3632
|
+
"variableName": {
|
|
3633
|
+
"type": "string"
|
|
3634
|
+
}
|
|
3635
|
+
},
|
|
3636
|
+
"required": ["type", "variableName"],
|
|
3637
|
+
"additionalProperties": false
|
|
3638
|
+
}
|
|
3639
|
+
],
|
|
3640
|
+
"description": "Lower filter value"
|
|
3641
|
+
},
|
|
3642
|
+
"valueTo": {
|
|
3643
|
+
"anyOf": [
|
|
3644
|
+
{
|
|
3645
|
+
"type": "string"
|
|
3646
|
+
},
|
|
3647
|
+
{
|
|
3648
|
+
"type": "object",
|
|
3649
|
+
"properties": {
|
|
3650
|
+
"type": {
|
|
3651
|
+
"type": "string",
|
|
3652
|
+
"const": "variable"
|
|
3653
|
+
},
|
|
3654
|
+
"variableName": {
|
|
3655
|
+
"type": "string"
|
|
3656
|
+
}
|
|
3657
|
+
},
|
|
3658
|
+
"required": ["type", "variableName"],
|
|
3659
|
+
"additionalProperties": false
|
|
3660
|
+
}
|
|
3661
|
+
],
|
|
3662
|
+
"description": "Upper filter value"
|
|
3663
|
+
}
|
|
3664
|
+
},
|
|
3665
|
+
"required": ["measureName", "fieldKey", "operator", "valueFrom", "valueTo"],
|
|
3666
|
+
"additionalProperties": false
|
|
3667
|
+
},
|
|
3668
|
+
{
|
|
3669
|
+
"type": "object",
|
|
3670
|
+
"properties": {
|
|
3671
|
+
"measureName": {
|
|
3672
|
+
"type": "string",
|
|
3673
|
+
"description": "Visible measure name or label"
|
|
3674
|
+
},
|
|
3675
|
+
"fieldKey": {
|
|
3676
|
+
"type": "string",
|
|
3677
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
3678
|
+
},
|
|
3679
|
+
"operator": {
|
|
3680
|
+
"type": "string",
|
|
3681
|
+
"enum": ["inList", "excludedFromList"],
|
|
3682
|
+
"description": "Filter operator that requires a list of values"
|
|
3683
|
+
},
|
|
3684
|
+
"values": {
|
|
3685
|
+
"minItems": 1,
|
|
3686
|
+
"type": "array",
|
|
3687
|
+
"items": {
|
|
3688
|
+
"type": "string"
|
|
3689
|
+
},
|
|
3690
|
+
"description": "Filter values"
|
|
3691
|
+
}
|
|
3692
|
+
},
|
|
3693
|
+
"required": ["measureName", "fieldKey", "operator", "values"],
|
|
3694
|
+
"additionalProperties": false
|
|
3695
|
+
},
|
|
3696
|
+
{
|
|
3697
|
+
"type": "object",
|
|
3698
|
+
"properties": {
|
|
3699
|
+
"measureName": {
|
|
3700
|
+
"type": "string",
|
|
3701
|
+
"description": "Visible measure name or label"
|
|
3702
|
+
},
|
|
3703
|
+
"fieldKey": {
|
|
3704
|
+
"type": "string",
|
|
3705
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
3706
|
+
},
|
|
3707
|
+
"operator": {
|
|
3708
|
+
"type": "string",
|
|
3709
|
+
"enum": ["isNull", "notNull"],
|
|
3710
|
+
"description": "Filter operator that does not require values"
|
|
3711
|
+
}
|
|
3712
|
+
},
|
|
3713
|
+
"required": ["measureName", "fieldKey", "operator"],
|
|
3714
|
+
"additionalProperties": false
|
|
3715
|
+
}
|
|
3716
|
+
],
|
|
3717
|
+
"description": "Set one measure filter before aggregation. Adds if none, replaces if one, fails if multiple.",
|
|
3718
|
+
"title": "Set measure filter schema"
|
|
3719
|
+
}
|
|
3720
|
+
```
|
|
3721
|
+
|
|
3722
|
+
## `setMeasureFormatString`
|
|
3723
|
+
|
|
3724
|
+
Measure format string
|
|
3725
|
+
|
|
3726
|
+
Set the custom format string for a measure
|
|
3727
|
+
|
|
3728
|
+
**Payload schema**
|
|
3729
|
+
|
|
3730
|
+
```json
|
|
3731
|
+
{
|
|
3732
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3733
|
+
"type": "object",
|
|
3734
|
+
"properties": {
|
|
3735
|
+
"dataItemInternalKey": {
|
|
3736
|
+
"type": "string",
|
|
3737
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3738
|
+
},
|
|
3739
|
+
"dataItemUniqueSignature": {
|
|
3740
|
+
"type": "string",
|
|
3741
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3742
|
+
},
|
|
3743
|
+
"formatString": {
|
|
3744
|
+
"anyOf": [
|
|
3745
|
+
{
|
|
3746
|
+
"type": "string"
|
|
3747
|
+
},
|
|
3748
|
+
{
|
|
3749
|
+
"type": "object",
|
|
3750
|
+
"properties": {
|
|
3751
|
+
"type": {
|
|
3752
|
+
"type": "string",
|
|
3753
|
+
"const": "variable"
|
|
3754
|
+
},
|
|
3755
|
+
"variableName": {
|
|
3756
|
+
"type": "string"
|
|
3757
|
+
}
|
|
3758
|
+
},
|
|
3759
|
+
"required": ["type", "variableName"],
|
|
3760
|
+
"additionalProperties": false
|
|
3761
|
+
}
|
|
3762
|
+
]
|
|
3763
|
+
}
|
|
3764
|
+
},
|
|
3765
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
3766
|
+
"additionalProperties": false,
|
|
3767
|
+
"title": "Measure format string schema"
|
|
3768
|
+
}
|
|
3769
|
+
```
|
|
3770
|
+
|
|
3771
|
+
## `setMeasureFormatType`
|
|
3772
|
+
|
|
3773
|
+
Measure format type
|
|
3774
|
+
|
|
3775
|
+
Set the format type used by a measure
|
|
3776
|
+
|
|
3777
|
+
**Payload schema**
|
|
3778
|
+
|
|
3779
|
+
```json
|
|
3780
|
+
{
|
|
3781
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3782
|
+
"type": "object",
|
|
3783
|
+
"properties": {
|
|
3784
|
+
"dataItemInternalKey": {
|
|
3785
|
+
"type": "string",
|
|
3786
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3787
|
+
},
|
|
3788
|
+
"dataItemUniqueSignature": {
|
|
3789
|
+
"type": "string",
|
|
3790
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3791
|
+
},
|
|
3792
|
+
"formatType": {
|
|
3793
|
+
"anyOf": [
|
|
3794
|
+
{
|
|
3795
|
+
"type": "string",
|
|
3796
|
+
"enum": [
|
|
3797
|
+
"custom",
|
|
3798
|
+
"inherit",
|
|
3799
|
+
"none",
|
|
3800
|
+
"defaultNumber",
|
|
3801
|
+
"defaultMoney",
|
|
3802
|
+
"numberNoDecimal",
|
|
3803
|
+
"number1Decimal",
|
|
3804
|
+
"number2Decimal",
|
|
3805
|
+
"abbreviationAuto",
|
|
3806
|
+
"abbreviationNoDecimal",
|
|
3807
|
+
"abbreviation1Decimal",
|
|
3808
|
+
"abbreviation2Decimal",
|
|
3809
|
+
"percentageNoDecimal",
|
|
3810
|
+
"percentage1Decimal",
|
|
3811
|
+
"percentage2Decimal",
|
|
3812
|
+
"money0Decimal",
|
|
3813
|
+
"money2Decimal",
|
|
3814
|
+
"durationDays",
|
|
3815
|
+
"durationHours",
|
|
3816
|
+
"durationMinutes",
|
|
3817
|
+
"durationSeconds"
|
|
3818
|
+
]
|
|
3819
|
+
},
|
|
3820
|
+
{
|
|
3821
|
+
"type": "string",
|
|
3822
|
+
"enum": [
|
|
3823
|
+
"defaultDate",
|
|
3824
|
+
"defaultDatetime",
|
|
3825
|
+
"defaultTime",
|
|
3826
|
+
"ddmmyyyy",
|
|
3827
|
+
"ddmmyyyy2",
|
|
3828
|
+
"ddmmyyyy3",
|
|
3829
|
+
"yyyymmdd",
|
|
3830
|
+
"mmddyyyy",
|
|
3831
|
+
"mmddyyyy2",
|
|
3832
|
+
"ddmmmmyyyy",
|
|
3833
|
+
"ddmmmyyyy",
|
|
3834
|
+
"ddmmmyy",
|
|
3835
|
+
"mmmmddyyyy",
|
|
3836
|
+
"yyyy",
|
|
3837
|
+
"yy",
|
|
3838
|
+
"mmmyyyy",
|
|
3839
|
+
"yyyymmm",
|
|
3840
|
+
"yyyymmmm",
|
|
3841
|
+
"mmyyyy",
|
|
3842
|
+
"yyyymm",
|
|
3843
|
+
"mmmmyyyy",
|
|
3844
|
+
"yyyywn",
|
|
3845
|
+
"wnyyyy",
|
|
3846
|
+
"yywn",
|
|
3847
|
+
"yyyyq",
|
|
3848
|
+
"qyyyy",
|
|
3849
|
+
"yyyymmddhhmmss",
|
|
3850
|
+
"yyyymmddhmmss",
|
|
3851
|
+
"yyyymmddhhmm",
|
|
3852
|
+
"yyyymmddhh",
|
|
3853
|
+
"yyyymmddhmm",
|
|
3854
|
+
"yyyymmddh",
|
|
3855
|
+
"ddmmmyyyyhhmmss",
|
|
3856
|
+
"ddmmmyyyyhmmss",
|
|
3857
|
+
"ddmmmyyyyhhmm",
|
|
3858
|
+
"ddmmmyyyyhmm",
|
|
3859
|
+
"ddmmmyyyyh",
|
|
3860
|
+
"hhmmss",
|
|
3861
|
+
"hhmm",
|
|
3862
|
+
"hmm",
|
|
3863
|
+
"h",
|
|
3864
|
+
"hh",
|
|
3865
|
+
"hmmss",
|
|
3866
|
+
"month",
|
|
3867
|
+
"month2",
|
|
3868
|
+
"monthn",
|
|
3869
|
+
"month3",
|
|
3870
|
+
"quarter",
|
|
3871
|
+
"quarter2",
|
|
3872
|
+
"week1",
|
|
3873
|
+
"week2",
|
|
3874
|
+
"week3",
|
|
3875
|
+
"day",
|
|
3876
|
+
"dayOfWeek",
|
|
3877
|
+
"hhn",
|
|
3878
|
+
"hn"
|
|
3879
|
+
]
|
|
3880
|
+
}
|
|
3881
|
+
]
|
|
3882
|
+
}
|
|
3883
|
+
},
|
|
3884
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "formatType"],
|
|
3885
|
+
"additionalProperties": false,
|
|
3886
|
+
"title": "Measure format type schema"
|
|
3887
|
+
}
|
|
3888
|
+
```
|
|
3889
|
+
|
|
3890
|
+
## `setMeasureNegativeType`
|
|
3891
|
+
|
|
3892
|
+
Measure negative type
|
|
3893
|
+
|
|
3894
|
+
Set how negative values are displayed for a measure formatter
|
|
3895
|
+
|
|
3896
|
+
**Payload schema**
|
|
3897
|
+
|
|
3898
|
+
```json
|
|
3899
|
+
{
|
|
3900
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3901
|
+
"type": "object",
|
|
3902
|
+
"properties": {
|
|
3903
|
+
"dataItemInternalKey": {
|
|
3904
|
+
"type": "string",
|
|
3905
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
3906
|
+
},
|
|
3907
|
+
"dataItemUniqueSignature": {
|
|
3908
|
+
"type": "string",
|
|
3909
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
3910
|
+
},
|
|
3911
|
+
"negativeType": {
|
|
3912
|
+
"type": "string",
|
|
3913
|
+
"enum": ["symbol", "parenthesis"]
|
|
3914
|
+
}
|
|
3915
|
+
},
|
|
3916
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
3917
|
+
"additionalProperties": false,
|
|
3918
|
+
"title": "Measure negative type schema"
|
|
3919
|
+
}
|
|
3920
|
+
```
|
|
3921
|
+
|
|
3922
|
+
## `setResultFilter`
|
|
3923
|
+
|
|
3924
|
+
Set result filter
|
|
3925
|
+
|
|
3926
|
+
Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.
|
|
3927
|
+
|
|
3928
|
+
**Payload schema**
|
|
3929
|
+
|
|
3930
|
+
```json
|
|
3931
|
+
{
|
|
3932
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3933
|
+
"anyOf": [
|
|
3934
|
+
{
|
|
3935
|
+
"type": "object",
|
|
3936
|
+
"properties": {
|
|
3937
|
+
"measureName": {
|
|
3938
|
+
"type": "string",
|
|
3939
|
+
"description": "Visible measure name or label"
|
|
3940
|
+
},
|
|
3941
|
+
"operator": {
|
|
3942
|
+
"type": "string",
|
|
3943
|
+
"enum": [
|
|
3944
|
+
"equals",
|
|
3945
|
+
"doesNotEqual",
|
|
3946
|
+
"greaterThan",
|
|
3947
|
+
"lessThan",
|
|
3948
|
+
"greaterThanOrEqualTo",
|
|
3949
|
+
"lessThanOrEqualTo",
|
|
3950
|
+
"contains",
|
|
3951
|
+
"excludes",
|
|
3952
|
+
"like",
|
|
3953
|
+
"notLike",
|
|
3954
|
+
"startsWith",
|
|
3955
|
+
"endsWith"
|
|
3956
|
+
],
|
|
3957
|
+
"description": "Filter operator that requires a value"
|
|
3958
|
+
},
|
|
3959
|
+
"value": {
|
|
3960
|
+
"anyOf": [
|
|
3961
|
+
{
|
|
3962
|
+
"type": "string"
|
|
3963
|
+
},
|
|
3964
|
+
{
|
|
3965
|
+
"type": "object",
|
|
3966
|
+
"properties": {
|
|
3967
|
+
"type": {
|
|
3968
|
+
"type": "string",
|
|
3969
|
+
"const": "variable"
|
|
3970
|
+
},
|
|
3971
|
+
"variableName": {
|
|
3972
|
+
"type": "string"
|
|
3973
|
+
}
|
|
3974
|
+
},
|
|
3975
|
+
"required": ["type", "variableName"],
|
|
3976
|
+
"additionalProperties": false
|
|
3977
|
+
}
|
|
3978
|
+
],
|
|
3979
|
+
"description": "Filter value"
|
|
3980
|
+
}
|
|
3981
|
+
},
|
|
3982
|
+
"required": ["measureName", "operator", "value"],
|
|
3983
|
+
"additionalProperties": false
|
|
3984
|
+
},
|
|
3985
|
+
{
|
|
3986
|
+
"type": "object",
|
|
3987
|
+
"properties": {
|
|
3988
|
+
"measureName": {
|
|
3989
|
+
"type": "string",
|
|
3990
|
+
"description": "Visible measure name or label"
|
|
3991
|
+
},
|
|
3992
|
+
"operator": {
|
|
3993
|
+
"type": "string",
|
|
3994
|
+
"enum": ["isBetween", "isNotBetween"],
|
|
3995
|
+
"description": "Filter operator that requires valueFrom and valueTo"
|
|
3996
|
+
},
|
|
3997
|
+
"valueFrom": {
|
|
3998
|
+
"anyOf": [
|
|
3999
|
+
{
|
|
4000
|
+
"type": "string"
|
|
4001
|
+
},
|
|
4002
|
+
{
|
|
4003
|
+
"type": "object",
|
|
4004
|
+
"properties": {
|
|
4005
|
+
"type": {
|
|
4006
|
+
"type": "string",
|
|
4007
|
+
"const": "variable"
|
|
4008
|
+
},
|
|
4009
|
+
"variableName": {
|
|
4010
|
+
"type": "string"
|
|
4011
|
+
}
|
|
4012
|
+
},
|
|
4013
|
+
"required": ["type", "variableName"],
|
|
4014
|
+
"additionalProperties": false
|
|
4015
|
+
}
|
|
4016
|
+
],
|
|
4017
|
+
"description": "Lower filter value"
|
|
4018
|
+
},
|
|
4019
|
+
"valueTo": {
|
|
4020
|
+
"anyOf": [
|
|
4021
|
+
{
|
|
4022
|
+
"type": "string"
|
|
4023
|
+
},
|
|
4024
|
+
{
|
|
4025
|
+
"type": "object",
|
|
4026
|
+
"properties": {
|
|
4027
|
+
"type": {
|
|
4028
|
+
"type": "string",
|
|
4029
|
+
"const": "variable"
|
|
4030
|
+
},
|
|
4031
|
+
"variableName": {
|
|
4032
|
+
"type": "string"
|
|
4033
|
+
}
|
|
4034
|
+
},
|
|
4035
|
+
"required": ["type", "variableName"],
|
|
4036
|
+
"additionalProperties": false
|
|
4037
|
+
}
|
|
4038
|
+
],
|
|
4039
|
+
"description": "Upper filter value"
|
|
4040
|
+
}
|
|
4041
|
+
},
|
|
4042
|
+
"required": ["measureName", "operator", "valueFrom", "valueTo"],
|
|
4043
|
+
"additionalProperties": false
|
|
4044
|
+
},
|
|
4045
|
+
{
|
|
4046
|
+
"type": "object",
|
|
4047
|
+
"properties": {
|
|
4048
|
+
"measureName": {
|
|
4049
|
+
"type": "string",
|
|
4050
|
+
"description": "Visible measure name or label"
|
|
4051
|
+
},
|
|
4052
|
+
"operator": {
|
|
4053
|
+
"type": "string",
|
|
4054
|
+
"enum": ["inList", "excludedFromList"],
|
|
4055
|
+
"description": "Filter operator that requires a list of values"
|
|
4056
|
+
},
|
|
4057
|
+
"values": {
|
|
4058
|
+
"minItems": 1,
|
|
4059
|
+
"type": "array",
|
|
4060
|
+
"items": {
|
|
4061
|
+
"type": "string"
|
|
4062
|
+
},
|
|
4063
|
+
"description": "Filter values"
|
|
4064
|
+
}
|
|
4065
|
+
},
|
|
4066
|
+
"required": ["measureName", "operator", "values"],
|
|
4067
|
+
"additionalProperties": false
|
|
4068
|
+
},
|
|
4069
|
+
{
|
|
4070
|
+
"type": "object",
|
|
4071
|
+
"properties": {
|
|
4072
|
+
"measureName": {
|
|
4073
|
+
"type": "string",
|
|
4074
|
+
"description": "Visible measure name or label"
|
|
4075
|
+
},
|
|
4076
|
+
"operator": {
|
|
4077
|
+
"type": "string",
|
|
4078
|
+
"enum": ["isNull", "notNull"],
|
|
4079
|
+
"description": "Filter operator that does not require values"
|
|
4080
|
+
}
|
|
4081
|
+
},
|
|
4082
|
+
"required": ["measureName", "operator"],
|
|
4083
|
+
"additionalProperties": false
|
|
4084
|
+
}
|
|
4085
|
+
],
|
|
4086
|
+
"description": "Set one result filter after aggregation. Adds if none, replaces if one, fails if multiple.",
|
|
4087
|
+
"title": "Set result filter schema"
|
|
4088
|
+
}
|
|
4089
|
+
```
|
|
4090
|
+
|
|
4091
|
+
## `setSortingDirection`
|
|
4092
|
+
|
|
4093
|
+
Sorting direction
|
|
4094
|
+
|
|
4095
|
+
Set sorting direction for all matching sortable items by name
|
|
4096
|
+
|
|
4097
|
+
**Payload schema**
|
|
4098
|
+
|
|
4099
|
+
```json
|
|
4100
|
+
{
|
|
4101
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4102
|
+
"type": "object",
|
|
4103
|
+
"properties": {
|
|
4104
|
+
"name": {
|
|
4105
|
+
"type": "string",
|
|
4106
|
+
"minLength": 1
|
|
4107
|
+
},
|
|
4108
|
+
"sortDirection": {
|
|
4109
|
+
"type": "string",
|
|
4110
|
+
"enum": ["ascending", "descending"]
|
|
4111
|
+
}
|
|
4112
|
+
},
|
|
4113
|
+
"required": ["name", "sortDirection"],
|
|
4114
|
+
"additionalProperties": false,
|
|
4115
|
+
"title": "Sorting direction by name schema"
|
|
4116
|
+
}
|
|
4117
|
+
```
|
|
4118
|
+
|
|
4119
|
+
## `setSortingEnabled`
|
|
4120
|
+
|
|
4121
|
+
Sorting enabled
|
|
4122
|
+
|
|
4123
|
+
Enable or disable sorting for all matching sortable items by name
|
|
4124
|
+
|
|
4125
|
+
**Payload schema**
|
|
4126
|
+
|
|
4127
|
+
```json
|
|
4128
|
+
{
|
|
4129
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4130
|
+
"type": "object",
|
|
4131
|
+
"properties": {
|
|
4132
|
+
"name": {
|
|
4133
|
+
"type": "string",
|
|
4134
|
+
"minLength": 1
|
|
4135
|
+
},
|
|
4136
|
+
"enabled": {
|
|
4137
|
+
"type": "boolean"
|
|
4138
|
+
}
|
|
4139
|
+
},
|
|
4140
|
+
"required": ["name"],
|
|
4141
|
+
"additionalProperties": false,
|
|
4142
|
+
"title": "Sorting enabled by name schema"
|
|
4143
|
+
}
|
|
4144
|
+
```
|
|
4145
|
+
|
|
4146
|
+
## `setStaticFilterGroup`
|
|
4147
|
+
|
|
4148
|
+
Set static filter group
|
|
4149
|
+
|
|
4150
|
+
Replace all static filters with a nested AND/OR filter group.
|
|
4151
|
+
|
|
4152
|
+
**Payload schema**
|
|
4153
|
+
|
|
4154
|
+
```json
|
|
4155
|
+
{
|
|
4156
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4157
|
+
"description": "Replace all static filters with this nested AND/OR filter group.",
|
|
4158
|
+
"title": "Set static filter group schema",
|
|
4159
|
+
"$ref": "#/$defs/__schema0",
|
|
4160
|
+
"$defs": {
|
|
4161
|
+
"__schema0": {
|
|
4162
|
+
"type": "object",
|
|
4163
|
+
"properties": {
|
|
4164
|
+
"operator": {
|
|
4165
|
+
"type": "string",
|
|
4166
|
+
"enum": ["and", "or"]
|
|
4167
|
+
},
|
|
4168
|
+
"filters": {
|
|
4169
|
+
"type": "array",
|
|
4170
|
+
"items": {
|
|
4171
|
+
"anyOf": [
|
|
4172
|
+
{
|
|
4173
|
+
"type": "object",
|
|
4174
|
+
"properties": {
|
|
4175
|
+
"fieldKey": {
|
|
4176
|
+
"type": "string",
|
|
4177
|
+
"description": "Exact key from the visualization available data response, eg. \"[Cars].[Horsepower]\". Do not use the visible field label."
|
|
4178
|
+
},
|
|
4179
|
+
"operator": {
|
|
4180
|
+
"anyOf": [
|
|
4181
|
+
{
|
|
4182
|
+
"type": "string",
|
|
4183
|
+
"enum": [
|
|
4184
|
+
"equals",
|
|
4185
|
+
"doesNotEqual",
|
|
4186
|
+
"greaterThan",
|
|
4187
|
+
"lessThan",
|
|
4188
|
+
"greaterThanOrEqualTo",
|
|
4189
|
+
"lessThanOrEqualTo",
|
|
4190
|
+
"isBetween",
|
|
4191
|
+
"isNotBetween",
|
|
4192
|
+
"isNull",
|
|
4193
|
+
"notNull",
|
|
4194
|
+
"contains",
|
|
4195
|
+
"excludes",
|
|
4196
|
+
"like",
|
|
4197
|
+
"notLike",
|
|
4198
|
+
"startsWith",
|
|
4199
|
+
"endsWith",
|
|
4200
|
+
"predefined_date_range",
|
|
4201
|
+
"previous",
|
|
4202
|
+
"current",
|
|
4203
|
+
"before",
|
|
4204
|
+
"after",
|
|
4205
|
+
"inList",
|
|
4206
|
+
"excludedFromList",
|
|
4207
|
+
"divider"
|
|
4208
|
+
]
|
|
4209
|
+
},
|
|
4210
|
+
{
|
|
4211
|
+
"type": "string",
|
|
4212
|
+
"enum": [
|
|
4213
|
+
"ytd",
|
|
4214
|
+
"mtd",
|
|
4215
|
+
"qtd",
|
|
4216
|
+
"wtd",
|
|
4217
|
+
"pytd",
|
|
4218
|
+
"pmtd",
|
|
4219
|
+
"pqtd",
|
|
4220
|
+
"pwtd",
|
|
4221
|
+
"l12m",
|
|
4222
|
+
"l90d",
|
|
4223
|
+
"l30d",
|
|
4224
|
+
"l7d",
|
|
4225
|
+
"cy",
|
|
4226
|
+
"cq",
|
|
4227
|
+
"cm",
|
|
4228
|
+
"py",
|
|
4229
|
+
"pm",
|
|
4230
|
+
"pq",
|
|
4231
|
+
"pw",
|
|
4232
|
+
"today",
|
|
4233
|
+
"yesterday",
|
|
4234
|
+
"mindate",
|
|
4235
|
+
"maxdate"
|
|
4236
|
+
]
|
|
4237
|
+
}
|
|
4238
|
+
]
|
|
4239
|
+
},
|
|
4240
|
+
"values": {
|
|
4241
|
+
"type": "object",
|
|
4242
|
+
"properties": {
|
|
4243
|
+
"value": {
|
|
4244
|
+
"anyOf": [
|
|
4245
|
+
{
|
|
4246
|
+
"type": "string"
|
|
4247
|
+
},
|
|
4248
|
+
{
|
|
4249
|
+
"type": "object",
|
|
4250
|
+
"properties": {
|
|
4251
|
+
"type": {
|
|
4252
|
+
"type": "string",
|
|
4253
|
+
"const": "variable"
|
|
4254
|
+
},
|
|
4255
|
+
"variableName": {
|
|
4256
|
+
"type": "string"
|
|
4257
|
+
}
|
|
4258
|
+
},
|
|
4259
|
+
"required": ["type", "variableName"],
|
|
4260
|
+
"additionalProperties": false
|
|
4261
|
+
}
|
|
4262
|
+
]
|
|
4263
|
+
},
|
|
4264
|
+
"valueFrom": {
|
|
4265
|
+
"anyOf": [
|
|
4266
|
+
{
|
|
4267
|
+
"type": "string"
|
|
4268
|
+
},
|
|
4269
|
+
{
|
|
4270
|
+
"type": "object",
|
|
4271
|
+
"properties": {
|
|
4272
|
+
"type": {
|
|
4273
|
+
"type": "string",
|
|
4274
|
+
"const": "variable"
|
|
4275
|
+
},
|
|
4276
|
+
"variableName": {
|
|
4277
|
+
"type": "string"
|
|
4278
|
+
}
|
|
4279
|
+
},
|
|
4280
|
+
"required": ["type", "variableName"],
|
|
4281
|
+
"additionalProperties": false
|
|
4282
|
+
}
|
|
4283
|
+
]
|
|
4284
|
+
},
|
|
4285
|
+
"valueTo": {
|
|
4286
|
+
"anyOf": [
|
|
4287
|
+
{
|
|
4288
|
+
"type": "string"
|
|
4289
|
+
},
|
|
4290
|
+
{
|
|
4291
|
+
"type": "object",
|
|
4292
|
+
"properties": {
|
|
4293
|
+
"type": {
|
|
4294
|
+
"type": "string",
|
|
4295
|
+
"const": "variable"
|
|
4296
|
+
},
|
|
4297
|
+
"variableName": {
|
|
4298
|
+
"type": "string"
|
|
4299
|
+
}
|
|
4300
|
+
},
|
|
4301
|
+
"required": ["type", "variableName"],
|
|
4302
|
+
"additionalProperties": false
|
|
4303
|
+
}
|
|
4304
|
+
]
|
|
4305
|
+
},
|
|
4306
|
+
"secondValue": {
|
|
4307
|
+
"anyOf": [
|
|
4308
|
+
{
|
|
4309
|
+
"type": "string"
|
|
4310
|
+
},
|
|
4311
|
+
{
|
|
4312
|
+
"type": "object",
|
|
4313
|
+
"properties": {
|
|
4314
|
+
"type": {
|
|
4315
|
+
"type": "string",
|
|
4316
|
+
"const": "variable"
|
|
4317
|
+
},
|
|
4318
|
+
"variableName": {
|
|
4319
|
+
"type": "string"
|
|
4320
|
+
}
|
|
4321
|
+
},
|
|
4322
|
+
"required": ["type", "variableName"],
|
|
4323
|
+
"additionalProperties": false
|
|
4324
|
+
}
|
|
4325
|
+
]
|
|
4326
|
+
}
|
|
4327
|
+
},
|
|
4328
|
+
"additionalProperties": false
|
|
4329
|
+
},
|
|
4330
|
+
"dateFilter": {
|
|
4331
|
+
"anyOf": [
|
|
4332
|
+
{
|
|
4333
|
+
"type": "string",
|
|
4334
|
+
"enum": [
|
|
4335
|
+
"ytd",
|
|
4336
|
+
"mtd",
|
|
4337
|
+
"qtd",
|
|
4338
|
+
"wtd",
|
|
4339
|
+
"pytd",
|
|
4340
|
+
"pmtd",
|
|
4341
|
+
"pqtd",
|
|
4342
|
+
"pwtd",
|
|
4343
|
+
"l12m",
|
|
4344
|
+
"l90d",
|
|
4345
|
+
"l30d",
|
|
4346
|
+
"l7d",
|
|
4347
|
+
"cy",
|
|
4348
|
+
"cq",
|
|
4349
|
+
"cm",
|
|
4350
|
+
"py",
|
|
4351
|
+
"pm",
|
|
4352
|
+
"pq",
|
|
4353
|
+
"pw",
|
|
4354
|
+
"today",
|
|
4355
|
+
"yesterday",
|
|
4356
|
+
"mindate",
|
|
4357
|
+
"maxdate"
|
|
4358
|
+
]
|
|
4359
|
+
},
|
|
4360
|
+
{
|
|
4361
|
+
"type": "null"
|
|
4362
|
+
}
|
|
4363
|
+
]
|
|
4364
|
+
}
|
|
4365
|
+
},
|
|
4366
|
+
"required": ["fieldKey", "operator", "values"],
|
|
4367
|
+
"additionalProperties": false
|
|
4368
|
+
},
|
|
4369
|
+
{
|
|
4370
|
+
"$ref": "#/$defs/__schema0"
|
|
4371
|
+
}
|
|
4372
|
+
]
|
|
4373
|
+
}
|
|
4374
|
+
}
|
|
4375
|
+
},
|
|
4376
|
+
"required": ["operator", "filters"],
|
|
4377
|
+
"additionalProperties": false
|
|
4378
|
+
}
|
|
4379
|
+
}
|
|
4380
|
+
}
|
|
4381
|
+
```
|
|
4382
|
+
|
|
4383
|
+
## `toggleDimension`
|
|
4384
|
+
|
|
4385
|
+
Toggle dimension
|
|
4386
|
+
|
|
4387
|
+
Enable or disable a dimension in the chart
|
|
4388
|
+
|
|
4389
|
+
**Payload schema**
|
|
4390
|
+
|
|
4391
|
+
```json
|
|
4392
|
+
{
|
|
4393
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4394
|
+
"type": "object",
|
|
4395
|
+
"properties": {
|
|
4396
|
+
"dataItemInternalKey": {
|
|
4397
|
+
"type": "string",
|
|
4398
|
+
"description": "Internal key of the data item of the dimension to be toggled"
|
|
4399
|
+
},
|
|
4400
|
+
"dataItemUniqueSignature": {
|
|
4401
|
+
"type": "string",
|
|
4402
|
+
"description": "Unique signature of the data item of the dimension to be toggled"
|
|
4403
|
+
},
|
|
4404
|
+
"enabled": {
|
|
4405
|
+
"type": "boolean",
|
|
4406
|
+
"description": "Whether the dimension should be enabled or disabled"
|
|
4407
|
+
}
|
|
4408
|
+
},
|
|
4409
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "enabled"],
|
|
4410
|
+
"additionalProperties": false,
|
|
4411
|
+
"title": "Toggle dimension schema"
|
|
4412
|
+
}
|
|
4413
|
+
```
|
|
4414
|
+
|
|
4415
|
+
## `toggleDimensionOrMeasureByName`
|
|
4416
|
+
|
|
4417
|
+
Toggle dimension/measure by name
|
|
4418
|
+
|
|
4419
|
+
Enable, disable, or toggle a dimension or measure by its name
|
|
4420
|
+
|
|
4421
|
+
**Payload schema**
|
|
4422
|
+
|
|
4423
|
+
```json
|
|
4424
|
+
{
|
|
4425
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4426
|
+
"type": "object",
|
|
4427
|
+
"properties": {
|
|
4428
|
+
"name": {
|
|
4429
|
+
"type": "string"
|
|
4430
|
+
},
|
|
4431
|
+
"operation": {
|
|
4432
|
+
"type": "string",
|
|
4433
|
+
"enum": ["enable", "disable", "toggle"]
|
|
4434
|
+
}
|
|
4435
|
+
},
|
|
4436
|
+
"required": ["name", "operation"],
|
|
4437
|
+
"additionalProperties": false,
|
|
4438
|
+
"title": "Toggle dimension or measure by name schema"
|
|
4439
|
+
}
|
|
4440
|
+
```
|
|
4441
|
+
|
|
4442
|
+
## `toggleMeasure`
|
|
4443
|
+
|
|
4444
|
+
Toggle measure
|
|
4445
|
+
|
|
4446
|
+
Enable or disable a measure in the chart
|
|
4447
|
+
|
|
4448
|
+
**Payload schema**
|
|
4449
|
+
|
|
4450
|
+
```json
|
|
4451
|
+
{
|
|
4452
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4453
|
+
"type": "object",
|
|
4454
|
+
"properties": {
|
|
4455
|
+
"dataItemInternalKey": {
|
|
4456
|
+
"type": "string",
|
|
4457
|
+
"description": "Internal key of the data item of the measure to be toggled"
|
|
4458
|
+
},
|
|
4459
|
+
"dataItemUniqueSignature": {
|
|
4460
|
+
"type": "string",
|
|
4461
|
+
"description": "Unique signature of the data item of the measure to be toggled"
|
|
4462
|
+
}
|
|
4463
|
+
},
|
|
4464
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature"],
|
|
4465
|
+
"additionalProperties": false,
|
|
4466
|
+
"title": "Toggle measure schema"
|
|
4467
|
+
}
|
|
4468
|
+
```
|
|
4469
|
+
|
|
4470
|
+
## `updateDimension`
|
|
4471
|
+
|
|
4472
|
+
Update dimension
|
|
4473
|
+
|
|
4474
|
+
Modify properties of an existing dimension
|
|
4475
|
+
|
|
4476
|
+
**Payload schema**
|
|
4477
|
+
|
|
4478
|
+
```json
|
|
4479
|
+
{
|
|
4480
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4481
|
+
"type": "object",
|
|
4482
|
+
"properties": {
|
|
4483
|
+
"dataItemInternalKey": {
|
|
4484
|
+
"type": "string",
|
|
4485
|
+
"description": "Internal key of the data item of the dimension to be updated"
|
|
4486
|
+
},
|
|
4487
|
+
"dataItemUniqueSignature": {
|
|
4488
|
+
"type": "string",
|
|
4489
|
+
"description": "Unique signature of the data item of the dimension to be updated"
|
|
4490
|
+
},
|
|
4491
|
+
"changes": {
|
|
4492
|
+
"type": "object",
|
|
4493
|
+
"properties": {
|
|
4494
|
+
"customLabel": {
|
|
4495
|
+
"type": "object",
|
|
4496
|
+
"properties": {
|
|
4497
|
+
"enabled": {
|
|
4498
|
+
"type": "boolean"
|
|
4499
|
+
},
|
|
4500
|
+
"value": {
|
|
4501
|
+
"type": "string"
|
|
4502
|
+
}
|
|
4503
|
+
},
|
|
4504
|
+
"required": ["enabled"],
|
|
4505
|
+
"additionalProperties": false
|
|
4506
|
+
},
|
|
4507
|
+
"showNullValues": {
|
|
4508
|
+
"type": "boolean"
|
|
4509
|
+
}
|
|
4510
|
+
},
|
|
4511
|
+
"additionalProperties": false
|
|
4512
|
+
}
|
|
4513
|
+
},
|
|
4514
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
|
|
4515
|
+
"additionalProperties": false,
|
|
4516
|
+
"title": "Update dimension schema"
|
|
4517
|
+
}
|
|
4518
|
+
```
|
|
4519
|
+
|
|
4520
|
+
## `updateMeasure`
|
|
4521
|
+
|
|
4522
|
+
Update measure
|
|
4523
|
+
|
|
4524
|
+
Modify properties of an existing measure
|
|
4525
|
+
|
|
4526
|
+
**Payload schema**
|
|
4527
|
+
|
|
4528
|
+
```json
|
|
4529
|
+
{
|
|
4530
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4531
|
+
"type": "object",
|
|
4532
|
+
"properties": {
|
|
4533
|
+
"dataItemInternalKey": {
|
|
4534
|
+
"type": "string",
|
|
4535
|
+
"description": "Internal key of the data item of the measure to be updated"
|
|
4536
|
+
},
|
|
4537
|
+
"dataItemUniqueSignature": {
|
|
4538
|
+
"type": "string",
|
|
4539
|
+
"description": "Unique signature of the data item of the measure to be updated"
|
|
4540
|
+
},
|
|
4541
|
+
"changes": {
|
|
4542
|
+
"type": "object",
|
|
4543
|
+
"properties": {
|
|
4544
|
+
"customLabel": {
|
|
4545
|
+
"type": "object",
|
|
4546
|
+
"properties": {
|
|
4547
|
+
"enabled": {
|
|
4548
|
+
"type": "boolean"
|
|
4549
|
+
},
|
|
4550
|
+
"value": {
|
|
4551
|
+
"type": "string"
|
|
4552
|
+
}
|
|
4553
|
+
},
|
|
4554
|
+
"required": ["enabled"],
|
|
4555
|
+
"additionalProperties": false
|
|
4556
|
+
}
|
|
4557
|
+
},
|
|
4558
|
+
"required": ["customLabel"],
|
|
4559
|
+
"additionalProperties": false
|
|
4560
|
+
}
|
|
4561
|
+
},
|
|
4562
|
+
"required": ["dataItemInternalKey", "dataItemUniqueSignature", "changes"],
|
|
4563
|
+
"additionalProperties": false,
|
|
4564
|
+
"title": "Update measure schema"
|
|
4565
|
+
}
|
|
4566
|
+
```
|