When should you choose the Orchestrator API?

Help Orchestrator
,
1

Hi everyone, could you please share the various use cases where using the Orchestrator API would be beneficial?

2

@Rahul_Rajendran,

Any action over Orchestrator you would like to perform automatically on the basis of some condition or requirement can be the good use case for using Orchestrator API’s.

The UiPath Orchestrator API offers a wide range of capabilities that can be leveraged for various use cases1. Here are some key examples:

  1. Managing Queues and Queue Items: Programmatically add, retrieve, and update work items in queues1.
  2. Starting and Stopping Jobs: Kickoff automation jobs on-demand or on a schedule, and stop them as needed1.
  3. Retrieving Asset Information: Get data about robots, processes, and other RPA assets1.
  4. Creating and Modifying Assets: Create new robots, processes, and other assets, and modify existing ones1.
  5. Monitoring and Reporting: Retrieve logs, job statuses, and performance metrics to monitor and report on automation activities.
  6. Integration with Third-Party Applications: Build connectors or adapters to integrate UiPath Orchestrator with other systems, enabling seamless automation across platforms2.
  7. Automated Workflows: Trigger workflows based on events or conditions, such as starting a job when a new item is added to a queue.
  8. Security and Compliance: Manage user permissions and roles, ensuring that only authorized users can access certain functionalities.

These use cases demonstrate how the Orchestrator API can enhance automation capabilities, streamline processes, and improve overall efficiency.

LLM helped me to write this but it’s validated by me.

1 Like
3

Rather than adding a queue item at the end of Process A and triggering Process B with a queue trigger, can I use an API call to start Process B after Process A completes? Is this a good example? If you have any ideas for such API calls, please share—they would be helpful.

4

@Rahul_Rajendran in my case Add Queue Item API method in combination with queue triggers has been handy.

For example, we developed an employee onboarding process that initiates in the HR system. When the HR workflow is approved, this system creates a queue item in Orchestrator using the API, and the process initiates automatically with the information received.
We did the same with an employee offboarding process, but in this case, we also leveraged the postpone date so the process initiated at the moment specified (usually at the end of the day when the person is laid off) and not before.

In other situations, I’ve combined external scripts with UiPath with the help of the API. For example I developed a massive exporter in Python that performs the preparation of a batch and then adds a queue item so the next process completes the final actions, that way we reduced the robot usage in actions that can be easily performed with simpler scripts.

But I think there are many other use cases or tools that can be integrated that can leverage Orchestartor API

Hope it helps

5

Yes, this can also be done. But for that you can also use Start Job activity

6

@Rahul_Rajendran,

For Starting another process job you can use Start Job activity.

The image shows a "Start Job" configuration panel in an automation software, where the orchestrator folder path is "POC", the process name is "Greetings Bot", and the input parameter "in_strUserName" is set to "Ashok". (Captioned by AI)

You can do it from API also by this API endpoint

This image shows the API documentation for the POST method , detailing the required parameters and permissions to register new jobs in UiPath. (Captioned by AI)
This image shows the API documentation for the POST method , detailing the required parameters and permissions to register new jobs in UiPath. (Captioned by AI)2492×1107 152 KB

7

@Rahul_Rajendran,

This is Knowledgebase for API option to start a job.

8

thanks @ashokkarale this was very helpful.

9

thanks a lot @dokumentor

10

This topic was automatically closed 3 days after the last reply. New replies are no longer allowed.