get_app: Get Applications

In alterryx: An 'API' Client for the 'Alteryx' Gallery

Description

An Alteryx application is a workflow that has been designed to run based on user input to questions. In order to run these resources using alterryx you must first obtain the application that you want to run.

To search the workflows you can access from your studio (subscription), use get_app. Subscription is tied to API key. You cannot request workflows for any other subscription without that subscription's API keys.

Usage

get_app(request_params = list(), gallery = get_gallery())

Arguments

request_params	List of app search parameters. For more information on parameters, visit the Alteryx Gallery API documentation https://gallery.alteryx.com/api-docs/ and see the parameters under the 'Find workflows in a subscription' section.
gallery	URL for your Alteryx Gallery

Value

get_app returns a list of alteryx_apps

WARNING

get_app will return all resources in the Gallery tied to your subscription including macros and workflows in addition to applications. You cannot run workflows or macros using the Alteryx Gallery API and if you try to do so you will receive an error.

Examples

## Not run: 
# get the five most recently uploaded apps in your studio

request_params <- list(
  packageType = "0",
  limit = "5",
  sortField = "uploaddate"
)

get_app(request_params)

## End(Not run)

alterryx documentation built on June 7, 2019, 1:02 a.m.