community
cancel
Showing results for 
Search instead for 
Did you mean: 

Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!

API OUTPUT TOOL

Asteroid

Hi everyone, has anyone come across the Tool API output. If you did could you share the use by some small example or even if the theory would be kind of understanding for its use. 

 

Thank you in advance Appreciate you time and Patience. 

Alteryx
Alteryx

It can be used in a couple of different ways. If you put it at the end of your workflow, you'll see some data in your message. If you then publish that workflow to the gallery and call it with the Gallery API, you'll see that the data is presented in a different way to the other tools.

 

Originally it was designed to be used with the Main Alteryx API (AlteryxEngineDLL), however it possibly has a wider purpose now presenting data to a REST API.

 

Note: In case there is confusion, It is an API Output Tool, not an API Creation Tool, so it will not serve as an API, however can provide the data that an API needs.

Alteryx Certified Partner

Sorry not understanding this piece..." presented in a different way to the other tools." can you elaborate?

Alteryx
Alteryx

Great Question @yashd!

 

The API Output tool provides the records that are being streamed in to the tool, as well as the record headers, as Alteryx Engine "Message" types. 

 

image.png 

 

Once you run the workflow, if you look at the messages output, you will see all of the records listed, each as its' own unique message line item. 

 

image.png

 

If using the Alteryx Engine API to programatically execute workflows, detailed here: C:\Program Files\Alteryx\APIs\AlteryxSDK.zip\Documentation\AlteryxSDK.chm, one can run a module and use a message callback to retrieve messages that are being produced by the workflow. 

 

Callback information can be seen in the file listed above, under Alteryx Engine/Alteryx Engine

 

image.png

Since the API Output Tool creates "messages" of the data, you can use the Alteryx Engine API to programatically retrieve information from the workflow. 

 

Hope this helps!

Alteryx Certified Partner

You rule @TashaA That is a perfect explanation :)

Atom

Hi TashaA,

 

Could you advise if there is any way for us to post the API message using Alteryx?

 

Like utilizing the API Output tool and post the message to an application with API?