- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Anforderungen für generische Aufgaben
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anforderungen für persönliche Arbeitsbereiche
- Prozessabfragen
- Anforderungen von Warteschlangenelementen
- Queue retention policy requests
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen

Anleitung für die Orchestrator-API
Aufgabenanforderungen
Abrufen von Aufgaben in einem Ordner
Mit dieser Anforderung können Sie alle Aufgaben in den klassischen Ordnern abrufen, auf die der Benutzer Zugriff hat.
Dieser Endpunkt ruft nur Aktionen in klassischen Ordnern ab und wird in Zukunft veraltet sein. Verwenden Sie die folgenden Aktionen, um Aktionen unabhängig vom Ordnertyp abzurufen:
odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersodata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin
Abrufen
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks?$top=2
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks",
"@odata.count": 21,
"value": [
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:39:30.41Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 63
},
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:40:24.88Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 64
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks",
"@odata.count": 21,
"value": [
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:39:30.41Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 63
},
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:40:24.88Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 64
}
Aufgabendetails abrufen
Mit dieser Anforderung können Sie Aufgabendetails gemäß TaskIdabrufen. Die TaskId muss in der Anforderung enthalten sein. Beispiel: https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194).
Abrufen
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194)
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks/$entity",
"Title": "Verify Credentials",
"Type": "FormTask",
"Priority": "Critical",
"Status": "Unassigned",
"CreationTime": "2019-12-12T17:25:03.02Z",
"TaskCatalogName": "Auth",
"OrganizationUnitId": 828,
"IsCompleted": false,
"Id": 194
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks/$entity",
"Title": "Verify Credentials",
"Type": "FormTask",
"Priority": "Critical",
"Status": "Unassigned",
"CreationTime": "2019-12-12T17:25:03.02Z",
"TaskCatalogName": "Auth",
"OrganizationUnitId": 828,
"IsCompleted": false,
"Id": 194
}
Zuweisen einer Aufgabe zu einem Benutzer
Mit dieser Anforderung können Sie einem Benutzer eine Aufgabe gemäß TaskId und UserIdzuweisen. Eine einzelne Anforderung kann die Zuweisung mehrerer Aufgaben an verschiedene Benutzer verarbeiten.
Posten
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Anforderungstext
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}
Nicht zugewiesene Aufgaben
Mit dieser Anforderung können Sie die Zuweisung für eine oder mehrere Aufgaben basierend auf der bereitgestellten taskIds löschen.
Posten
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Anforderungstext
{
"taskIds": [
194,177
]
}
{
"taskIds": [
194,177
]
}
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}
Benutzer mit Berechtigungen zum Anzeigen und Bearbeiten für Aufgaben zurückgeben
Mit dieser Anforderung können Sie Benutzer mit Berechtigungen zum Anzeigen und Bearbeiten von Aufgaben abrufen. Die Ordner-ID muss in der Anforderung enthalten sein.
Abrufen
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "harry.potter@uipath.com",
"EmailAddress": "harry.potter@uipath.com",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "severus.snape@uipath.com",
"Id": 52917
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "harry.potter@uipath.com",
"EmailAddress": "harry.potter@uipath.com",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "severus.snape@uipath.com",
"Id": 52917
}
Delete Task
Mit dieser Anforderung können Sie eine oder mehrere Aufgaben anhand ihrer IDs löschen.
Posten
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
Anforderungstext
{
"taskIds": [
104177
]
}
{
"taskIds": [
104177
]
}
Antwortcode
200 OK
Antworttext
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 104177,
"UserId": null,
"ErrorCode": 2427,
"ErrorMessage": "You do not have the required permissions to delete this action"
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 104177,
"UserId": null,
"ErrorCode": 2427,
"ErrorMessage": "You do not have the required permissions to delete this action"
}
]
}
- Abrufen von Aufgaben in einem Ordner
- Anforderungsheader
- Antwortcode
- Antworttext
- Aufgabendetails abrufen
- Anforderungsheader
- Antwortcode
- Antworttext
- Zuweisen einer Aufgabe zu einem Benutzer
- Anforderungsheader
- Anforderungstext
- Antwortcode
- Antworttext
- Nicht zugewiesene Aufgaben
- Anforderungsheader
- Anforderungstext
- Antwortcode
- Antworttext
- Benutzer mit Berechtigungen zum Anzeigen und Bearbeiten für Aufgaben zurückgeben
- Anforderungsheader
- Antwortcode
- Antworttext
- Delete Task
- Anforderungsheader
- Anforderungstext
- Antwortcode
- Antworttext