UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Start Job

UiPath.Upwire.Activities.StartJob

The StartJob activity starts an existing Upwire job that runs your specified flow template (TemplateID) and then outputs the ID of the started job (JobID).

Summary

Dependencies

Dependency
Details

Packages

UiPath.Upwire.Activities

Activities

Attributes

Attributes
Details

Inputs (Variables)

String

  • Applies to property: TemplateId

Outputs (Variables)

String

  • Applies to property: JobId

Examples

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Start Job

Allowed values

Enter a String or String variable.

Notes

N/A


Input

TemplateId

The template ID of the flow that you want to start.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • The template ID can be found by opening the flow that you want to run and going to the About this Template option in the menu (see image below).
    • You can also see the template ID in the flow URL.
  • In order to start your job using the Start Job activity, you must set your template to wait for an API call. For more information, see the Setup page in this guide.

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Options

Data

The collection of variables and values that you want to use in your flow template when the job runs

Attributes
Details

Type

Collection

Required

No

Default value

Empty

Allowed values

  • Enter the variable names that you set when creating your flow template.
    • Your variable names can be found by opening the flow that you want to run and going to the Edit Template Data option in the menu (see example image below).

Notes

  • The variable names that you enter for your Collection data must match the names you set in the template (see example image below).
How to get variable names in the Upwire web UI.

How to get variable names in the Upwire web UI.

The data collection names must match template variable names.

The data collection names must match template variable names.


Output

JobID

The ID of the running job.

Attributes
Details

Type

String

Required

No (recommended if you plan to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a String variable.

Notes

  • You can use the JobID variable in a subsequent Stop Job activity.

Updated 5 months ago


Start Job


Suggested Edits are limited on API Reference Pages

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