Share Dashboard to User Group

This API is used to share an existing dashboard to one or more existing usergroups. The sharing can be restricted to read-only or as a read-write.

URL: /dashboard-share-usergroupdetails-update

Type: PUT

Parameters


Param Type	Name	Description	Field Type
`Header`	sessionId (or) Token	Use either Session Id or Token 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`	readUserGroup	Name of the user group that need to have only read access to the dashboard.	`String`
`Payload`	readWriteUserGroup	Name of the user group 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.

Sample Request/Response

Use Case

Share a dashboard named Dashboard1 in read mode to the usergroup and in read/write mode to the usergroup.

Request URL

https://appviewxapi.com/avxapi/dashboard-share-usergroupdetails-update?name=Dashboard1&gwkey=f000ca01&gwsource=WEB

Request Payload

{
"payload": {
"readUserGroups": [
"UG1"
],
"readWriteUserGroups": ["UG2"]
}
}

Response

{
"response": "Success",
"message": null,
"appStatusCode": null,
"tags": null,
"headers": null
}