Starten eines Auftrags

Ein Auftrag ist die Ausführung eines Prozesses mit einem oder mehreren Robotern. Die Implementierung des Prozesses Auftrag starten ermöglicht die Erstellung eines neuen Auftrags als Reaktion auf Ereignisse, die innerhalb Ihrer Plattform ( außerhalb der UiPath- Plattform) auftreten.

Endpunkte und Eingaben

Das Starten eines Auftrags erfordert die Verwendung von GET- und POST-Anforderungen an mehrere Orchestrator-API-Endpunkte. Die GET-Anforderungen werden verwendet, um die Eingabeparameterwerte abzurufen, die für die POST-Anforderung vom StartJobs- Endpunkt erforderlich sind.

What are the StartJob input parameters?

To successfully send POST requests to the StartJob endpoint, you must provide at a minimum, a ReleaseKey (process identifier) and Strategy (how to run the process) as input parameters. Depending on the Strategy, there may be additional input parameters including JobsCount or RobotIds.

How do I get the StartJob input parameter values?

To retrieve the required input parameters noted above (i.e., ReleaseKey and Strategy), you collect the following information:

Prozessname (Process Name)

Der Name des Prozesses, der bei einer erfolgreichen Anforderung StartJob ausgeführt wird (weitere Informationen zu Prozessen finden Sie unter Über Prozesse im Orchestrator-Handbuch).

The process name is used to retrieve the ReleaseKey value.

There may be multiple instances of the same process that are differentiated by the environment they're published in. Because of this, a single Process Name can result in multiple ReleaseKeys. In the event that there are multiple ReleaseKeys associated with a process, the EnvironmentName can be used to identify the ReleaseKey of the process the user wants to run (the EnvironmentName is also used to identify the available robots, more on that in the next bullet).

Um sowohl ReleaseSchlüssel als auch Umgebungsname für einen bestimmten Prozess abzurufen, senden Sie eine GET-Anforderung an den Releases- Endpunkt mit dem Prozessnamen als Eingabeparameter (z. B. {{base url}}/odata/Releases?$filter=ProcessKey eq {{ProcessName}}).

• API
• Prahlerei
• Postman

Hinweis:

Die Antwort aus der Releases GET-Anforderung enthält auch die Anforderungen an das Eingabeargument für den spezifischen Prozess. Weitere Informationen finden Sie im Aufzählungszeichen Eingabeargumente unten.

Strategy

Gibt an, wie der Auftrag den Prozess ausführt; Es gibt drei Optionen:

1. Spezifisch

Der Prozess wird auf einem oder mehreren bestimmten Robotern ausgeführt.

When Specific is selected, the StartJob endpoint requires the RobotId of the robot that you want to use to run the process.

Um die RobotId abzurufen, senden Sie eine GET-Anforderung an den GetEnvironments- Endpunkt, indem Sie den EnvironmentName als Eingabeparameter verwenden (z. B. {{base url}}/odata/Environments?$expand=Robots&$filter=Name eq {{_EnvironmentName_}}).

• API
• Prahlerei
• Postman

Multiple RobotIds may be included in the GetEnvironments response. To identify the correct RobotId, you can use the Robot Name. Because of this, it's recommended that you collect this information when Specific is selected.

2. Anzahl der Aufträge

Der Prozess wird mit dem nächsten verfügbaren Roboter eine angegebene Anzahl von Wiederholungen ausgeführt.

When JobsCount is selected, the StartJob endpoint requires the JobsCount input parameter to include a value. Because of this, it's recommended that you provide means for a user to enter a number.

3. Alle

Der Prozess wird einmal auf allen Robotern ausgeführt.

Eingabeargumente (Optional)

The process, specified by the Process Name, may require input arguments. These input arguments typically map to data fields associated with an application object.

For example, an issue management system may have an Incident object. This Incident object includes several data fields that contain information relevant to the process (e.g., IncidentId, DateCreated, Owner, etc.).

Wie oben erwähnt, können Sie bestimmen, ob ein Prozess Eingabeargumente erfordert, indem Sie den Arguments -Block in der GET Releases -Antwort analysieren (s. Beispielantwort unten).

To include these data field values in the StartJob POST request, it's recommended that you provide the means to select the application object and its relevant data fields required for the process. When the job is invoked, the connector retrieves the data field values and adds them in the POST request as the InputArgument parameter value.

Hinweis:

Sie können auch eine GET-Anforderung an den Endpunkt Processes_GetArgumentsByKey senden, um zu ermitteln, ob ein Prozess erforderliche Argumente hat. Der Nutzen für diesen Endpunkt besteht darin, dass die Antwort nur die Argumentdetails enthält (d. h. Eingabe und Ausgabe).

Der Nachteil an diesem Endpunkt und warum er in unseren Beispielen nicht verwendet wird, besteht darin, dass der Connector zusätzliche GET-Anforderungen stellen muss, um Informationen abzurufen, die bereits in der vorherigen GET- Releas -Antwort bereitgestellt wurden (die zum Abrufen des ReleaseKey- Werts erforderlich ist). .

{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }

Beispiele

Dieser Abschnitt enthält Links zu Beispiel-Connector-Benutzeroberflächen und die entsprechenden Orchestrator-API-Anforderungen für jedes Eingabefeld.

In these examples, we introduce the concept of a Template. A template represents an association of an application object and/or event with a UiPath process or queue. Conceptually, a template gives you the ability to invoke different Orchestrator resources (e.g., start a job, add a Queue item) when different events occur within your application (e.g., new object created, object status change) while maintaining a single authenticated connection.

• Einen Auftrag starten – spezifisch
• Einen Auftrag starten – JobsCount
• Einen Auftrag starten – Alle