app_jobs: Get App Jobs

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

Description

A job is a single run of an app. To queue a job for an app use queue_app. Once queued, there are two ways to poll the gallery for an update on the job status: get_app_jobs or get_job.

get_app_jobs will return all jobs for a given app. get_job will return a single job and is mostly used for polling the status of a job.

Usage

get_app_jobs(app, request_params = list(), gallery = get_gallery())

get_job(job, gallery = get_gallery())

Arguments

app	A single alteryx_app returned from get_app
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
job	An Alteryx job returned from get_app_jobs or queue_jobs

See Also

Once a job is complete, use get_job_output to retrieve the results.

Examples

## Not run: 
# get the five most recently queued jobs for an app
request_params <- list(
  sortField = "createdate",
  limit = "5"
)

get_app_jobs(app, request_params)

# queue a job and poll the job's status until it is "Completed"
job <- queue_job(app, answers)

while(job$status != "Completed") {
job <- get_job(job)
Sys.sleep(2)
}

## End(Not run)

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