topic Re: user/v2/inputfiles - workflow examples in Alteryx Server Discussions

user/v2/inputfiles - workflow examples

CodyPedersen — Thu, 06 May 2021 16:32:19 GMT

Hey all, I'm looking to see if anyone has example analytic apps for using a file reference ID as described in Gallery API: Inputfiles Endpoint. As someone who is not very familiar with how these temporary files are stored on alteryx servers, anything would be helpful. I've tried a few variations and for each I receive a file not found error.

Any example workflows, input or direction as to where to look is appreciated.

Thank you

Re: user/v2/inputfiles - workflow examples

clarab — Fri, 07 May 2021 06:08:02 GMT

Hi @CodyPedersen

Assuming you have an analytic app with a File Browse tool, to upload a file into this tool, you will need to use the /user/v2/inputfiles endpoint. This endpoint will return you the reference Id, which you can use in the /user/v2/workflows/{appId}/jobs to submit the job.

You may want to review this https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/How-to-Pass-in-Excel-Worksheet-Name-in-the-Gallery-API/ta-p/732031 and use it as an example.

Re: user/v2/inputfiles - workflow examples

Abdulaziz-Aljandal — Sun, 08 Aug 2021 11:17:27 GMT

Hi,

Yue mentioned that we have to use the /user/v2/inputfiles endpoint. But i couldn't find any reference on how to use this endpoint.

I get this response:

{ "data": null, "exceptionName": "UnknownException", "innerExceptionMessage": "", "message": "Unknown error.\nInvalidOperationException\nRequestID: 29dc6e4f30334eaba707332d2e8efbb6" }

What exactly the body structure for the call?

Thank you.

Re: user/v2/inputfiles - workflow examples

clarab — Tue, 10 Aug 2021 01:45:29 GMT

@Abdulaziz-Aljandal Please use Postman or curl command for this endpoint. The interactive document is not able to post form data.

Re: user/v2/inputfiles - workflow examples

avanibhatnagar — Mon, 23 Aug 2021 18:36:50 GMT

@CodyPedersen @Abdulaziz-Aljandal - Were you ever able to successfully use the InputFiles Endpoint using the Gallery API. I have a javascript application where I'm embedding my analytic app. Everything works except the File Browse tool, and I'm trying to figure out how to make it work. Any suggestions are appreciated!

Re: user/v2/inputfiles - workflow examples

cgoodman — Fri, 03 Sep 2021 18:14:37 GMT

@clarab do you have an example of how to make this request in postman? I have the following but I get an authorisation error.

Alternatively is it possible to use the download tool in Alteryx to publish the file?

Re: user/v2/inputfiles - workflow examples

Abdulaziz-Aljandal — Sun, 05 Sep 2021 13:10:47 GMT

@avanibhatnagar - Actually I used a workaround for now (I have been using this before the new API user/v2/inputfiles came).

The workaround is simple instead of taking the file via Browse tool. Just write the data to a table in the database and then take the parameters from an API call to query the database to get the "Uploaded data".

So, whenever a user uploads a file the data in the file goes to a database and then trigger the workflow with the required parameters to get the uploaded data.

Re: user/v2/inputfiles - workflow examples

clarab — Mon, 06 Sep 2021 11:28:05 GMT

@cgoodman The authorization should look like this:

The API key and secret are taken from My Profile > Keys. The user must have "Enable API" option set to Yes.

Re: user/v2/inputfiles - workflow examples

cgoodman — Mon, 06 Sep 2021 13:05:41 GMT

Thanks @clarab I've got it working when using the full API credentials, it doesn't work using the subscription (private studio) api credentials.

Re: user/v2/inputfiles - workflow examples

cgoodman — Wed, 22 Sep 2021 09:06:18 GMT

Just to follow up. I get the following error message when retrieving the job status.

The upload file is a .xlsx with only two columns and contains Sheet1 so I use the JSON body as suggested in this post - https://community.alteryx.com/t5/Alteryx-Server-Knowledge-Base/How-to-Pass-in-Excel-Worksheet-Name-in-the-Gallery-API/ta-p/732031

Could you provide help on this?

Re: user/v2/inputfiles - workflow examples

cgoodman — Wed, 22 Sep 2021 09:23:39 GMT

I found this post which suggests changing the Action tool to update value instead of update input tool - https://community.alteryx.com/t5/Alteryx-Server-Discussions/The-Action-tool-reports-error-that-quot-file-is-not-a-known/td-p/61934

Changing my app this changes the error message to:

So I feel like I'm getting a bit closer...

Re: user/v2/inputfiles - workflow examples

cgoodman — Thu, 23 Sep 2021 10:42:33 GMT

Solved my own problem. With the server update there is also a new v2 end point to execute a job

POST /user/v2/workflows/{appId}/jobs/

I was previously using v1/workflows/{appId}/jobs which meant that the right permissions were not being granted to see the file upload even with using the admin api key.

Re: user/v2/inputfiles - workflow examples

cgoodman — Mon, 22 Nov 2021 23:12:38 GMT

Does anyone have any examples of making this api request from an Alteryx workflow using the download tool? I can get it to work fine in Postman, but I want to trigger a new job on successful completion of a workflow in Designer, so need it to make the API call.

Re: user/v2/inputfiles - workflow examples

JayshriKolte — Tue, 10 May 2022 13:40:14 GMT

@Abdulaziz-Aljandal , user/v2/inputfiles - workflow examples,I am Very new in Alteryx, I am trying to Use user/v2/inputfiles endpoints, But not able to find any reference for how to use it.

I am using .csv file as input to Analytic app file browse. Also Can you please guide me in Postman how can I set the Post request.