Get All Requests

Before you begin

Before attempting to submit a request with this API, you must ensure that the following permissions are available:

Service Requests > Action > View all requests
Service Requests > Action > View my requests

You can check this in the Platform module under IDENTITY > Role > Authorized functions.

Request Structure


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

Table 1. Input Parameters
Name	Description
sessionID `Header`	(Mandatory) Use session ID retrieved from login API is required if username and password are not provided. Example: "sessionId": "ce7f1a14-2bf9-4e4a-89a8-bc780a255813"
username `Header`	(Mandatory) AppViewX login username is required if sessionId is not provided. Example: "admin"
password `Header`	(Mandatory) AppViewX login password is required if sessionId is not provided.. Example: "AppViewX@123"
Content-Type `Header`	(Mandatory) The parameter should be set to `application/json` to specify the nature of the data in the payload. Example: "application/json"
gwsource `Query`	(Mandatory) Source from which the request is triggered. The values can be: web external

Response Structure

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

Table 2. Response Parameters
Name	Description
response `Key value pair`	Contains the response object along with the hierarchy of the object mapped in field children.
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 `NA`	More info in case of failure response.

Status Codes


HTTP Code	appStatusCode	Message and Remediation
200 OK	NA	Success
400 Bad Request	common-service-011	Invalid maxSize Possible Remediation: Check whether the maximum size is less than or equal to 100.

Sample Request/Response

Use Case:

To get all the available workflow requests.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-get-all-requests?gwsource=external

Request Payload

{
    "payload": {
        "startIndex": 0,
        "maxSize": 25,
        "sortColumn": "",
        "sortOrder": ""
    }
}

Sample Response

{
    "response": {
        "requestList": [
            {
                "workflowName": "Sample Workflow",
                "statusCode": 0,
                "toolTip": {},
                "requestId": "19",
                "workorder_id": "0",
                "created_by": "admin",
                "status": "In Progress",
                "created_time": 1713955000978,
                "last_updated": 1713955001242
            },
            {
                "workflowName": "Citrix NetScaler Golden Config Compliance",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "18",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915064190,
                "last_updated": 1713915070287
            },
            {
                "workflowName": "F5 BIG-IP Golden Config Compliance",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "17",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915003097,
                "last_updated": 1713915010309
            },
            {
                "workflowName": "F5 BIG-IP CVE Reporting",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "16",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915002872,
                "last_updated": 1713915009482
            },
            {
                "workflowName": "Notify Unused VIP-State|Status|Statistics",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "15",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915002840,
                "last_updated": 1713915011631
            },
            {
                "workflowName": "F5 BIG-IP CVE Reporting Data Trigger",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "14",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915001293,
                "last_updated": 1713915004428
            },
            {
                "workflowName": "Unused Objects Data Trigger",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "12",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915001280,
                "last_updated": 1713915004368
            },
            {
                "workflowName": "F5 and Citrix Golden Config Compliance Data Trigger",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "13",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713915001278,
                "last_updated": 1713915065187
            },
            {
                "workflowName": "Fetch F5 BIG-IP CVEs",
                "statusCode": 2,
                "toolTip": {},
                "requestId": "11",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Failed",
                "created_time": 1713911460663,
                "last_updated": 1713911503961
            },
            {
                "workflowName": "appviewx_infra_cert_monitor_vw",
                "statusCode": 2,
                "toolTip": {},
                "requestId": "10",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Failed",
                "created_time": 1713900601119,
                "last_updated": 1713900602617
            },
            {
                "workflowName": "Citrix NetScaler Golden Config Compliance",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "9",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863547365,
                "last_updated": 1713863554960
            },
            {
                "workflowName": "F5 BIG-IP CVE Reporting",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "8",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863494143,
                "last_updated": 1713863503829
            },
            {
                "workflowName": "Notify Unused VIP-State|Status|Statistics",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "7",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863492551,
                "last_updated": 1713863506940
            },
            {
                "workflowName": "F5 BIG-IP Golden Config Compliance",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "6",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863485796,
                "last_updated": 1713863499493
            },
            {
                "workflowName": "F5 and Citrix Golden Config Compliance Data Trigger",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "5",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863467761,
                "last_updated": 1713863548670
            },
            {
                "workflowName": "F5 BIG-IP CVE Reporting Data Trigger",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "4",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863467658,
                "last_updated": 1713863498618
            },
            {
                "workflowName": "Unused Objects Data Trigger",
                "statusCode": 1,
                "toolTip": {},
                "requestId": "3",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Completed",
                "created_time": 1713863467585,
                "last_updated": 1713863496543
            },
            {
                "workflowName": "Fetch F5 BIG-IP CVEs",
                "statusCode": 2,
                "toolTip": {},
                "requestId": "2",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Failed",
                "created_time": 1713863467583,
                "last_updated": 1713863543217
            },
            {
                "workflowName": "appviewx_infra_cert_monitor_vw",
                "statusCode": 2,
                "toolTip": {},
                "requestId": "1",
                "workorder_id": "0",
                "created_by": "system",
                "status": "Failed",
                "created_time": 1713863467491,
                "last_updated": 1713863495223
            }
        ],
        "iTotalDisplayRecords": 19
    },
    "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.