Advent of Code is back! Unwrap daily challenges to sharpen your Alteryx skills and earn badges along the way! Learn more now.

Alteryx Server Discussions

Find answers, ask questions, and share expertise about Alteryx Server.

Alteryx API call for running and queue jobs

Ariharan
11 - Bolide

Hi All, 

I want to get Alteryx running and queue job details via API call. When I tried using the URL (https://url/gallery/api/jobs/) that I got while inspecting the admin job page, I got a 401 unauthorized error. Can someone please help me find the correct call to get a list of running and queued jobs?

 

Regards, 

Ariharan Rengasamy

5 REPLIES 5
Yongcan
8 - Asteroid

First ensure your account with API access enabled.

 

Below is a good starting point as latest gallery on oauth 2.0 ( since you are kicking off job v1 endpoint is your looking for, below package you can use the open auth v2.0 part):

https://community.alteryx.com/t5/Engine-Works/Introducing-the-Alteryx-Server-v3-API/ba-p/899228

 

 

And API swagger help doc link can easilty play with endpoint without create any code:

https://url/gallery//webapi/swagger/ui/index

 

 

Below endpoint to kick off workflow:

POST /v1/workflows/{appId}/jobs

 

Job status check:

GET /v1/jobs/{id}

Ariharan
11 - Bolide

Hi @Yongcan , 

 

I am using the 2021 version and there is no possibility to use the v3 APIs. The above API calls help to get single job details, I want to get all the gallery running/queue job details. 

 

Regards,

Ariharan Rengasamy

Yongcan
8 - Asteroid

You need curator role API key to get all jobs with below endpoint:

https://gallery.alteryx.com/api-docs/#!/admin-workflows.json/GetAppOutputInfoGET

 

 

GET /admin/v1/workflows/jobs/Returns the last run job and its current state for workflows.

Parameters
Parameter Value Description Parameter Type Data Type
appIds The ID of the apps for which you want to retrieve metadata in a comma seperated list. Returns all if not specified query string
includeMessages Whether or not to return messages. True by default query string

 

 

LIANGLL
5 - Atom

Hi, 

 

Question of Alteryx with demo edition.

After I created workflow, the button "Run" presented by "Run job" and the colour of this button is grey. How can I continuer the next step. 

 

Regards,

Lu

 

deep_at_jll
7 - Meteor

use URL:  https:// Gallery URL/webapi

 

Get method with /v3/jobs/{jobid}