Subscribe

UiPath Activities

The UiPath Activities Guide

Get App Jobs

UiPath.Alteryx.Activities.GetAppJobs

The Get App Jobs activity uses the the Alteryx API to get a list of jobs (Jobs) for a given app (AppId).

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Alteryx Scope activity to your project.
  3. Add the Get App Jobs activity inside the Alteryx Scope activity.
  4. Enter values for the properties located in the body of the activity properties.

In the Body of the Activity

  • App Id - The ID of the app for which you want to retrieve the jobs. This field supports only Strings or String variables.
  • Sort Field - The field on which the results should be sorted. This field supports only Strings or String variables (E.g. 'createdate', 'appname')
  • Direction - The direction of the sort used with search results. This field supports only Strings or String variables (the values 'asc' or 'desc' are acceptable).
  • Offset - The index of the first record to return in the result set. This field supports only Strings or String variables.
  • Limit - The number of records to return. This field supports only Strings or String variables.
  • Jobs - The Jobs returned. Enter a Job[] or Job[] variable.

Properties

Common

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • BusinessEntityName - This field supports only Strings or String variables.

Output

  • ResponseStatus - The status of the request (success/failure information). This field supports only ResponseStatus variables.

For step-by-step instructions and examples, see the Quickstart guide.

Updated 2 months ago


Get App Jobs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.