Now that it's live, don't forget to accept your certification badge on Credly today! Learn more here.
We are currently experiencing an issue with Email verification at this time and working towards a solution. Should you encounter this issue, please click on the "Send Verification Button" a second time and the request should go through. If the issue still persists for you, please email support@alteryx.com for assistance.

Alteryx Connect Knowledge Base

Definitive answers from Connect experts.

How To: Connect to the Connect REST API with Alteryx Designer

DaveF
Alteryx Alumni (Retired)
Created

How To: Use the Connect REST APIwith Designer

This guide will walk you through how to login to the Connect API and download Connect entries in JSON format. Attached to this guide is a macro you can use to download all entries listed in an input file.

Prerequisites

  • Product - Alteryx Connect 2018.2+
  • Product - Alteryx Designer

Procedure (Alteryx Designer)

  1. Log in to the REST API with your credentials. The API login endpoint is http://HOSTNAME:PORT/rest/1/login
    • In Designer, configure the URL of the Download tool to the API login endpoint.Set the HTTP Action to POST and pass your username and password in the payload data.
      DaveF_2-1573854835859.pngDaveF_3-1573854868409.png
  2. In the DownloadHeaders field of the Download tool output, make note of the JSESSIONID.
    • IMPORTANT: The DownloadData field also contains the JSESSIONID returned in the session_cookie field of the API response, but generally '=' is encoded to '\u003d'. The only value you need for the next step is JSESSIONID=xxxxxxxxxxxxxx
    • NOTE: The JSESSIONID is valid for 30 minutes
    • DaveF_5-1573855341617.png
  3. Make note of an xid from Connect. If you don't already have one, you can grab one from the URL of a Connect entry in Connect.
    • DaveF_0-1573856173436.png
  4. Make a GET request on the Get Entry API endpoint. The Get Entry API endpoint ishttp://HOSTNAME:PORT/rest/1/entry/{xid}
  5. Explore the Connect REST API documentation to learn more. Have fun!

Common Issues

Spoiler (Highlight to read)
I logged in successfully, but I get a 401 response when trying to get an xid.
Typically this occurs when you are not passing a cookie containing an active JSESSIONID in the header of the request. Refer to Step 4 above.

I logged in successfully, but I get a 400 response when trying to get an xid.
Check your values in the Download Tool Headers and ensure that the name of the variable is cookieand the value is JSESSIONID={id}
I logged in successfully, but I get a 401 response when trying to get an xid.Typically this occurs when you are not passing a cookie containing an active JSESSIONID in the header of the request. Refer to Step 4 above.I logged in successfully, but I get a 400 response when trying to get an xid.Check your values in the Download Tool Headers and ensure that the name of the variable is cookieand the value is JSESSIONID={id}

Additional Resources

Attachments
No ratings
Comments
marlline141
7 - Meteor

How to get Product - Alteryx Connect 2018.2+? Dlo I need to pay extra? We currently have Alteryx Designer. Thank you!

VojtechT
Alteryx
Alteryx

Yes, Alteryx Connect is a separate product. Please reach out to your Alteryx contact for more details. 

marlline141
7 - Meteor

@VojtechT 

 

Got it. Thank you!