orchestrator
2024.10
false
Orchestrator API guide
- 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
Personal workspaces requests
API request examples for retrieving personal workspace listings and details in a tenant
Retrieving personal workspaces in a tenant and their details
The following request enables you to retrieve the list of personal workspaces in a tenant and their details, such as the ID of each personal workspace:
GET
https://{yourDomain}/odata/PersonalWorkspaces
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://{yourDomain}/odata/$metadata#PersonalWorkspaces",
"@odata.count": 2,
"value": [
{
"Key": "af5277d6-63a6-43e6-9731-64b0d7c6c601",
"Name": "[email protected]'s workspace",
"IsActive": true,
"OwnerId": 1475514,
"OwnerName": "[email protected]",
"LastLogin": "2022-03-08T17:24:03.23Z",
"ExploringUserIds": [],
"Id": 620795
},
{
"Key": "3af82603-161e-4c0a-a955-4d625a084716",
"Name": "[email protected]'s workspace",
"IsActive": true,
"OwnerId": 2346675,
"OwnerName": "[email protected]",
"LastLogin": "2022-09-19T15:38:14.157Z",
"ExploringUserIds": [],
"Id": 3731674
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#PersonalWorkspaces",
"@odata.count": 2,
"value": [
{
"Key": "af5277d6-63a6-43e6-9731-64b0d7c6c601",
"Name": "[email protected]'s workspace",
"IsActive": true,
"OwnerId": 1475514,
"OwnerName": "[email protected]",
"LastLogin": "2022-03-08T17:24:03.23Z",
"ExploringUserIds": [],
"Id": 620795
},
{
"Key": "3af82603-161e-4c0a-a955-4d625a084716",
"Name": "[email protected]'s workspace",
"IsActive": true,
"OwnerId": 2346675,
"OwnerName": "[email protected]",
"LastLogin": "2022-09-19T15:38:14.157Z",
"ExploringUserIds": [],
"Id": 3731674
}
]
}
Converting a personal workspace into a modern folder
The following request enables you to convert the personal workspace with the ID 2142812 into a modern folder with the name "FinanceAutomationsJohn". To retrieve the ID of a personal workspace, make a GET request to the /odata/PersonalWorkspaces endpoint.
POST
https://{yourDomain}/odata/PersonalWorkspaces(2142812)/UiPath.Server.Configuration.OData.ConvertToFolder
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer |
Request body
{
"folderName": "FinanceAutomationsJohn"
}
{
"folderName": "FinanceAutomationsJohn"
}
Response code
204 No Content