Update
Update variable, if it does not exists this will create a new variable with the value provided.
https://api.nucle.cloud/v1/variable/updateRequest Header
| Name | Type | Required | Description |
|---|---|---|---|
| UserToken | string | True | The User Token, available from the Login methods. |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
| presetId | string | True | The preset id. |
| value | string | False | The variable new value, if no value is provided a default value will be used based on preset value type. |
| forceUpdate | bool, default(False) | False | Force the variable value to be updated with the new value provided without considering the preset update types (Update if new value is max - Update if new value is min) |
Response
| Name | Type | Description |
|---|---|---|
| 200 OK | object | Variable object. |
| 400 Bad Request | object | The outer wrapper for all responses with errors. |
Variable Object
| Name | Type | Description |
|---|---|---|
| rank | int | The variable rank in the variables list |
| id | string | The variable id |
| userId | string | The user id of variable. |
| value | string | The variable value. |
| lastUpdate | Date Time | The last update of the variable. |
| displayName | string | The variable user displayname. |
| coutryCode | string | The variable user country code. |
Error Object
| Name | Type | Description |
|---|---|---|
| code | int | Numerical HTTP code |
| status | string | Description of the HTTP code. |
| errorMessage | string | Description of the error |