orchestrator
2024.10
true
  • Getting Started
  • Swagger Definition
  • Orchestrator APIs
UiPath logo, featuring letters U and I in white

Orchestrator API Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 11, 2024

Personal Workspaces Requests

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}/{organizationName}/{tenantName}/orchestrator_/odata/PersonalWorkspaces

Request headers

Key

Value

Authorization

Bearer

Response code

200 OK

Response body

{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#PersonalWorkspaces",
    "@odata.count": 2,
    "value": [
        {
            "Key": "af5277d6-63a6-43e6-9731-64b0d7c6c601",
            "Name": "john.smith@mail.com's workspace",
            "IsActive": true,
            "OwnerId": 1475514,
            "OwnerName": "john.smith@mail.com",
            "LastLogin": "2022-03-08T17:24:03.23Z",
            "ExploringUserIds": [],
            "Id": 620795
        },
        {
            "Key": "3af82603-161e-4c0a-a955-4d625a084716",
            "Name": "jane.adams@mail.com's workspace",
            "IsActive": true,
            "OwnerId": 2346675,
            "OwnerName": "jane.adams@mail.com",
            "LastLogin": "2022-09-19T15:38:14.157Z",
            "ExploringUserIds": [],
            "Id": 3731674
        }
    ]
}{
    "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#PersonalWorkspaces",
    "@odata.count": 2,
    "value": [
        {
            "Key": "af5277d6-63a6-43e6-9731-64b0d7c6c601",
            "Name": "john.smith@mail.com's workspace",
            "IsActive": true,
            "OwnerId": 1475514,
            "OwnerName": "john.smith@mail.com",
            "LastLogin": "2022-03-08T17:24:03.23Z",
            "ExploringUserIds": [],
            "Id": 620795
        },
        {
            "Key": "3af82603-161e-4c0a-a955-4d625a084716",
            "Name": "jane.adams@mail.com's workspace",
            "IsActive": true,
            "OwnerId": 2346675,
            "OwnerName": "jane.adams@mail.com",
            "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}/{organizationName}/{tenantName}/orchestrator_/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

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.