Coded automation APIs
APIs allow you to access and interact with the services offered in the Manage Packages menu. You can use these APIs when you design coded automations. Visit Coded Automations to learn about coded automations and how to design them using APIs.
note
Using Go to Definition (F12) allows you to access the definition of UiPath APIs for a certain service. We recommend relying only on the directly exposed APIs when you implement coded automations. Other APIs that are not directly exposed with a service are subject to change without prior notification.
Overloads
APIs often have overloads, which means they provide multiple versions of the same method with different parameter options. Overloads allow you to customize the behavior of the API based on your specific requirements. For example, a UI Automation API may have an overload that accepts a timeout parameter to specify the maximum time to wait for a UI element to appear before ending execution.
By using the APIs with their respective overloads, you can easily achieve your desired automation logic and behavior.
System coded automation APIs
| Coded automation API | Description |
|---|---|
| AddDataRow | Adds a DataRow to a specified DataTable. |
| AddQueueItem | Adds a new item in an Orchestrator queue. |
| AddTransactionItem | Adds a new item in the queue and starts a transaction. |
| AppendLine | Appends the specified string to a file, creating the file if it does not already exist. |
| BulkAddQueueItems | Adds a collection of items from a specified DataTable to a specified queue in Orchestrator. |
| ClearDataTable | Clears all the data in the specified DataTable. |
| CompressZipFiles | Adds the specified files or folders to a compressed (zip) file archive. |
| CopyFile | Copies a file from a specified location to another. |
| CreateFile | Creates an empty file in the specified location. If a file already exists at that location, |
| CreateFolder | Creates a folder in the specified location. |
| DeleteFileOrFolder | Deletes a specified file or folder. |
| DeleteQueueItems | Enables you to delete items with the New state from a specified Orchestrator queue. |
| DeleteStorageFile | Deletes a file from a specified Storage Bucket in Orchestrator. |
| DownloadStorageFile | Downloads a copy of a file in an Orchestrator storage bucket locally. |
| ExtractUnzipFiles | Extracts all the contents of a zip file archive to a specified folder. |
| FilterDataTable | Filters a DataTable by specifying conditions in the Filter widget. |
| GetAsset | Gets a specified Orchestrator asset by using a provided AssetName. |
| GetCredential | Gets a specified credential asset by using a provided Asset Name. |
| GetJobs | Retrieves a list of Orchestrator jobs according to a custom filter, using the Orchestrator API. |
| GetQueueItem | The method gets an item from the queue so that you can process it (start the transaction) and sets its status to In Progress. |
| GetQueueItems | Enables you to retrieve a list of up to 100 transactions from an indicated Orchestrator queue, according to multiple filters, such as creation date, priority, state, and reference. |
| GetResourceForLocalPath | Build a resource from the local path of the file or folder. |
| GetRowItem | Retrieves a value from a row in a DataTable according to a specified column. |
| GetTransactionItem | Gets an item from the Orchestrator queue so that you can process it (start the transaction) and sets its status to In Progress. |
| InvokeProcess | Executes a UiPath process that is available for the local machine. |
| JoinDataTables | Combines rows from two tables by using values common to each other, according to a Join rule, which is specified in the JoinType parameter. |
| ListStorageFiles | Lists files matching a given pattern from a specified Storage Bucket in Orchestrator. |
| LookUpDataTable | This method emulates the behaviour of the VLOOKUP Excel formula. It enables you to search for a provided value in a specified DataTable and returns the RowIndex at which it was found. |
| MergeDataTable | Merges the Destination with the Source, indicating whether to preserve changes and how to handle missing schema in the Source. |
| MoveFile | Moves a file from a specified location to another. |
| OrchestratorHTTPRequest | Performs HTTP requests to the Orchestrator API by authenticating under the Robot it is executed on. |
| OutputDataTable | Writes a DataTable to a string using the CSV format. |
| PathExists | Checks if the specified path exists. The path can represent a file path or a directory path. |
| PostponeTransactionItem | Adds time parameters between which an Orchestrator transaction must be processed (not before Postpone and no later than Deadline). |
| ReadStorageText | Downloads a file from a specified Storage Bucket in Orchestrator and stores it in a string variable. |
| ReadTextFile | Reads all characters from a specified file and stores it in a String variable. |
| RemoveDataColumn | Removes a DataColumn from a specified DataTable. |
| RemoveDuplicateRows | Removes the duplicate rows from a specified DataTable variable, keeping only the first occurrence. |
| Replace | Within a specified input string, replaces strings that match a regular expression pattern with a specified replacement string. |
| SetAsset | Enables you to update the value of an indicated asset, which is already available in Orchestrator, be it a global or a Per Robot asset. |
| SetCredential | Enables you to update the value of an indicated credential asset, that is already available in Orchestrator, be it a global or a Per Robot asset. |
| SetTransactionProgress | Helps you create custom progress statuses for your In ProgressOrchestrator transactions. |
| SetTransactionStatus | Sets the status of an Orchestrator transaction item to Failed or Successful. |
| SortDataTable | Sorts an entire DataTable by ascending or descending order, based on the values of a specified column. |
| StartJob | Enables you to start a job on Orchestrator on a specified number of Robots. |
| StopJob | Enables you to stop or kill a job on Orchestrator. |
| UpdateRowItem | Assigns a specified value to the indicated column of a DataTable row. |
| UploadStorageFile | Uploads a file to a specified Storage Bucket in Orchestrator. |
| WaitQueueItem | Retrieves an Orchestrator queue item from a specified queue and stores it in a QueueItem variable. |
| WriteStorageText | Uploads a string into a specified Storage Bucket in Orchestrator. |
| WriteTextFile | Writes the specified text into a file. If the file already exists, the pre-existing text is overwritten. |
Using APIs
Use the following format, to call an API from the corresponding service: service.API. For example, system.GetAsset.