orchestrator
2020.10
false
- Getting Started
- Swagger Definition
- Orchestrator APIs
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Processes Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
OUT OF SUPPORT
Orchestrator API Guide
Last updated Jun 18, 2024
Tasks Requests
This request enables you to retrieve all the tasks in the classic folders that the user has access to.
Note:
This endpoint only retrieves actions in classic folders and will be deprecated in the future.
Use the following ones to retrieve actions irrespective of the folder type:
odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersodata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin
GET
{OrchestratorURL}/odata/Tasks?$top=2
{
"@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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
}This request enables you to retrieve task details according to the
TaskId. The TaskId must be included in the request. For example, {OrchestratorURL}/odata/Tasks(194).
GET
{OrchestratorURL}/odata/Tasks(194)
{
"@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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
}This request enables you to assign a task to a user, according to the
TaskId and UserId. A single request can handle assignment of multiple tasks to different users.
POST
{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}This request enables you to clear the assignment for one or multiple tasks based on the
taskIds provided.
POST
{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}This request enables you to retrieve users with View and Edit permissions on Tasks. The folder ID must be included in the request.
GET
{OrchestratorURL}/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "[email protected]",
"EmailAddress": "[email protected]",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "[email protected]",
"Id": 52917
}{
"@odata.context": "{OrchestratorURL}/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "[email protected]",
"EmailAddress": "[email protected]",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "[email protected]",
"Id": 52917
}- Retrieve Tasks in a Folder
- Request headers
- Response code
- Response body
- Retrieve Task Details
- Request headers
- Response code
- Response body
- Assign a Task to a User
- Request headers
- Request body
- Response code
- Response body
- Unassign Tasks
- Request headers
- Request body
- Response code
- Response body
- Return Users With View and Edit Permissions on Tasks
- Request headers
- Response code
- Response body
