List Widgets

GET /widgets
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/widgets

Returns a list of Widgets

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /v2/ocamba/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /v2/ocamba/RESOURCE_NAME?sort=-id → sorts per id descending
GET /v2/ocamba/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,filed2
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

dashboard_idstring
List widgets that are assigned to the provided dashboard


Example: dashboard_id=1000
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ widget ]
An array of all created items.
Widget
Name
Description
app_idstring
The ID of the application, assigned by Ocamba API.


Example: 1001
company_idstring
The ID of the company, assigned by Ocamba API.


Example: 12345678
confobject
The configuration of the widget. It is an arbitrary key-value pair object, where key must be a string, and value can be of any type.
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed dashboard description. Minimum length 5. Maximum length 1000.


Example: Displays top 10 users with most activities
dsobject
widget configuration.
gridobject
widget cordinates.
idstring (uuid)
The ID of the widget, generated by Ocamba API.


Example: 2c9ab0a8-d0d2-49aa-b790-9697cc3aed14
namestring
The widget name. Minimum length 1. Maximum length 100.


Example: Top 10
refstring
Ref field is related only with system widgets.


Example: w1
systeminteger
Indicates whether the widget is system or user defined. Note that system widgets can't be deleted or modified.


Example: 1

Possible values: 1 | 0
typestring
The type of the widget.


Example: timeline

Possible values: metric | table | timeline
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
totalinteger
A total number of items.


Example: 3
tip
1 Searchable field is name.
2 Sortable fields are: name, create_time, update_time.
3 Filterable fields are: id, name, system, type, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 3,
  "items": [
    {
      "id": "2c9ab0a8-d0d2-49aa-b790-9697cc3aed14",
      "company_id": "12345678",
      "app_id": "1001",
      "ref": "w1",
      "name": "Top 10",
      "description": "Displays top 10 users with most activities",
      "system": 1,
      "type": "timeline",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}