Lea y revise la documentación de Automation Anywhere

Automation 360

Cerrar contenidos

Contenidos

Abrir contenidos

List files and folders by workspace API

  • Actualizado: 2021/01/19
    • Automation 360 v.x
    • Administrar
    • Espacio de trabajo de RPA
    • Documentos de API

List files and folders by workspace API

Return details on objects (files, folders, and bots) in either the public or private workspace. This endpoint returns the object id, which is a numeric value that is used in other APIs to identify the file, folder or bot.

Antes de empezar

Nota: Puede ver el Control Room APIs en el Community Editionpero la funcionalidad de la API es limitada. Necesita una licencia Automation 360 Edition para acceder a toda la funcionalidad de las APIs.
  • Todas las llamadas a la API deben contener un token de autenticación en la cabecera de la solicitud. Utilizar la Autenticación para generar un token web JSON. Véase API de autenticación.
  • Para ver los objetos de su espacio de trabajo privado, debe tener una licencia Bot Creator licencia y un rol que incluya la opción Ver mis bots que incluya el permiso de la función "Ver mis bots".
  • Para ver los objetos del espacio de trabajo público, debe tener asignado un rol que incluya la función Ver mis bots y el permiso de Ver contenidobot a las carpetas del espacio de trabajo público.

Procedimiento

  1. Añade el token de autenticación a la cabecera de la solicitud.
  2. Utilice el método POST y la URL del punto final: <control_room_url>/v2/repository/workspaces/{workspaceType}/files/list
    {workspaceType} specifies whether to search in the public or private workspace.

    The following example request searches for objects that contain the string finance in the name.

    Cuerpo de la solicitud:
    {
      "filter": {
          "operator": "substring",
          "field": "name",
          "value": "finance"
          }
      }

    Campos filtrables admitidos

  3. Envía la solicitud.
    Response body:
    In this example response, this endpoint returns a bot with the object id of 14277.
    {
        "page": {
            "offset": 0,
            "total": 1114,
            "totalFilter": 1
        },
        "list": [
            {
                "id": "14277",
                "parentId": "9",
                "name": "financeWeeklyReport",
                "path": "Automation Anywhere\\Bots\\exampleBots",
                "description": "v1",
                "type": "application/vnd.aa.taskbot",
                "size": "799",
                "folder": false,
                "folderCount": "0",
                "productionVersion": "",
                "latestVersion": "",
                "locked": false,
                "lockedBy": "0",
                "createdBy": "22",
                "lastModifiedBy": "22",
                "lastModified": "2020-10-21T17:42:10.140037Z",
                "permission": {
                    "delete": false,
                    "download": false,
                    "upload": false,
                    "run": true,
                    "publishBotstore": false,
                    "viewContent": false,
                    "clone": false
                },
                "workspaceId": "0",
                "botStatus": "PUBLIC",
                "hasErrors": false,
                "workspaceType": "UNKNOWN",
                "metadata": false,
                "uri": "",
                "version": "3",
                "hasTriggers": false,
                "isModified": false
            }
        ]
        }

    Response parameters:

    • id: a unique numeric identifier for the object that matches the search parameters.
    • parentId: a unique numeric identifier for the parent folder.
    • folder: a boolean value that returns true if the object is a folder and false if it is a bot or other file.
    La API REST responde a cada solicitud con un código de respuesta HTTP. Para más detalles sobre los códigos de respuesta, véase API response codes.

Qué hacer a continuación

If you are performing the steps to run a bot or to create an automation schedule, perform this task: Lista disponible desatendida Bot Runners API

Enviar comentarios