Alteryx API Output attachment

[Jaya]

I need to download an xlsx file as an Alteryx API output - 

/v1/jobs/{jobId}/output/{outputId}/

I figured that I need to give a .xlsx in the format option, but not sure what I need to enter in the attachment option. Any ideas how to download the xlsx as an attachment using the Gallery output API.

[KevinP · Accepted solution]

@Jaya The format value for this api endpoint accepts a string representing the file format you wish to receive. This string value should be the extension for the format in question. So if you want the api to return and excel file the value would be 'xlsx'. Where as if you want it to return a word file you would use 'docx'. I have included a list of valid format options and an example api call. Please note that the API call is incomplete as it doesn't include authentication.

/gallery/api/apps/jobs/{jobId}/output/{outputId}/?format=xlsx

Available formats:

• zip - Zipped html output
• xlsx - Excel spreadsheet
• docx - Word document
• pdf - pdf document
• pcxml - Alteryx Composer file

[amitbanwar]

Hi @KevinP

I tried specifying the output format as xlsx. However, I am receiving following error:

{

"data": null,

"exceptionName": "BadRequestException",

"innerExceptionMessage": "",

"message": "Requested file format is not supported."

}

Kindly assist with your input.

Kr,

Amit