Difference between revisions of "REST Writeback"
(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...") |
(→Configuration) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
When picking REST Writeback you can configure the endpoint URL and whether to send the original value with the new one. | When picking REST Writeback you can configure the endpoint URL and whether to send the original value with the new one. | ||
| + | |||
| + | By default the request will be sent to the same url as the server but with the path set to {{code|/writeback}}. | ||
| + | |||
| + | If the endpoint set starts with {{code|/}} the the setting will be used as the path and be used with the host of the connection server. | ||
| + | |||
| + | Otherwise the endpoint is assumed to be the full http(s) url and will be used as-is. | ||
== Security == | == Security == | ||
| Line 13: | Line 19: | ||
The request body sent will contain the following JSON with information about the connection and data updates being made. | The request body sent will contain the following JSON with information about the connection and data updates being made. | ||
| − | < | + | <code> |
{ | { | ||
"datasource": { | "datasource": { | ||
| − | "server": "https:// | + | "server": "https://my-server/xmla", |
| − | "database": " | + | "database": "db-name", |
| − | "cube": " | + | "cube": "cube-name" |
}, | }, | ||
"writes": [{ | "writes": [{ | ||
"tuple": [ | "tuple": [ | ||
| − | "[Product].[ | + | "[Product].[Red Bike]", |
| − | " | + | "[Version].[Working]", |
| − | + | "[Time].[Year].[2023].[Mar]", | |
| − | |||
| − | " | ||
| − | |||
| − | |||
| − | |||
"[Measures].[Amount]" | "[Measures].[Amount]" | ||
], | ], | ||
| − | "value": | + | "oldValue": 123, |
| + | "value": 456, | ||
}, { | }, { | ||
"tuple": [ | "tuple": [ | ||
| − | "[Product].[ | + | "[Product].[Green Tee]", |
| − | " | + | "[Version].[Actual]", |
| − | + | "[Time].[Year].[2023].[Jun]", | |
| − | |||
| − | " | ||
| − | |||
| − | |||
| − | |||
"[Measures].[Amount]" | "[Measures].[Amount]" | ||
], | ], | ||
| − | "value": | + | "oldValue": 123 |
| + | "value": 789 | ||
} | } | ||
] | ] | ||
} | } | ||
| − | </ | + | </code> |
Latest revision as of 10:43, 25 October 2024
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.
By default the request will be sent to the same url as the server but with the path set to /writeback.
If the endpoint set starts with / the the setting will be used as the path and be used with the host of the connection server.
Otherwise the endpoint is assumed to be the full http(s) url and will be used as-is.
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.
{
"datasource": {
"server": "https://my-server/xmla",
"database": "db-name",
"cube": "cube-name"
},
"writes": [{
"tuple": [
"[Product].[Red Bike]",
"[Version].[Working]",
"[Time].[Year].[2023].[Mar]",
"[Measures].[Amount]"
],
"oldValue": 123,
"value": 456,
}, {
"tuple": [
"[Product].[Green Tee]",
"[Version].[Actual]",
"[Time].[Year].[2023].[Jun]",
"[Measures].[Amount]"
],
"oldValue": 123
"value": 789
}
]
}
