Get Current Task Detail of the Request

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-request-current-task-details`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-get-request-current-task-details?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
Payload `String`	(Mandatory) Contains all the params to be sent in the request body for the post request. Input data for request body in application/json format. For payload details, see Payload section.

Payload


Name	Description
request_id `String`	(Mandatory) The request ID to update the request details. Example: "409"
workorder_id `String`	(Mandatory) The workorder ID to update the request details. If there is no workorder in the workflow then the default value will be zero (0). Example: "1"
task_id `String`	(Mandatory) The task ID which will be updated. Example: "reviewComponent_1"
User Task Payload
`Header Payload`	(Mandatory) Contains header param details of the request
`Data Payload`	(Mandatory) Contains params for the user task

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	avx-common-028	Invalid/ Incorrect payload. Possible Remediation: Check and ensure if a valid value is given in request payload field.
404 Not Found	engine-db-011	Request not found. Possible Remediation: Check and ensure if a valid requestId/workorderId is given.
500 Internal Server Error	engine-db-022	Unable to fetch task status. Possible Remediation: Check and ensure if a valid task ID is given.

Sample Request/Response

Use Case

To get the current task details for a request.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-get-request-current-task-details?gwsource=external

Request Payload

{
  "payload": {
    "requestId": "409",
    "workorderId": "1",
    "taskId": "reviewComponent_1"
  }
}

Sample Response

{
  "response": {
        "jobId": null,
        "requestStatus": 0,
        "createdTime": 0,
        "request_id": "409",
        "workorder_id": "1",
        "workorder_status": "Completed",
        "workflowName": "Sample",
    "data": {
      "comments": "Hi Tester of RC",
      "state": 1,
      "taskStatus": "Success",
      "task_id": "reviewComponent_1",
      "task_name": "Review Component",
      "input": {
        
      },
      "output": {
        "comments": "Hi Tester of RC",
        "configLabel": {
          "Prevalidation": "Pre Validation",
          "implementation": "Implementation",
          "PostValidation": "Post Validation"
        },
        "enablePrevalidation": true,
        "fetchOnLoad": true,
        "proceedProcess": "Submit",
        "ticketDetails": {
          "ticketNumber": "",
          "startTime": null,
          "endTime": null
        },
        "configureChangeManagement": true,
        "isAuthorized": true,
        "vendor": "CHANGE",
        "breakdownProcess": "Cancel",
        "readWrite": true,
        "prevalidationValue": "Check",
        "config": {
          "Prevalidation": {
            "deviceList": [
              {
                "deviceName": "f5",
                "commands": [
                  "tmsh",
                  "list gtm pool pool41_161_demo"
                ]
              }
            ]
          },
          "implementation": {
            "deviceList": [
              {
                "deviceName": "f5",
                "commands": [
                  "tmsh",
                  "create gtm pool pool41_161_demo"
                ]
              }
            ]
          },
          "PostValidation": {
            "deviceList": [
              {
                "deviceName": "f5",
                "commands": [
                  "tmsh",
                  "show sys version"
                ]
              }
            ]
          }
        },
        "logs": [
          "Request doesn't have valid ticket details."
        ],
        "implementationType": "Manual"
      },
      "is_picked": false,
      "roles": null,
      "tags": null,
      "label": null,
      "component_type": "review",
      "task_process_state": 1,
      "is_completed": true,
      "task_category": "review"
    }
  },
  "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.