Guia da API do Orchestrator

ENTREGA:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Última atualização 4 de dez de 2024

Solicitações de pastas

Atribuindo um usuário a uma pasta com uma função especificada

Postar

https://{yourDomain}/odata/Folders/UiPath.Server.Configuration.OData.AssignUsers

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
  "assignments": {
    "UserIds": [58571],
    "RolesPerFolder": [
      {
        "FolderId": 14091,
        "RoleIds": [25]
      }
    ]
  }
}{
  "assignments": {
    "UserIds": [58571],
    "RolesPerFolder": [
      {
        "FolderId": 14091,
        "RoleIds": [25]
      }
    ]
  }
}

Código de resposta

204 Sem conteúdo

Obtendo todos os usuários em uma pasta e suas funções

Obter

https://{yourDomain}/odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key=14089,includeInherited=true)?$expand=UserEntity%2CRoles

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Código de resposta

200 OK

Corpo da Resposta

{
  "@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
        }
      ]
    }
  ]
}

Verificando se uma pasta é um espaço de trabalho pessoal

A propriedade booleana IsPersonal no corpo da resposta do terminal \FolderNavigation\GetFolderNavigationContextForCurrentUser verifica se a pasta com o ID consultado (por exemplo, 302428) é um espaço de trabalho pessoal.

Obter

https://{yourDomain}/api/FoldersNavigation/GetFolderNavigationContextForCurrentUser?folderId=302428

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Código de resposta

200 OK

Corpo da Resposta

{
    "Id": 302428,
    "DisplayName": "rachel.green@friends.com's workspace",
    "IsSelectable": true,
    "IsPersonal": true,
    "ProvisionType": "Automatic",
    "Ancestors": [],
    "ChildrenPage": [],
    "ChildrenCount": 0
}{
    "Id": 302428,
    "DisplayName": "rachel.green@friends.com's workspace",
    "IsSelectable": true,
    "IsPersonal": true,
    "ProvisionType": "Automatic",
    "Ancestors": [],
    "ChildrenPage": [],
    "ChildrenCount": 0
}