Partialy Update Dashboard

PATCH /dashboards/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/dashboards/{id}

Updates the specific Dashboard by setting the values of the parameters passed. Any parameters not provided will be left unchanged

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


Example: 12345
Request Body Schema
Arrow
Name
Description
app_idstring
The ID of the application, assigned by Ocamba API.


Example: 1001
descriptionstring
The detailed dashboard description. Minimum length 5. Maximum length 1000.


Example: Displays user activity
iconstring
The dashboard icon.
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
Response status codes
Arrow
204 - No Content
Arrow
Request examples
Copied
Arrow
patch Arrow
  • patch
{
  "id": "2c9ab0a8-d0d2-49aa-b790-9697cc3aed14",
  "app_id": "1001",
  "name": "Activity dashboard",
  "description": "Displays user activity",
  "system": 1,
  "is_default": 1,
  "create_time": "2021-07-30 12:50:13",
  "update_time": "2021-07-30 12:50:13"
}