Download File

Before you begin

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

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


Endpoint:	`/visualworkflow-file-operation-download`
Type:	`POST`
Sample URL:	`https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-file-operation-download?gwsource=external`
Headers:
Content-Type:	application/json

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.

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
uniqueId Payload `String`	(Mandatory) UniqueId of the file to be deleted. Example: "uniqueId"
decodeFile Payload `Boolean`	(Optional) Decide whether the file is to be decoded while downloading.

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.


HTTP Code	appStatusCode	Message and Remediation
200 OK	NA	Success
400 Bad request	StudioService_078	UniqueId field not found. Possible Remediation: Check and ensure if valid uniqueId is given.
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	studio-db-043	File not found. Possible Remediation: Check if file with uniqueId not present.
400 Bad Request	StudioService_087	Invalid decode Data. Possible Remediation: Check for the decodeFile data given in boolean.

Use Case

To download the uploaded file from the database.

Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/visualworkflow-file-operation-download?gwsource=external

Request Payload

{
  "payload": {
	“uniqueId”:“uniqueId” }
}

Sample Response

File will be downloaded