Get Class Management Widget Details

Before you begin

Before attempting to get class management widget with this API, user must ensure any one of the ACF permission is available:

ADC > Dashboard > Class management widget > Add / Delete
ADC > Dashboard > Class management widget > Execute actions
ADC > Dashboard > Class management widget > Modify settings

This can be checked under Accounts > Role > Authorized Functions.

Request Structure


Endpoint:	`/dashboard-widget`
Type:	`GET`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/dashboard-widget?gwsource=external` To understand the elements of the sample URL, click here.
Headers:
Content-Type:	application/json

Table 1. Input Parameter
Name	Description
sessionId `Header`	(Mandatory) Specifies the session ID of the user session received after login. Type: String Constraints: The session ID is used when username and password are not provided.
username `Header`	(Mandatory) Specifies the login username used to access the AppViewX. Type: String Constraints: The username, along with the password, is used when the session ID is not provided.
password `Header`	(Mandatory) Specifies the login password used to access the AppViewX. Type: String Constraints: The password, along with the username, is used when the session ID is not provided.
Content-Type `Header`	(Mandatory) Specifies the format of the data in the payload. Type: String Constraints: The value of this param must be ‘application/json’.
gwsource `Query`	(Mandatory) Specifies the source from which the request is triggered. The options are: web external Type: String
dashboardName `Query`	(Mandatory) Name of the dashboard. Constraints: Allowed special characters : '_', '-', ':', '.', '\|' (Should not be empty and not start with special characters). Type: String
widgetName `Query`	(Mandatory) Name of the class management widget. Constraints: Allowed special characters : ‘-’ ,’_’ , ‘.’ , ‘:’ , ’\|’ Type: String

Response Structure

Status Code: 200 OK
Message: Successful
Headers:
- Content-Type: application/json


Name	Description
response `String`	Contains the requested class management widget details.
message `String`	Success message or failure description in case of error.
appStatusCode `String`	Application specific status code for the response. Will be non-null for failure response.
tags `String`	More info in case of failure response.

Status Codes


HTTP Status Code	appStatusCode	Message	Possible remediation
200 OK	-	Widget details retrieved successfully.	-
400 Bad Request	ADC_DASH_0601	Dashboard name is mandatory	Check and ensure if a valid value is given in query param field - dashboardName
400 Bad Request	ADC_DASH_0602	Widget name is mandatory	Check and ensure if a valid value is given in the query param field - widgetName.
400 Bad Request	ADC_DASH_0014	Invalid dashboard name.	Requested dashboard name is invalid. Dashboard name accepts only '_', '-', ':', '.', '\|'(Should not be empty and not start with special characters).
400 Bad Request	ADC_DASH_0008	Widget name accepts only - , _ , . , : , \|.	Requested widget name is invalid.Widget name accepts only - , _ , . , : , \|.
400 Bad Request	ADC_DASH_0009	Widget name cannot exceed 50 characters.	Requested widget name is invalid. Check the widget name length.
404 Not Found	ADC_DASH_0001	Dashboard not available for given name.	Requested dashboard is not found in the database. Check if the dashboard is deleted.
404 Not Found	ADC_DASH_2507	Class Management Exception : Widget detail not available in db for given name.	Check if the widget is deleted or if the widget is available in a different dashboard.
403 Forbidden	ADC_DASH_0005	Permission not available for dashboard.	Check if the user has Read or Read/Write access for the requested dashboard.

Sample Request/Response

Use Case

Get the details of the class management widget with name classWgt under the dashboard test.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/dashboard-widget

Sample Request

NA

Sample Response

{
  "response": {
    "name": "classWgt",
    "subsystem": "adc",
    "userDefined": true,
    "applicableFor": null,
    "disabled": false,
    "size": {
      "width": 634,
      "height": 69
    },
    "keywords": [    

    ],
    "componentName": "classWgt",
    "description": null,
    "addedGroups": [
      "classWgt/g1"
    ],
    "removedGroups": [     

    ],
    "addedActions": [
      {
        "groupName": "g1",
        "action": "view"
      }
    ],
    "removedActions": [     

    ],
    "settings": {
      "actionlist": {
        "g1": {
          "view": {
            "action": "ViewClass",
            "hostProfile": "",
            "actionGroupName": "g1",
            "className": "test_data_group/gs-f5-pe115.apvxlab.com/F5",
            "classId": "lc:@5f36c1567620c40e97e30350:@test_data_group:@Common",
            "deviceId": "gs-f5-pe115.apvxlab.com(5f36c1567620c40e97e30350)",
            "stringValueAssociationCheck": false,
            "selectedStringValueObject": null,
            "availableStringValueObject": null,
            "deviceAssociationCheck": false,
            "selectedDeviceObject": null,
            "availableDeviceObject": null,
            "defaultExecuted": false,
            "msg": "",
            "isRuntimeCheck": true
          }
        }
      },
      "settings": [
        {
          "name": "classWgt",
          "parent": "",
          "hierarchy": "",
          "level": "group",
          "nodeLevel": 0,
          "actions": [           

          ],
          "children": [           

          ],
          "actionStatus": null,
          "classActionName": null,
          "id": "classWgt"
        },
        {
          "name": "g1",
          "parent": "classWgt",
          "hierarchy": "",
          "level": "group",
          "nodeLevel": 1,
          "actions": [
            "view"
          ],
          "children": [
          

          ],
          "actionStatus": null,
          "classActionName": null,
          "id": "g1"
        }
      ]
    },
    "classLog": null,
    "viaImport": false,
    "StdCustomFlag": "ClassManagement",
    "_id": "5f3f97be25ac8a2582b0b2f2"
  },
  "message": "Widget details retrieved successfully.",
  "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.

What's Next

Delete a Widget