REST Writeback

Revision as of 10:35, 25 October 2024 by Colin (talk | contribs) (Created page with "REST Writeback allows customisation of the writeback process by calling your custom code via an http endpoint. == Configuration == When picking REST Writeback you can config...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

REST Writeback allows customisation of the writeback process by calling your custom code via an http endpoint.

Configuration

When picking REST Writeback you can configure the endpoint URL and whether to send the original value with the new one.

Security

The current authentication method for the connection will be used, e.g. if it user name/password then Basic auth will be used. If the connection uses SSO then the auth token will be sent useing a standard Bearer header.

Payload

The request body sent will contain the following JSON with information about the connection and data updates being made.

<syntaxhighlight> {

   "datasource": {
       "server": "https://atoti-server:1234/xmla",
       "database": "atoti",
       "cube": "A3 UI Cube"
   },
   "writes": [{
           "tuple": [
                               "[Product].[Product].[ALL].[AllMember].[N/A]",
                               "[Exercise].[Exercise].[node_name_level1].[Actuals]",
                               "[Version].[Version].[node_name_level1].[Working]",
                               "[Source].[Source].[node_name_level1].[Source].[Total Source].[LOB Total].[Monthly LOB Adj].[Jan LOB Adj]",
                               "[Time].[Time].[Year].[2023].[1Q23].[Mar]",
                               "[FinancialValue].[FinancialValue].[node_name_level1].[FINELEMENT].[FE10].[FE200].[FE10110].[FE100023]",
                               "[BalanceSheet].[BalanceSheet].[node_name_level1].[BALSHTGRP].[BG800].[BG8100].[BG800791]",
                               "[Organization].[Organization].[node_name_level1].[S579999].[S579990].[S579980].[S580086].[S579899].[S571699].[S502289].[S502343].[S504160].[111301]",
                               "[Measures].[Amount]"
                       ],
           "value": 123
       }, {
           "tuple": [
                               "[Product].[Product].[ALL].[AllMember].[N/A]",
                               "[Exercise].[Exercise].[node_name_level1].[Outlook]",
                               "[Version].[Version].[node_name_level1].[Working]",
                               "[Source].[Source].[node_name_level1].[Source].[Total Source].[LOB Total].[Monthly LOB Adj].[Jan LOB Adj]",
                               "[Time].[Time].[Year].[2024].[4Q24].[Nov]",
                               "[FinancialValue].[FinancialValue].[node_name_level1].[FINELEMENT].[FE10].[FE200].[FE10110].[FE100023]",
                               "[BalanceSheet].[BalanceSheet].[node_name_level1].[BALSHTGRP].[BG800].[BG8100].[BG800793]",
                               "[Organization].[Organization].[node_name_level1].[S579999].[S579990].[S579980].[S580086].[S579899].[S571699].[S502289].[S502343].[S504160].[111325]",
                               "[Measures].[Amount]"
                       ],
           "value": 456
       }
   ]

} </syntaxhighlight>