Share Dashboard to Role
Share an existing dashboard to one or more existing roles. The sharing can be restricted to read-only or as a read-write.
URL: /dashboard-share-to-roles
Type: PUT
Parameters
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | Gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (for example, web, external) | String |
| Payload | readRoles | Name of the roles that need to have only read access to the dashboard. | String |
| Payload | readWriteRoles | Name of the roles that need to have read-write access to the dashboard. | String |
| Query | dashboardName** | Name of the dashboard to be shared | String |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 400 | Bad request | Dashboard name is mandatory |
| 404 | Not Found | Dashboard not found |
| 403 | Forbidden | Read-write permission not available for the given dashboard |