Create Dashboard

POST /dashboards
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/dashboards

Creates a new Dashboard object

Request Body Schema
Arrow
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.
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
creator_idstring
The ID of the member who creates a dashboard, assigned by Ocamba API.
descriptionstring
The detailed dashboard description. Minimum length 5. Maximum length 1000.


Example: Displays user activity
iconstring
The dashboard icon.
idstring (uuid)
The ID of the dashboard, generated by Ocamba API.


Example: 2c9ab0a8-d0d2-49aa-b790-9697cc3aed14
is_defaultinteger
Describe dashboard default status.


Example: 1
namestring
The dashboard name. Minimum length 1. Maximum length 100.


Example: Activity dashboard
systeminteger
Describe dashboard system status.


Example: 1
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "company_id": "6197120",
  "app_id": "1001",
  "name": "Activity dashboard",
  "description": "Displays user activity"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "295",
  "company_id": "6197120",
  "app_id": "1001",
  "ref": null,
  "creator_id": "1000077",
  "name": "Activity dashboard",
  "description": "Displays user activity"
}