UiPath Orchestrator icon

UiPath Orchestrator

Interact with UiPath Orchestrator API

Actions148

Processes → Set Arguments

AI-generated

Summary

Set the input arguments metadata for a UiPath process by specifying its unique process key (release key) and a JSON object defining the arguments' types, requirements, and default values.

Inputs

  • Process Key (required) — The unique identifier of the UiPath process (release key) to update arguments for.
  • Arguments (JSON) (required) — JSON object defining input arguments with their metadata including type, whether they are required, if they have default values, and what those default values are.

Output shape

a JSON object representing the success response from the UiPath Orchestrator API confirming the arguments were set

The operation returns a normalized JSON response confirming the update of the process arguments. The input 'Arguments (JSON)' must be well-formed and describe the arguments structure correctly according to the UiPath process argument schema.

Examples

Example 1: Set arguments for a process

Specify the process key using the resource locator or manual ID input, and provide a JSON object like {"inputFile": {"type": "String", "required": true}, "timeout": {"type": "Int32", "hasDefault": true, "defaultValue": 30}} to define the input arguments and their metadata.

Links

Discussion