ProcessStartOptions

Options for starting a process. Combines folder scoping (folderId / folderKey / folderPath) with the OData query options (expand, select, filter, orderby) accepted by the start endpoint.

Folder scoping is optional in the type — the SDK falls back to the init-time folderKey (a coded function's ctx.platform.folderKey, or <meta name="uipath:folder-key"> in coded-app deployments). A ValidationError is raised when neither is provided.

Extends

• FolderScopedOptions.RequestOptions

Extended by

• ProcessStartRefOptions

Properties

Property	Type	Description
expand?	string	-
filter?	string	-
folderId?	number	Numeric folder ID.
folderKey?	string	Folder key (GUID-formatted string).
folderPath?	string	Slash-delimited folder path, e.g. 'Shared/Finance'.
orderby?	string	-
select?	string	-