Update a drill map
PUT {{baseUrl}}/api/model/drillMaps/:drillMapId
Updates a specific drill map in the changeset, based on the definition provided in the request body. It returns the drill map's updated definition in the changeset.
The modeling service performs a full validation for each part of the body. If something is wrong, an error is reported.
The changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.
To save the change in the metadata, commit using the changeset commit API.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
showFields | string | Specify what additional information is returned. Only "acl" is supported. |
If acl, the access control list for each object is included. |
Request Body
{"information"=>{"name"=>"Test DrillMap", "destinationFolderId"=>"{{publicReportsFolderId}}"}, "drillPaths"=>[{"type"=>"up", "target"=>{"objectId"=>"8D679D5111D3E4981000E787EC6DE8A4", "subType"=>"attribute", "name"=>"Year"}, "priority"=>"low", "options"=>{"setName"=>"Set1", "keepParent"=>false, "keepThresholds"=>false, "keepPageBy"=>false, "keepBaseTemplate"=>false, "applyUserFilter"=>true, "applyReportFilter"=>true, "includeOtherFilter"=>"default"}}, {"displayName"=>"Product Analysis", "type"=>"template", "target"=>{"objectId"=>"73490F40433CC573E0CCF4AF4B5FEEF9", "subType"=>"template", "name"=>"Product Analysis"}, "priority"=>"medium", "options"=>{"inheritVLDB"=>true, "keepPageBy"=>false, "keepBaseTemplate"=>false, "applyUserFilter"=>true, "applyReportFilter"=>true, "includeOtherFilter"=>"default", "displayMode"=>"default"}}, {"displayName"=>"Category", "type"=>"down", "target"=>{"objectId"=>"8D679D3711D3E4981000E787EC6DE8A4", "subType"=>"attribute", "name"=>"Category"}, "priority"=>"medium", "options"=>{"keepParent"=>true, "keepThresholds"=>true, "keepPageBy"=>true, "keepBaseTemplate"=>true, "applyUserFilter"=>false, "applyReportFilter"=>false, "additionalFilter"=>{"objectId"=>"E63836F511D5C49EC0000C881FDA1A4F", "subType"=>"filter", "name"=>"Select a Month"}}}, {"displayName"=>"Call Center", "type"=>"across", "target"=>{"objectId"=>"8D679D3511D3E4981000E787EC6DE8A4", "subType"=>"attribute", "name"=>"Call Center"}, "priority"=>"high", "options"=>{"setName"=>"S1", "keepParent"=>false, "keepThresholds"=>false, "keepPageBy"=>false, "keepBaseTemplate"=>false, "applyUserFilter"=>true, "applyReportFilter"=>true, "includeOtherFilter"=>"default"}}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization Token | |
X-MSTR-MS-Changeset | string | (Required) Changeset ID |
RESPONSES
status: OK
{"information":{"versionId":"0BA90A3C9EAE4F3F89441B7051B381F3","primaryLocale":"en-US","objectId":"381C062C774E46F1903B678EFE35FA78","subType":"drill_map","name":"Test DrillMap","destinationFolderId":"D3C7D461F69C4610AA6BAA5EF51F4125"},"drillPaths":[{"type":"up","target":{"objectId":"8D679D5111D3E4981000E787EC6DE8A4","subType":"attribute","name":"Year"},"priority":"low","options":{"setName":"Set1","keepParent":false,"keepThresholds":false,"keepPageBy":false,"keepBaseTemplate":false,"applyUserFilter":true,"applyReportFilter":true,"includeOtherFilter":"default"}},{"displayName":"Product Analysis","type":"template","target":{"objectId":"73490F40433CC573E0CCF4AF4B5FEEF9","subType":"template","name":"Product Analysis"},"priority":"medium","options":{"inheritVLDB":true,"keepPageBy":false,"keepBaseTemplate":false,"applyUserFilter":true,"applyReportFilter":true,"includeOtherFilter":"default","displayMode":"default"}},{"displayName":"Category","type":"down","target":{"objectId":"8D679D3711D3E4981000E787EC6DE8A4","subType":"attribute","name":"Category"},"priority":"medium","options":{"keepParent":true,"keepThresholds":true,"keepPageBy":true,"keepBaseTemplate":true,"applyUserFilter":false,"applyReportFilter":false,"additionalFilter":{"objectId":"E63836F511D5C49EC0000C881FDA1A4F","subType":"filter","name":"Select a Month"}}},{"displayName":"Call Center","type":"across","target":{"objectId":"8D679D3511D3E4981000E787EC6DE8A4","subType":"attribute","name":"Call Center"},"priority":"high","options":{"setName":"S1","keepParent":false,"keepThresholds":false,"keepPageBy":false,"keepBaseTemplate":false,"applyUserFilter":true,"applyReportFilter":true,"includeOtherFilter":"default"}}]}