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.

Before you begin

  • Session ID is obtained from the login API.
  • Ensure that you have the necessary payload details.

Request Structure

Endpoint: /dashboard-share-usergroupdetails-update
Type: PUT
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/dashboard-share-usergroupdetails-update?name=Dashboard1&gwsource=WEB

To understand the elements of the sample URL, click here.
Headers:
Content-Type: application/json
Table 1. Input Parameters
Name Description
sessionId (or) Token

Header

 (Mandatory) Use either Session Id or Token received after login.

Type: String

Example: "sessionId": "ce7f1a14-2bf9-4e4a-89a8-bc780a255813"
gwsource

Query

 (Mandatory) Source from which the request is triggered. The values can be:
  • web
  • external

Type: String
name

Query

 (Mandatory) Name of the dashboard to be shared.

Type: String

Example: "Dashboard1"
Payload

String

 (Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Name Description
readUserGroup

String

 (Optional) Name of the user group that need to have only read access to the dashboard.

Example: "UG1"
readWriteUserGroup

String

 (Optional) Name of the user group that need to have read-write access to the dashboard.

Example: "UG2"

Response Structure

  • Status Code: 200 OK
  • Message: Success
  • Headers:
    • Content-Type: application/json
Table 2. Response Parameters
Name Description
response Contains the response attributes for share dashboard to user group successfully.
message Success message or failure description in case of error.
appStatusCode Application specific status code for the response. Will be non-null for failure response.
tags More info in case of failure response.

Status Codes

HTTP Code appStatusCode Response Message
200 OK null Success
404 Not Found ADC_DASH_0045 Dashboard not available for given name.
400 Bad Request ADC_DASH_0051 Invalid dashboard name.
403 Forbidden ADC_DASH_0048 Permission not available for 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.

Sample Request
https://<IP/HostName/TenantName>:<GWPORT>/avxapi/dashboard-share-usergroupdetails-update?name=Dashboard1&gwsource=WEB
Request Payload
{
"payload": {
  "readUserGroups": [
    "UG1"
  ],  
  "readWriteUserGroups": ["UG2"]
  }
}
Sample Response
{
"response": "Success",
"message": null,
"appStatusCode": null,
"tags": null,
"headers": null
}

Reference

Understanding the sample URL:
  • IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
    • IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication

      The IP address will be included in the endpoint URL for an on-prem deployment.

    • HostName: A human-readable label assigned to a device (host) on a network

      The hostname will be included in the endpoint URL for an on-prem deployment.

    • TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify

      The tenant name will be included in the endpoint URL for a SaaS deployment.

  • GWPORT: AppViewX gateway port

    A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.

    Example: 31443

  • avxapi: Path parameter value (static) that is part of the endpoint's URL
  • Endpoint: Endpoint of the API, for example: execute-hook
  • gwsource: Source or origin of a gateway, for example: external.