Get Request Summary/Log

Get the request summary/logs details of a particular workflow request. The execution details of the workflow can be viewed from these logs.

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-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) 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
ids `Query`	(Mandatory) Request IDs which is a string value. Type: `String`

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	WORKFLOW_1300	Workflow Request ID is Mandatory. Possible Remediation: Check and ensure if a valid request ID is given.
404 Not Found	engine-db-011	Request not found. Possible Remediation: Invalid workflow data

Sample Request/Response

Use Case

To get the request summary/logs for a request.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-request-logs?gwsource=external

Request Payload

NA

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
}

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.