Automation Suite
2022.10
False
Guía de la API de Automation Suite
Last updated 17 de jun. de 2024

[Vista previa] Obtener todas las cuentas de robot

Devuelve la lista de todas las cuentas de robot de una organización según el ID de organización.

Punto final de API

docs image https://{yourDomain}/identity_/api/Setting

Ámbitos

Necesita los siguientes ámbitos:

  • PM.RobotAccount
  • PM.RobotAccount.Read

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Nota: para obtener el {access_token}, asegúrate de autenticar a través de uno de los métodos descritos aquí.

Parámetros de ruta

Parámetros de ruta

Tipo de datos

Descripción

partitionGlobalId

(obligatorio)

Cadena

El ID de la organización de la que quieres recuperar las cuentas UiPath Robot.

Parámetros de consulta

Parámetros de consulta

Tipo de datos

Descripción

searchTerm

(opcional)

Cadena

La clave que desea buscar en las cuentas del UiPath Robot.

top

(opcional)

Int32

Mostrar las primeras N cuentas de UiPath Robot.

skip

(opcional)

Int32

Omite las cuentas de N robot superiores.

sortBy

(opcional)

Int32

Especifica la propiedad DTO utilizada para ordenar las entradas de auditoría.

Por ejemplo, name, creationTime, id, etc.

sortOrder

(opcional)

Int32

Especifica el orden de clasificación.

Por ejemplo, ascendente (asc) o descendente (desc).

Respuesta

200 OK

Devuelve las cuentas de UiPath Robot consultadas.

Solicitud de ejemplo

Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.

  • Tu {baseURL} es: https://{yourDomain}/{organizationName}/{tenantName}/
  • Tu {access_token} es: 1234 (para consideraciones de longitud)
  • El {partitionGlobalId} es: magic-7
  • Puedes establecer los siguientes parámetros de consulta:

    • searchTerm = bot
    • top = 2, para mostrar las dos primeras entradas
    • skip = 2, para omitir las dos primeras entradas
    • sortBy = name, para ordenar las entradas por nombre
    • sortOrder = asc, para ordenar las entradas de más antigua a más reciente

La llamada debe ser similar a lo que mostramos a continuación (cURL):

curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

El cuerpo de respuesta de una entrada de auditoría exitosa es así:

{
    "totalCount": 3,
    "results": [
        {
            "id": "55-ab",
            "name": "Bot5",
            "displayName": "Bot5",
            "creationTime": "2021-10-19T18:05:17.3465735",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group2",
                "group3"
            ]
        },
        {
            "id": "66-cd",
            "name": "Bot6",
            "displayName": "Bot6",
            "creationTime": "2021-10-19T18:06:00.3088553",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group3"
            ]
        },
        {
            "id": "77-ef",
            "name": "Bot7",
            "displayName": "Bot7",
            "creationTime": "2021-10-19T18:05:31.4736281",
            "lastLoginTime": null,
            "groupIds": [
                "group2"
            ]
        }
    ]
}{
    "totalCount": 3,
    "results": [
        {
            "id": "55-ab",
            "name": "Bot5",
            "displayName": "Bot5",
            "creationTime": "2021-10-19T18:05:17.3465735",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group2",
                "group3"
            ]
        },
        {
            "id": "66-cd",
            "name": "Bot6",
            "displayName": "Bot6",
            "creationTime": "2021-10-19T18:06:00.3088553",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group3"
            ]
        },
        {
            "id": "77-ef",
            "name": "Bot7",
            "displayName": "Bot7",
            "creationTime": "2021-10-19T18:05:31.4736281",
            "lastLoginTime": null,
            "groupIds": [
                "group2"
            ]
        }
    ]
}
  • Punto final de API
  • Ámbitos
  • Solicitar encabezados.
  • Parámetros de ruta
  • Parámetros de consulta
  • Respuesta
  • 200 OK
  • Solicitud de ejemplo

Was this page helpful?

Obtén la ayuda que necesitas
RPA para el aprendizaje - Cursos de automatización
Foro de la comunidad UiPath
Logotipo blanco de UiPath
Confianza y seguridad
© 2005-2024 UiPath. All rights reserved.