Repository Management API

Use the Repository Management APIs to perform specific tasks on objects (bots, folders, and files) that you have permission to access in the Control Room. Automation 360 repository consists of private and public workspaces, which contain folders of bots and their dependency files. The private workspace holds objects that are only accessible to the logged-in user. Bots in the private workspace can only be run on that user's device. The public workspace holds objects that are accessible to all users who have the necessary permissions. When a bot is checked-in from a private workspace to the public workspace, it can be checked out by another user to their private workspace for editing or deployed to a Bot Runner.

Note:
To view objects in your private workspace, you must have a Bot Creator license and a role that includes the View my bots feature permission.

To view objects in the public workspace, you must be assigned a role that includes the View my bots feature permission and the View content bot permission to folders in the public workspace.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.
Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

Repository

post /file/list
get /files/{fileid}/content
get /files/{fileid}/dependencies
put /files/{fileid}/dependencies/{workspaceId}
get /files/{fileid}/parents
delete /files/{id}
post /files/packagesVersionUpdate
post /files/version/assignLabel
delete /folders/{folderid}
post /folders/{folderid}/list
post /folders/{folderid}
put /folders/{folderid}
post /recover
get /role/{roleid}/folder/{folderid}/permissions
put /role/{roleid}/permissions
post /workspaces/{workspaceType}/files/list

Repository

Up

post /file/list

Lists bots, folders, and files in a repository (fileListPost)

<p>Use the List API to view details of all the objects (bots, folders, and files) in the Control Room.</p> <p>You can send an API request with or without filter parameters. An API request without any filter parameters specified, retrieves details of all the objects in the Control Room. You can use the filter parameters to retrieve specific set of file or folder objects, instead of fetching all objects in the Control Room. For more information, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-api-filter-request.html">Filtering, pagination, and sorting</a>.</p> <p>For example, to view details of a specific bot, use 'eq' or 'substring' operator with field as 'name' and bot name in the 'value' of the filter. This filter will get bot details of all the bots matching the bot name provided.</p> <blockquote> <blockquote> <p><strong>Note:</strong> The ID and Parent ID that is specified the the response output is used in other endpoints to create subfolders, delete folder etc.</p> </blockquote> </blockquote>

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

BotsResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 4525,
    "offset" : 0
  },
  "list" : [ {
    "productionVersion" : "productionVersion",
    "lastModifiedBy" : "275",
    "permission" : {
      "download" : true,
      "upload" : true,
      "run" : true,
      "delete" : true
    },
    "directory" : "directory",
    "parentId" : "108889",
    "path" : "Automation Anywhere\\\\Bots\\\\new marks bots",
    "size" : 947,
    "lockedBy" : "0",
    "latestVersion" : "latestVersion",
    "fileLastModified" : "2022-07-19T23:08:49.150+0000",
    "name" : "new marks bots",
    "id" : "155524",
    "lastModified" : "2022-07-19T23:08:49.150+0000",
    "locked" : "locked"
  }, {
    "productionVersion" : "productionVersion",
    "lastModifiedBy" : "275",
    "permission" : {
      "download" : true,
      "upload" : true,
      "run" : true,
      "delete" : true
    },
    "directory" : "directory",
    "parentId" : "108889",
    "path" : "Automation Anywhere\\\\Bots\\\\new marks bots",
    "size" : 947,
    "lockedBy" : "0",
    "latestVersion" : "latestVersion",
    "fileLastModified" : "2022-07-19T23:08:49.150+0000",
    "name" : "new marks bots",
    "id" : "155524",
    "lastModified" : "2022-07-19T23:08:49.150+0000",
    "locked" : "locked"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

Returns a list of bots, files, or folders; or a blank list as per filter conditions specified. BotsResponse

400

Bad Request. Error

401

Authentication required. Error

500

Server error. Error

Up

get /files/{fileid}/content

View file content (filesFileidContentGet)

Use this endpoint to download the contents of a file. For a bot file, the content is in JSON format.

Path parameters

fileid (required)

Path Parameter — Unique ID of the file

Return type

String

Example data

Content-Type: application/json

""

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK String

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

get /files/{fileid}/dependencies

Get file dependencies (filesFileidDependenciesGet)

Use this endpoint to view all the dependencies for a file. You must specify the file ID. To view the ID of a file, use the file/list endpoint.

Path parameters

fileid (required)

Path Parameter — Unique ID of the file

Return type

FileDependencyResponse

Example data

Content-Type: application/json

{
  "dependencies" : [ {
    "botStatus" : "New",
    "requiredByFileId" : "0",
    "permission" : {
      "move" : true,
      "viewHistory" : true,
      "upload" : true,
      "publishBotstore" : true,
      "run" : true,
      "delete" : true,
      "viewContent" : true,
      "download" : true,
      "revertCheckout" : true,
      "clone" : true,
      "editContent" : true,
      "createFolder" : true,
      "cancelCheckout" : true,
      "labelBots" : true
    },
    "label" : "label",
    "type" : "text/plain",
    "url" : "https://contorlroom.com/v1/repository/97/1008/download?version=latest",
    "versionNumber" : "0",
    "path" : "Automation Anywhere\\\\Bots\\\\Example_bots\\\\sample.txt",
    "dependencyType" : "NONE",
    "size" : "72",
    "lockedBy" : "0",
    "name" : "sample.txt",
    "id" : "1008"
  }, {
    "botStatus" : "New",
    "requiredByFileId" : "0",
    "permission" : {
      "move" : true,
      "viewHistory" : true,
      "upload" : true,
      "publishBotstore" : true,
      "run" : true,
      "delete" : true,
      "viewContent" : true,
      "download" : true,
      "revertCheckout" : true,
      "clone" : true,
      "editContent" : true,
      "createFolder" : true,
      "cancelCheckout" : true,
      "labelBots" : true
    },
    "label" : "label",
    "type" : "text/plain",
    "url" : "https://contorlroom.com/v1/repository/97/1008/download?version=latest",
    "versionNumber" : "0",
    "path" : "Automation Anywhere\\\\Bots\\\\Example_bots\\\\sample.txt",
    "dependencyType" : "NONE",
    "size" : "72",
    "lockedBy" : "0",
    "name" : "sample.txt",
    "id" : "1008"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

List of file dependencies retrieved successfully. FileDependencyResponse

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

put /files/{fileid}/dependencies/{workspaceId}

Update manual dependencies (filesFileidDependenciesWorkspaceIdPut)

Use this endpoint to update the manual dependencies of a file. You can update dependencies for the files residing only in the private workspace. You must specify the ID of the file and the workspace ID. The manual dependencies of the parent file is updated with the value of the field childFileIds.

Path parameters

fileid (required)

Path Parameter — Unique ID of the file

workspaceId (required)

Path Parameter — Unique workspace id of user

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body EditFileDependenciesRequest (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

get /files/{fileid}/parents

Get immediate parent(s) (filesFileidParentsGet)

Use this endpoint to retrieve the first level parent(s) of a specific file. You must specify the file ID. To view the ID of a file, use the file/list endpoint.

Path parameters

fileid (required)

Path Parameter — Unique ID of the file

Return type

array[FileParentsResponse]

Example data

Content-Type: application/json

[ {
  "botStatus" : "New",
  "requiredByFileId" : 0.8008281904610115,
  "permission" : {
    "move" : true,
    "viewHistory" : true,
    "upload" : true,
    "publishBotstore" : true,
    "run" : true,
    "delete" : true,
    "viewContent" : true,
    "download" : true,
    "revertCheckout" : true,
    "clone" : true,
    "editContent" : true,
    "createFolder" : true,
    "cancelCheckout" : true,
    "labelBots" : true
  },
  "label" : "label",
  "type" : "text/plain",
  "url" : "https://contorlroom.com/v1/repository/97/1008/download?version=latest",
  "versionNumber" : 0.0,
  "path" : "Automation Anywhere\\\\Bots\\\\Example_bots\\\\sample.txt",
  "dependencyType" : "NONE",
  "size" : 72.0,
  "lockedBy" : "0",
  "name" : "sample.txt",
  "id" : "1008"
}, {
  "botStatus" : "New",
  "requiredByFileId" : 0.8008281904610115,
  "permission" : {
    "move" : true,
    "viewHistory" : true,
    "upload" : true,
    "publishBotstore" : true,
    "run" : true,
    "delete" : true,
    "viewContent" : true,
    "download" : true,
    "revertCheckout" : true,
    "clone" : true,
    "editContent" : true,
    "createFolder" : true,
    "cancelCheckout" : true,
    "labelBots" : true
  },
  "label" : "label",
  "type" : "text/plain",
  "url" : "https://contorlroom.com/v1/repository/97/1008/download?version=latest",
  "versionNumber" : 0.0,
  "path" : "Automation Anywhere\\\\Bots\\\\Example_bots\\\\sample.txt",
  "dependencyType" : "NONE",
  "size" : 72.0,
  "lockedBy" : "0",
  "name" : "sample.txt",
  "id" : "1008"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

List of immediate parents

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

delete /files/{id}

Delete a file (filesIdDelete)

Use this endpoint to delete a file. You must specify unique ID of the file you want to delete. To view the ID of the file, use the file/list endpoint.

Path parameters

id (required)

Path Parameter — Unique ID of the file

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK

400

Bad Request Error

401

Authentication required Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

post /files/packagesVersionUpdate

Execute package version update (filesPackagesVersionUpdatePost)

Use this endpoint to execute package version update.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body PackageVersionUpdateRequestV2 (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

post /files/version/assignLabel

Assign label to a bot (filesVersionAssignLabelPost)

Use this endpoint to assign a production label for a particular version of a bot. Currently only PRODUCTION is supported.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body AssignLabelForProduction (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

delete /folders/{folderid}

Delete a folder (foldersFolderidDelete)

Use this endpoint to delete a folder. You must specify the ID of the folder. To view the ID of the folder, use the folders/{folderid}/list endpoint.

Path parameters

folderid (required)

Path Parameter — Unique ID of the folder.

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

204

Delete Successful.

400

Bad Request.

401

Authentication required.

403

Folder or file has no permission either upload,download,delete,execute or run. FolderListSpecificError

404

Either the folder doesn't exist, or the user doesn't have a single permission associated with the folder.

412

The folder is not empty so it cannot be deleted.

500

Internal Server error Error

Up

post /folders/{folderid}/list

List sub-folders & files (foldersFolderidListPost)

Use this endpoint to list all the sub-folders and files under a parent folder. You must specify the ID of a parent folder. To view the ID of the parent folder, use the file/list endpoint.

Path parameters

folderid (required)

Path Parameter — Unique ID of the folder.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

FoldersAndFilesFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 4525,
    "offset" : 0
  },
  "list" : [ {
    "botVersionLabel" : "PRODUCTION",
    "metadata" : true,
    "botStatus" : "NEW",
    "isEdited" : true,
    "folderCount" : 2.0,
    "type" : "application/vnd.aa.directory",
    "path" : "Automation Anywhere\\\\Bots",
    "codeAnalysisResult" : "NOT_APPLICABLE",
    "originalVersion" : 1.0,
    "lockedBy" : "lockedBy",
    "hasTriggers" : true,
    "id" : "155524",
    "locked" : "locked",
    "workspaceId" : 0,
    "productionVersion" : "1",
    "hasErrors" : true,
    "lastModifiedBy" : "97",
    "permission" : {
      "move" : true,
      "viewHistory" : true,
      "upload" : true,
      "publishBotstore" : true,
      "run" : true,
      "delete" : true,
      "viewContent" : true,
      "download" : true,
      "revertCheckout" : true,
      "clone" : true,
      "editContent" : true,
      "createFolder" : true,
      "cancelCheckout" : true,
      "labelBots" : true
    },
    "uri" : "uri",
    "version" : "0",
    "parentId" : "108889",
    "versionNumber" : 0.0,
    "workspaceType" : "PUBLIC",
    "folder" : true,
    "size" : "450",
    "latestVersion" : "2",
    "createdBy" : "97",
    "name" : "my_bots",
    "lastModified" : "2022-07-22T10:49:14.603+0000"
  }, {
    "botVersionLabel" : "PRODUCTION",
    "metadata" : true,
    "botStatus" : "NEW",
    "isEdited" : true,
    "folderCount" : 2.0,
    "type" : "application/vnd.aa.directory",
    "path" : "Automation Anywhere\\\\Bots",
    "codeAnalysisResult" : "NOT_APPLICABLE",
    "originalVersion" : 1.0,
    "lockedBy" : "lockedBy",
    "hasTriggers" : true,
    "id" : "155524",
    "locked" : "locked",
    "workspaceId" : 0,
    "productionVersion" : "1",
    "hasErrors" : true,
    "lastModifiedBy" : "97",
    "permission" : {
      "move" : true,
      "viewHistory" : true,
      "upload" : true,
      "publishBotstore" : true,
      "run" : true,
      "delete" : true,
      "viewContent" : true,
      "download" : true,
      "revertCheckout" : true,
      "clone" : true,
      "editContent" : true,
      "createFolder" : true,
      "cancelCheckout" : true,
      "labelBots" : true
    },
    "uri" : "uri",
    "version" : "0",
    "parentId" : "108889",
    "versionNumber" : 0.0,
    "workspaceType" : "PUBLIC",
    "folder" : true,
    "size" : "450",
    "latestVersion" : "2",
    "createdBy" : "97",
    "name" : "my_bots",
    "lastModified" : "2022-07-22T10:49:14.603+0000"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

List of sub folders & files retrieved successfully. FoldersAndFilesFilterResponse

400

Bad Request.

401

Authentication required.

403

Folder or file has no permission either upload,download,delete,execute or run. FolderListSpecificError

404

Folder or file is not found in control room. FolderListSpecificError

500

Internal Server error Error

Up

post /folders/{folderid}

Create a folder (foldersFolderidPost)

Use this endpoint to create a folder within the folder ID provided. You must specify the ID of a parent folder and a sub folder is created within this parent folder. To view the ID of the parent folder, use the file/list endpoint.

Path parameters

folderid (required)

Path Parameter — Unique ID of the folder.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body CreateFolderRequest (required)

Body Parameter —

Return type

Bot

Example data

Content-Type: application/json

{
  "productionVersion" : "productionVersion",
  "lastModifiedBy" : "275",
  "permission" : {
    "download" : true,
    "upload" : true,
    "run" : true,
    "delete" : true
  },
  "directory" : "directory",
  "parentId" : "108889",
  "path" : "Automation Anywhere\\\\Bots\\\\new marks bots",
  "size" : 947,
  "lockedBy" : "0",
  "latestVersion" : "latestVersion",
  "fileLastModified" : "2022-07-19T23:08:49.150+0000",
  "name" : "new marks bots",
  "id" : "155524",
  "lastModified" : "2022-07-19T23:08:49.150+0000",
  "locked" : "locked"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK Bot

400

Invalid request body or Public folder with the same name already exists #/responses/BadRequestBodyOrSameNameFolderErrorCode

401

Authentication required.

403

Folder or file has no permission either upload,download,delete,execute or run. FolderListSpecificError

404

Folder or file is not found in control room. FolderListSpecificError

412

A folder exists in the public workspace with the same name, therefore this folder cannot be created.

500

Internal Server error Error

Up

put /folders/{folderid}

Edit details of a folder (foldersFolderidPut)

Use this endpoint to edit details of a folder such as the name, parent folder ID, and description. You must specify the ID of the folder. To view the ID of the folder, use the folders/{folderid}/list endpoint.

Path parameters

folderid (required)

Path Parameter — Unique ID of the folder.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body EditFolderRequest (required)

Body Parameter —

Return type

Bot

Example data

Content-Type: application/json

{
  "productionVersion" : "productionVersion",
  "lastModifiedBy" : "275",
  "permission" : {
    "download" : true,
    "upload" : true,
    "run" : true,
    "delete" : true
  },
  "directory" : "directory",
  "parentId" : "108889",
  "path" : "Automation Anywhere\\\\Bots\\\\new marks bots",
  "size" : 947,
  "lockedBy" : "0",
  "latestVersion" : "latestVersion",
  "fileLastModified" : "2022-07-19T23:08:49.150+0000",
  "name" : "new marks bots",
  "id" : "155524",
  "lastModified" : "2022-07-19T23:08:49.150+0000",
  "locked" : "locked"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK Bot

400

Bad Request Error

403

Forbidden Error

404

Not found Error

412

The folder has more than 100 bots, or has cloned or checked out bots #/responses/TooManyBotsOrFolderHasCheckedOutAndClonedBots

500

Internal Server error Error

Up

post /recover

Recover bots and files (recoverPost)

Use this endpoint to recover bots and files from the non-empty private repository of a deleted user to a new user (Bot creator/Citizen developer) having empty private repository.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RepositoryRecoveryRequest (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

OK

400

Bad Request Error

403

Forbidden Error

404

Not found Error

412

412 Precondition Failed Error

500

Internal Server error Error

Up

get /role/{roleid}/folder/{folderid}/permissions

View repository role permissions (roleRoleidFolderFolderidPermissionsGet)

Use this endpoint to view role permissions for a specific role ID and folder ID. You must specify the role and folder ID for which you want to view the permission. This API lists the permissions the role ID has to clone, upload, download, delete, run, or view contents of a specific folder.

Path parameters

roleid (required)

Path Parameter — Role ID that is associated with a custom defined role.

folderid (required)

Path Parameter — Unique ID of the folder.

Query parameters

includeChildren (optional)

Query Parameter — Include children when retrieving the permissions. Specify true to include children or false to not include children.

Return type

RepositoryPermissions

Example data

Content-Type: application/json

[ {
  "permissions" : [ {
    "name" : "clone",
    "enabled" : true
  }, {
    "name" : "clone",
    "enabled" : true
  } ],
  "folderId" : 14
}, {
  "permissions" : [ {
    "name" : "clone",
    "enabled" : true
  }, {
    "name" : "clone",
    "enabled" : true
  } ],
  "folderId" : 14
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK RepositoryPermissions

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

put /role/{roleid}/permissions

Add or update repository role permissions (roleRoleidPermissionsPut)

Use this endpoint to add new permission or update existing repository role permissions for a user created role. To use this endpoint, you must be logged in as the Admin.

Path parameters

roleid (required)

Path Parameter — Role ID that is associated with a custom defined role.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FolderPermission (required)

Body Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

201

Created

400

Bad Request Error

403

Forbidden Error

404

Not found Error

500

Internal Server error Error

Up

post /workspaces/{workspaceType}/files/list

Lists sub-folders and files in a workspace (workspacesWorkspaceTypeFilesListPost)

Use this endpoint to view all the sub folders and files in the public or private workspace. You must specify the workspace type from which you want to view the files.

Path parameters

workspaceType (required)

Path Parameter — Type of the workspace which is either public or private format: string

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

FoldersAndFilesFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 4525,
    "offset" : 0
  },
  "list" : [ {
    "botVersionLabel" : "PRODUCTION",
    "metadata" : true,
    "botStatus" : "NEW",
    "isEdited" : true,
    "folderCount" : 2.0,
    "type" : "application/vnd.aa.directory",
    "path" : "Automation Anywhere\\\\Bots",
    "codeAnalysisResult" : "NOT_APPLICABLE",
    "originalVersion" : 1.0,
    "lockedBy" : "lockedBy",
    "hasTriggers" : true,
    "id" : "155524",
    "locked" : "locked",
    "workspaceId" : 0,
    "productionVersion" : "1",
    "hasErrors" : true,
    "lastModifiedBy" : "97",
    "permission" : {
      "move" : true,
      "viewHistory" : true,
      "upload" : true,
      "publishBotstore" : true,
      "run" : true,
      "delete" : true,
      "viewContent" : true,
      "download" : true,
      "revertCheckout" : true,
      "clone" : true,
      "editContent" : true,
      "createFolder" : true,
      "cancelCheckout" : true,
      "labelBots" : true
    },
    "uri" : "uri",
    "version" : "0",
    "parentId" : "108889",
    "versionNumber" : 0.0,
    "workspaceType" : "PUBLIC",
    "folder" : true,
    "size" : "450",
    "latestVersion" : "2",
    "createdBy" : "97",
    "name" : "my_bots",
    "lastModified" : "2022-07-22T10:49:14.603+0000"
  }, {
    "botVersionLabel" : "PRODUCTION",
    "metadata" : true,
    "botStatus" : "NEW",
    "isEdited" : true,
    "folderCount" : 2.0,
    "type" : "application/vnd.aa.directory",
    "path" : "Automation Anywhere\\\\Bots",
    "codeAnalysisResult" : "NOT_APPLICABLE",
    "originalVersion" : 1.0,
    "lockedBy" : "lockedBy",
    "hasTriggers" : true,
    "id" : "155524",
    "locked" : "locked",
    "workspaceId" : 0,
    "productionVersion" : "1",
    "hasErrors" : true,
    "lastModifiedBy" : "97",
    "permission" : {
      "move" : true,
      "viewHistory" : true,
      "upload" : true,
      "publishBotstore" : true,
      "run" : true,
      "delete" : true,
      "viewContent" : true,
      "download" : true,
      "revertCheckout" : true,
      "clone" : true,
      "editContent" : true,
      "createFolder" : true,
      "cancelCheckout" : true,
      "labelBots" : true
    },
    "uri" : "uri",
    "version" : "0",
    "parentId" : "108889",
    "versionNumber" : 0.0,
    "workspaceType" : "PUBLIC",
    "folder" : true,
    "size" : "450",
    "latestVersion" : "2",
    "createdBy" : "97",
    "name" : "my_bots",
    "lastModified" : "2022-07-22T10:49:14.603+0000"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json
application/vnd.aa.form
application/vnd.aa.taskbot
application/vnd.aa.headlessbot
application/octet-stream

Responses

200

List of sub folders & files retrieved successfully. FoldersAndFilesFilterResponse

400

Bad Request.

401

Authentication required.

403

Folder or file has no permission either upload,download,delete,execute or run. FolderListSpecificError

404

Folder or file is not found in control room. FolderListSpecificError

500

Internal Server error Error

Models

Methods

Table of Contents

AssignLabelForProduction
Bot
BotPermission
BotsResponse
CreateFolderRequest
EditFileDependenciesRequest
EditFolderRequest
Error
File
FileDependency
FileDependencyResponse
FileParentsResponse
Filter
FilterRequest
FolderListSpecificError
FolderPermission
FoldersAndFilesFilterResponse
HttpStatusCode
PackageVersionUpdateInfo
PackageVersionUpdateRequestV2
PageRequest
PageResponse
Permission
RepoRolePermission
RepositoryPermissions
RepositoryRecoveryRequest
Sort
path

`AssignLabelForProduction` Up

Label a version of bot for production request, Currently only PRODUCTION is supported.

fileId (optional)

Integer Unique ID of the file

example: 545

label (optional)

String File Label.

example: PRODUCTION

versionNumber (optional)

Integer File version. Only available in case the item type is bot

example: 1

`Bot` Up

id (optional)

String The unique ID of the displayed objects (bots, folders, or files)

example: 155524

parentId (optional)

String The unique ID of the parent folder

example: 108889

name (optional)

String Name of the bot, file, or folder

example: new marks bots

permission (optional)

BotPermission

lastModified (optional)

String Date and time of last update

example: 2022-07-19T23:08:49.150+0000

lastModifiedBy (optional)

String ID of the user who last updated the bot or file

example: 275

path (optional)

String Path of the file or folder in the repository

example: Automation Anywhere\\Bots\\new marks bots

directory (optional)

String Flag for directory

size (optional)

Integer Size in KB

example: 947

locked (optional)

String Indicates whether the file is locked (applicable only with VCS ON)

productionVersion (optional)

String Current production version of the bot (applicable only with VCS ON)

lockedBy (optional)

String User id who has locked the bot (applicable only with VCS ON)

example: 0

latestVersion (optional)

String Latest version of the bot (applicable only with VCS ON)

fileLastModified (optional)

String Date and time when the bot was last updated

example: 2022-07-19T23:08:49.150+0000

`BotPermission` Up

delete (optional)

Boolean Indicates if the current logged in user has rights to delete the bot

download (optional)

Boolean Indicates if the current logged in user has rights to download (check-out) the bot

upload (optional)

Boolean Indicates if the current logged in user has rights to upload (check-in) the bot

run (optional)

Boolean Indicates if the current logged in user has rights to run or schedule the bot

`BotsResponse` Up

page (optional)

PageResponse

list (optional)

array[Bot] list of bots.

`CreateFolderRequest` Up

folderName (optional)

String Name of the new folder you want to create

example: my_bots

`EditFileDependenciesRequest` Up

childFileIds (optional)

array[Integer] Indicates the child file IDs that must be added as a dependency to the specified parent file ID.

`EditFolderRequest` Up

folderId (optional)

String Unique ID of the folder you want to edit the details

example: 164086

name (optional)

String Name of the folder

example: my_bots

description (optional)

String Description of the folder

example: My sample bots

parentId (optional)

String Unique ID of the parent folder

example: 14

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

`File` Up

File or folder

id (optional)

String Folder identifier

example: 155524

parentId (optional)

String Parent folder identifier

example: 108889

name (optional)

String Name of file or folder

example: my_bots

folder (optional)

Boolean Whether the specified type is a folder or not

folderCount (optional)

BigDecimal Number of sub-folders

example: 2.0

productionVersion (optional)

String Current production version of the bot (applicable only with VCS ON)

example: 1

latestVersion (optional)

String Latest version of the bot (applicable only with VCS ON)

example: 2

type (optional)

String The content type, also known as MIME type of the file

example: application/vnd.aa.directory

path (optional)

String Path of the file or folder in the repository

example: Automation Anywhere\\Bots

size (optional)

String Size of the file. Available only if the item type is file

example: 450

lockedBy (optional)

String File locked by information. Available only if the item type is bot and VCS is 'ON'.

locked (optional)

String Whether the file is locked or not. Available only if the item type is file

lastModified (optional)

String Date and time when the bot was last updated

example: 2022-07-22T10:49:14.603+0000

lastModifiedBy (optional)

String ID of the user who last updated the Bot/file

example: 97

permission (optional)

Permission

createdBy (optional)

String ID of the user who created the Bot/file

example: 97

workspaceId (optional)

Integer Unique workspace id of user. A workspaceId of 0 indicates the PUBLIC workspace. All others are considered as PRIVATE workspace.

example: 0

botStatus (optional)

String Status of the Bot [DRAFT, NEW, PUBLIC, CHECKED_OUT, CLONED]

example: NEW

hasErrors (optional)

Boolean Whether the specified file or folder contains errors

workspaceType (optional)

String Type of the workspace which is either PUBLIC or PRIVATE

example: PUBLIC

metadata (optional)

Boolean Whether the specified file or folder is metadata

uri (optional)

String Universal resourse identifier for the file/folder

version (optional)

String Version of the bot

example: 0

hasTriggers (optional)

Boolean Indicates whether the Bot has any triggers set

isEdited (optional)

Boolean Indicates whether the Bot is previously edited

versionNumber (optional)

BigDecimal File version. Only available in case the item type is bot

example: 0.0

botVersionLabel (optional)

String Label version of the bot. Only available in case the item type is bot

example: PRODUCTION

originalVersion (optional)

BigDecimal The actual version of the file or folder.

example: 1.0

codeAnalysisResult (optional)

String Code analysis result of a bot

Enum:

NOT_APPLICABLE

NOT_SCANNED

NO_VIOLATIONS

LOW_SEVERITY_VIOLATIONS

HIGH_SEVERITY_VIOLATIONS

`FileDependency` Up

File dependency

id (optional)

String Unique ID of the file

example: 1008

name (optional)

String Name of the file

example: sample.txt

path (optional)

String Path of the file in the repository

example: Automation Anywhere\\Bots\\Example_bots\\sample.txt

size (optional)

String Size of the file. Only available in case the item type is file

example: 72

type (optional)

String The content type, also known as MIME type, of the file

example: text/plain

dependencyType (optional)

String The type of the related object. NONE - If the bot or file does not have a parent, then the API will return the same bot or file. SCANNED - It is the relation with the child bots or files which are scanned and found automatically. MANUAL - It is the relation with the bots or files that are added to the parent bot manually.

example: NONE

url (optional)

String URL of the bot or file

example: https://contorlroom.com/v1/repository/97/1008/download?version=latest

requiredByFileId (optional)

String Parent file or folder id

example: 0

lockedBy (optional)

String User ID who had locked the File. Only available in case the item type is bot and VCS is 'ON'.

example: 0

botStatus (optional)

String Status of the Bot [Public/Checkout/New/Clone]

example: New

permission (optional)

Permission

versionNumber (optional)

String File version

example: 0

label (optional)

String File label

`FileDependencyResponse` Up

dependencies (optional)

array[FileDependency]

`FileParentsResponse` Up

Bot or File

id (optional)

String Unique ID of the file

example: 1008

name (optional)

String Name of the File

example: sample.txt

path (optional)

String Relative path of the file

example: Automation Anywhere\\Bots\\Example_bots\\sample.txt

size (optional)

BigDecimal Size of the file. Only available in case the item type is file

example: 72.0

type (optional)

String The content type, also known as MIME type, of the file

example: text/plain

dependencyType (optional)

String The type of the related object. NONE - If the bot or file does not have a parent, then the API will return the same bot or file. SCANNED - It is the relation with the child bots or files which are scanned and found automatically. MANUAL - It is the relation with the bots or files that are added to the parent bot manually.

example: NONE

url (optional)

String URL of the bot or file

example: https://contorlroom.com/v1/repository/97/1008/download?version=latest

requiredByFileId (optional)

BigDecimal Parent file or folder id

lockedBy (optional)

String User ID who has locked the bot [Applicable to checked out file]

example: 0

botStatus (optional)

String Status of the Bot [Public/Checkout/New/Clone]

example: New

permission (optional)

Permission

versionNumber (optional)

BigDecimal File version. Only available in case the item type is bot

example: 0.0

label (optional)

String File label

`Filter` Up

Filters the result based on operator, field, or value.

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

example: substring

operands (optional)

array[Filter]

example: {operator=substring, field=name, value=bot1}

field (optional)

String Filtering field can be either name, lastModified, path, or folder.

example: name

value (optional)

String Filter value

example: mike_bots

`FilterRequest` Up

Filter request, which includes filtering, sorting, and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`FolderListSpecificError` Up

code (optional)

String Corresponding Error code for error message.

message (optional)

String Message describing error.

details (optional)

String More details of the error message.

correctiveAction (optional)

String Corrective action to be taken to get rid of this error.

`FolderPermission` Up

folderId (optional)

Integer

example: 14

permissions (optional)

array[RepoRolePermission]

`FoldersAndFilesFilterResponse` Up

page (optional)

PageResponse

list (optional)

array[File] list of directories & files.

`HttpStatusCode` Up

Status code("OK")

`PackageVersionUpdateInfo` Up

Package version update information

package_name (optional)

String Name of the package

example: MessageBox

package_version (optional)

String Version of the package

example: 2.0.0-20200716-211611

`PackageVersionUpdateRequestV2` Up

Package version update request

name (optional)

String Name of the request

example: Test

description (optional)

String Description of the request

example: Test description

package_info (optional)

array[PackageVersionUpdateInfo]

file_ids (optional)

array[Object] List of the file ids

example: [41, 42]

downgrade_version (optional)

Boolean True if the package version downgrade is allowed

example: true

label (optional)

String File label

example: Production

`PageRequest` Up

Pagination rules, allows you to filter based on desired page

offset (optional)

Integer Page starting index

length (optional)

Integer Page length

example: 100

`PageResponse` Up

Pagination response

offset (optional)

Integer The starting list offset, used for pagination.

total (optional)

Integer Total number of items

example: 4525

totalFilter (optional)

Integer Total number of items matching filter

example: 1

`Permission` Up

delete (optional)

Boolean Indicates if the current logged in user has permission to delete the bot

download (optional)

Boolean Indicates if the current logged in user has permission to download(check-out) the bot

clone (optional)

Boolean Indicates if the current logged in user has permission to clone the bot

upload (optional)

Boolean Indicates if the current logged in user has permission to upload(check-in) the bot

run (optional)

Boolean Indicates if the current logged in user has permission to run\schedule the bot

viewContent (optional)

Boolean Indicates if the current logged in user has permission to view the bot content (bot logic).

publishBotstore (optional)

Boolean Indicates if the current logged in user has permission to publish the bot to botstore.

editContent (optional)

Boolean Indicates if the current logged in user has permission to modify a bot.

createFolder (optional)

Boolean Indicates if the current logged in user has permission to create a folder.

move (optional)

Boolean Indicates if the current logged in user has permission to move the bot to another folder.

cancelCheckout (optional)

Boolean Indicates if the current logged in user has permission to cancel checkout for the bot.

revertCheckout (optional)

Boolean Indicates if the current logged in user has permission to revert check out for the bot.

viewHistory (optional)

Boolean Indicates if the current logged in user has permission to view history for the bot.

labelBots (optional)

Boolean Indicates if the current logged in user has permission to label the bot.

`RepoRolePermission` Up

name (optional)

String

Enum:

clone

update

download

delete

run

viewcontent

enabled (optional)

Boolean

`RepositoryPermissions` Up

List of folder permissions

`RepositoryRecoveryRequest` Up

Repository recover request

name (optional)

String Name of the recover activity

example: Recover1

sourceUserId (optional)

Integer Unique ID of the deleted user

targetUserId (optional)

Integer Unique ID of the target user

`Sort` Up

By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified by using the sort query parameter.

field (optional)

String Field name to sort by

example: directory

direction (optional)

String Sorting direction

Enum:

asc

desc

`path` Up

File path