Get All Widgets
Request
GET <REST API URL>/widgets?fields=string&$skip=int&$top=int&query=string&orderBy=stringParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each Widget. Use Fields Syntax to define the subset. |
$skip | Optional. Lets you set a number of Widgets to skip before returning the first one. |
$top | Optional. Lets you set the maximum number of Widgets to return. |
query | Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Widgets, the following fields and tuples are supported: id: value — Custom widget with the given ID is: disabled — Disabled custom widgets key: widgetKey — Custom widget with the given key owner: user — Deprecated: custom widgets owned by the given user |
orderBy | Optional. Returns the list of Widgets sorted by a specified field. See Sorting Syntax for details. Widgets support ordering by the following fields: key |
Response
Response Code | Meaning |
|---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"skip": int,
"top": int,
"total": int,
"widgets": [widget, ...]
}