View Widget

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

Retrieves the details of a Widget that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
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: 1
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "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"
    }
  ]
}