orchestrator
2023.10
false
- Getting Started
- Authentication
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
- Platform Management APIs
Orchestrator API Guide
Last updated Jun 17, 2024
Folders Requests
POST
https://{yourDomain}/odata/Folders/UiPath.Server.Configuration.OData.AssignUsers
{
"assignments": {
"UserIds": [58571],
"RolesPerFolder": [
{
"FolderId": 14091,
"RoleIds": [25]
}
]
}
}{
"assignments": {
"UserIds": [58571],
"RolesPerFolder": [
{
"FolderId": 14091,
"RoleIds": [25]
}
]
}
}GET
https://{yourDomain}/odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key=14089,includeInherited=true)?$expand=UserEntity%2CRoles
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UserRoles",
"@odata.count": 2,
"value": [
{
"Id": 52454,
"UserEntity": {
"UserName": "admin",
"IsInherited": true,
"Id": 52454
},
"Roles": [
{
"Name": "Administrator",
"Origin": "Assigned",
"Id": 13
},
{
"Name": "Test",
"Origin": "Assigned",
"Id": 25
}
]
},
{
"Id": 58571,
"UserEntity": {
"UserName": "Petrix",
"IsInherited": false,
"Id": 58571
},
"Roles": [
{
"Name": "Test",
"Origin": "Assigned",
"Id": 25
}
]
}
]
}{
"@odata.context": "https://{yourDomain}/odata/$metadata#UserRoles",
"@odata.count": 2,
"value": [
{
"Id": 52454,
"UserEntity": {
"UserName": "admin",
"IsInherited": true,
"Id": 52454
},
"Roles": [
{
"Name": "Administrator",
"Origin": "Assigned",
"Id": 13
},
{
"Name": "Test",
"Origin": "Assigned",
"Id": 25
}
]
},
{
"Id": 58571,
"UserEntity": {
"UserName": "Petrix",
"IsInherited": false,
"Id": 58571
},
"Roles": [
{
"Name": "Test",
"Origin": "Assigned",
"Id": 25
}
]
}
]
}The
IsPersonal boolean property in the response body of the \FolderNavigation\GetFolderNavigationContextForCurrentUser endpoint checks if the folder with the queried ID (for example, 302428) is a personal workspace.
GET
https://{yourDomain}/api/FoldersNavigation/GetFolderNavigationContextForCurrentUser?folderId=302428
{
"Id": 302428,
"DisplayName": "[email protected]'s workspace",
"IsSelectable": true,
"IsPersonal": true,
"ProvisionType": "Automatic",
"Ancestors": [],
"ChildrenPage": [],
"ChildrenCount": 0
}{
"Id": 302428,
"DisplayName": "[email protected]'s workspace",
"IsSelectable": true,
"IsPersonal": true,
"ProvisionType": "Automatic",
"Ancestors": [],
"ChildrenPage": [],
"ChildrenCount": 0
}
