Lea y revise la documentación de Automation Anywhere

Automation 360

Cerrar contenidos

Contenidos

Abrir contenidos

List files and folders in a specific folder API

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

List files and folders in a specific folder API

Return details about objects (bots, folders, and files) in a specific parent folder. 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.
  • You require the folder ID for the folder you want to search in. Use one of the following Repository Management APIs to retrieve the object ID:

The example in this task searches for subfolders that contain the string finance.

Procedimiento

  1. Añade el token de autenticación a la cabecera de la solicitud.
  2. Use the POST method and endpoint URL: <control_room_url>/v2/repository/folders/{folderId}/list
    {folderId} is the object ID of the folder that in which you want to search.
    Request body: The following example request searches for folders that contain the word finance in the name.
    {
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "substring",
            "field": "name",
            "value": "finance"
          },
          {
            "operator": "eq",
            "field": "folder",
            "value": "true"
          }
        ]
      }
    }

    Campos filtrables admitidos

  3. Envíe la solicitud.
    Cuerpo de la respuesta: In a successful request, this endpoint returns the following data:
    • 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.
    In this example response, the endpoint returns a folder with the object id of 40378.
    {
      "page": {
        "offset": 0,
        "total": 329,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "40378",
          "parentId": "2",
          "name": "EOD-finance-reports",
          "path": "Automation Anywhere\\Bots\\APAC\\EOD-finance-reports",
          "description": "",
          "type": "application/vnd.aa.directory",
          "size": "0",
          "folder": true,
          "folderCount": "0",
          "productionVersion": "",
          "latestVersion": "",
          "locked": false,
          "lockedBy": "0",
          "createdBy": "2587",
          "lastModifiedBy": "2587",
          "lastModified": "2020-09-02T05:26:51.162916Z",
          "permission": {
              "delete": true,
              "download": false,
              "upload": false,
              "run": true,
              "publishBotstore": false,
              "viewContent": true,
              "clone": false,
              "editContent": true,
              "createFolder": true,
              "move": true,
              "cancelCheckout": false,
              "revertCheckout": false
        },
          "workspaceId": "0",
          "botStatus": "DRAFT",
          "hasErrors": false,
          "workspaceType": "UNKNOWN",
          "metadata": false,
          "uri": "",
          "version": "0",
          "hasTriggers": false
        }
      ]
    }
Use the numeric identifier, such as an id in subsequent APIs.
Enviar comentarios