...
Widget definition - Administration
Customers or customer representatives (consultants) sometimes control widget definitions themselves (depending on the agreement). Widget definition is currently managed over cURL https://curl.se/ using basic authentication (you can use git bash or similar terminal). To simplify administration and improve security further an admin UI with MFA is planned for later.
| Note |
|---|
Note that all modification to definitions is immediately reflected. Widget lifecycle management is not currently in place and it is recommended to use other specific widgets for dev and test purposes before updating the production definition. |
| Info |
|---|
As we currently do not version control definitions, it is recommended to source control your definitions elsewhere. |
| Tip |
|---|
To simplify administration and improve security further an admin UI with MFA is planned for later. |
List
...
Configurations
The following cURL will list the id and name of all configurations related to the admin user.
...
Parameter | Description |
|---|---|
| An administration user with the proper access. |
| The password of the administration user. |
...
Create a Configuration
The following cURL template will create a new widget definition.
...
Parameter | Description |
|---|---|
| A unique string representation of the configuration. Used when referring the widget from the “Create additional app” dialog. |
| The configuration file holding the definition. |
| An administration user with the proper access. |
| The password of the administration user. |
...
Update a Configuration
The following cURL template will update the widget definition and/or its name (used referring from 3DX).
...
Parameter | Description |
|---|---|
| A numeric identifier of the configuration. Can be found calling list configurations. |
| A unique string representation of the configuration. Could be changed, used when referring the widget from the “Create additional app” dialog. |
| The configuration file holding the new definition. |
| An administration user with the proper access. |
| The password of the administration user. |
Create
...
/ Update a Code resource
To add a custom js resource to use in configurations (e.g. custom dataHandlers) you can push a js file to the server using the following cURL.
...
Parameter | Description |
|---|---|
| A numeric identifier of your company. Where to get this? |
| The js file holding the new resource definition. |
| An administration user with the proper access. |
| The password of the administration user. |
...