Get Class Attribute Associations for a Class Management Widget

Before you begin

Before attempting to delete a widget with this API, user must ensure any one of the below ACF permissions is available, This can be checked under Accounts > Role > Authorized Functions.

Request Structure


Endpoint:	`/adc-dashboard-widget-classmanagement-get-stringvalue-association-rest`
Type:	`PUT`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-dashboard-widget-classmanagement-get-stringvalue-association-rest?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 `Payload`	(Mandatory) Name of the dashboard. Constraints: Allowed special characters : '_', '-', ':', '.', '\|' (Should not be empty and not start with special characters). Type: String
widgetName `Payload`	(Mandatory) Name of the class management widget. Constraints: Allowed special characters : ‘-’ ,’_’ , ‘.’ , ‘:’ , ’\|’ Type: String
className `Payload`	(Mandatory) Name of a class, including device path and object class. Type: String
deviceName `Payload`	(Mandatory) Name of the device associated with the class. Type: String
widgetId `Payload`	(Mandatory) Unique identifier of the widget. Type: String
actionName `Payload`	(Mandatory) Action to be performed. Possible Value: Edit Type: String
groupName `Payload`	(Mandatory) Name of the widget group in the dashboard. Type: String
actionMode `Payload`	(Mandatory) Modifying class action allows you to view and change the details of a class. Type: String
objectId `Payload`	(Mandatory) Unique object ID associated with the class instance. Type: String

Response Structure


Name	Description
response `String`	Success message or failure description in case of error.
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 deleted successfully.	-
400 Bad Request	ADC_DASH_8791	Dashboard name is mandatory.	Check and ensure if a valid value is given in the query param field - dashboardName.
400 Bad Request	ADC_DASH_8792	Widget name is mandatory.	Check and ensure if a valid value is given in query param field - widgetName
404 Not Found	ADC_DASH_0045	Dashboard not available for given name.	Requested dashboard not available in database. Check if the dashboard is deleted.
404 Not Found	ADC_DASH_3010	Widget not found.	Check if the widget is deleted or if the widget is available in a different dashboard.
403 Forbidden	ADC_DASH_0048	Permission not available for dashboard.	Check if the user has Read Write access for the requested dashboard.

Sample Request/Response

Use Case

fetch and modify the class attributes associated with a specific F5 device (pe-qa-f5-n8.lab.appviewx.net) under a defined class (aol/pe-qa-f5-n8.lab.appviewx.net/F5.

).

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/adc-dashboard-widget-classmanagement-get-stringvalue-association-rest?gwsource=external

Sample Request

className=aol/pe-qa-f5-n8.lab.appviewx.net/F5
deviceName=pe-qa-f5-n8.lab.appviewx.net
widgetId=6854f7f6df937f36ecc8a3d7
actionName=Edit
groupName=Test
actionMode=ModifyClass
objectId=lc:@68553483df937f36ecc8ac47:@aol:@Common

Sample Response

{
    "response": {
        "selectedClassAttributes": [
            {
                "Mask": "255.255.255.252",
                "Type": "Network",
                "String": "192.168.70.0",
                "Value": "",
                "keyData": "192.168.70.0/30:="
            }
        ],
        "partition": "Common",
        "ruleList": "",
        "availableDevices": [
            {
                "name": "192.168.55.132",
                "id": "6835ae789d3ae02294dcfb2b"
            }
        ],
        "iTotalDisplayRecords": 17,
        "availableClassAttributes": [
            {
                "keyData": "10.10.10.0/24:=",
                "String": "10.10.10.0/24",
                "Value": "",
                "type": "Address"
            }
        ],
        "type": "Address",
        "selectedDevices": [
            {
                "name": "pe-qa-f5-n8.lab.appviewx.net",
                "id": "68553483df937f36ecc8ac47"
            }
        ]
    },
    "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.