Get Request Summary/Log

Before you begin

Before attempting to trigger these service requests, ensure that:

The workflow is enabled.

Note: For more information on how to enable a workflow, refer the section on Managing Certificates using Automation Workflows.
The API user has the necessary RBAC permissions to trigger the workflow. You can check this in the Platform module under IDENTITY > Role > Authorized functions.

Request Structure


Endpoint:	/visualworkflow-request-logs
Type:	GET
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-request-logs?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, if username and password are not provided) Session ID received after login. Type: String
username `Header`	(Mandatory if sessionId is not provided) AppViewX login username. Type: String Constraint: Required if sessionId is not provided.
password `Header`	(Mandatory if sessionId is not provided) AppViewX login password. Type: String Constraint: Required if sessionId is not provided.
gwsource `Query`	(Mandatory) Source from which the request is triggered Type: String
ids `Query`	Request ID Type: String

Response Structure

Table 2. Response Structure
Name	Description
response	Contains the response params for the search object request. Type: Key-value pair
message	Success message or failure description in case of error. Type: String
appStatusCode	Application specific status code for the response Will be non-null for failure response Type: String
tags	More information in case of a failure response Type: NA

Table 3. Response
Name	Description
requestId	Unique identifier for the request Type: String
workflowVersion	Version of the workflow Type: String
message	The message with the status and request number for the request Type: String
status	Status of the request Type: String
stausCode	Status code for the request Type: String
requestType	Request type Type: String
workorderId	The ID of the work order for the request If there is no workorder, the value will be 0. Type: String

Status Codes


HTTP Code	appStatusCode	Response Message
200 OK	NA	Success Remediation: NA
400 Bad Request	WORKFLOW_1300	Workflow request ID is mandatory. Remediation: Ensure that a valid workflow request ID is provided in the request.
404 Not Found	engine-db-011	Request not found. Invalid workflow data. Remediation: Ensure the workflow data is valid.

Sample Request/Response

Sample Request

NA

Note: Please refer to the request structure to identify the changeable values.

Sample Response

{
    "response": {
        "workOrderList": [
            {
                "statusCode": 1,
                "requestId": "410",
                 "created_by": "admin",
                "status": "Completed",
                "workflowName": "Copy of reviewComponent Test",
                 "toolTip": null,
                "workorder_id": null,
                 "description": null,
                "ticket_details": null,
                "tasks": [
                    {
                        "state": 1,
                       “comments”:null,
                        "task_name": "WorkOrder",
                        "task_id": "startWorkOrder_1",
                        "user": "admin",
                        "task_status": "Success",
                        "task_start_time": 1502696313667,
                        "task_end_time": 1502696729781,
                                                         
                        "logs": [
                            {
                                "time": 1502696313815,
                                "message": "Child WorkOrder ID: 1, has been created for the Child workflow: WorkOrder"
                            },
                            {
                                "time": 1502696729781,
                                "message": "WorkOrder Completed"
                            }
                        ]
                    }
                ],
                "created_time": 1502696305239,
                "rollback_reference_id": "",
                "clone_reference_ids": [],
                "last_updated": 1502696305239,
                "runnning_time": 0
            }
        ]
    },
    "message": null,
    "appStatusCode": null,
    "tags": null
}

References

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.