List
Get variables list.
https://api.nucle.cloud/v1/variable/listRequest 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. |
| args | object | True | The pagination arguments. |
| Name | Type | Required | Description |
|---|---|---|---|
| orderType | enum | False |
Enum order type of the entries returned, HighToLow = 0 LowToHigh = 1 Newest = 2 Oldest = 3 |
| skip | int | False | Skip a number of entries. |
| take | int | False | Take a number of entries. |
| filter | string | False | The country code filter, if null return all entries. |
Response
| Name | Type | Description |
|---|---|---|
| 200 OK | object | Variables result. |
| 400 Bad Request | object | The outer wrapper for all responses with errors. |
Variables Result
| Name | Type | Description |
|---|---|---|
| Variables | object | The variables list. |
| totalCount | int | The raw count of all variables found in data base without pagination |
Variables result
| Name | Type | Description |
|---|---|---|
| totalCount | int | Total count of Variables without paginations applied. |
| list | object | variables list. |
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 |