Once a function is configured, it can be modified in 3 different ways via the API:
- Updating the location name and the function name
- Updating the definition
- Deleting the existing function
Updating the location name and the function name
If you just want to update the visualisation of functions in the ekey bionyx app, you can use the PATCH/systems/{systemId}/function-webhooks/{functionWebhookId}/name request. It is possible to change the location name and the function name but no other property. Changes are visible in the ekey bionyx app upon refreshing the UI.
Updating the definition
Updating the properties of a function besides location name and function name requires the PUT/systems/{systemId}/function-webhooks/{functionWebhookId} request.
Note: Functions will not be updated immediately but depend on confirmation of the ekey bionyx system administrator in the ekey bionyx app!
The ekey bionyx system administrator receives a push notification (if activated) and is informed about the update in the function overview in the app. He can either confirm the update or remove the function from his ekey bionyx system.
Deleting the existing function
This can be done via the DELETE/systems/{systemId}/function-webhooks/{functionWebhookId} request.
Note: Similar to a definition update this requires confirmation by the ekey bionyx system administrator in the ekey bionyx app before deletion is executed.
The ekey bionyx system administrator receives a push notification (if activated) and is informed about the delete request in the function overview in the app. He can either confirm the deletion or cancel the request.
