Batch API

GET Download

GET Download

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

This endpoint allows the download of files related to a specific Job ID. When you make a GET request to this path, the server responds with a ZIP file or a message indicating that no files related to the given Job ID were found.

OperationId: GET Download

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Download

Request Headers

Display String	Field Name	Field Type
X-request-id*	x-request-id	string

*Mandatory parameter

Response Codes

code	description
200	The api responds a zip file ready to download.
204	No Content - No files found related to job id
400	Bad Request - Validation exception like GUID invalid
401	Unauthorized - Please provide a valid access token or authenticate with proper credentials
404	The requested resource could not be found. Please check the URL or request parameters.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:/api/v1/Download

Add Request Headers:

Add Header

Try It Out

Enter Environment Credentials

OK