File dependencies API

Use this API to view file dependencies to a parent Task Bot. It will list all the dependencies of a file.

Request

GET http://{{localhost}}/v1/files/{aafileid}/filedependency/{dependencytype}
Header: X-Authorization <<authentication token>>
All API calls must contain an authentication token in the request header. Generate a token with the Enterprise 11 Authentication API.

Request Parameters

Parameter Type Description
aafileid Integer parent file id for which you want to view the dependencies
dependencytype String

Select a dependency type

  • latest - Retrieves the latest dependencies
  • production - Retrieves the dependencies of the version labeled production.
 
GET http://{{localhost}}/v1/files/698/filedependency/latest

Response

{
   "relativePath":"Automation Anywhere\\My Tasks\\parent.atmx",
   "fileId":698,
   "exists":true,
   "permitted":true,
   "children":[
      {
         "parentId":698,
         "relativePath":"Automation Anywhere\\My Docs\\Telecom-Discount.csv",
         "fileId":693,
         "exists":true,
         "permitted":true,
         "children":[
            
         ],
         "name":"Telecom-Discount.csv",
         "productionVersionApplicable":false,
         "cyclic":false,
         "isProtected":false,
         "clientSideUpdatedOn":"2019-02-14T13:16:02Z",
         "isVariablizedPath":false,
         "dependencyMode":0
      },
      {
         "parentId":698,
         "relativePath":"Automation Anywhere\\My Tasks\\bonus-wlm.atmx",
         "fileId":694,
         "exists":true,
         "permitted":true,
         "children":[
            
         ],
         "name":"bonus-wlm.atmx",
         "productionVersionApplicable":false,
         "cyclic":false,
         "isProtected":false,
         "clientSideUpdatedOn":"2021-01-20T06:03:33Z",
         "isVariablizedPath":false,
         "dependencyMode":0
      },
      {
         "parentId":698,
         "relativePath":"Automation Anywhere\\My Tasks\\Abbyy.atmx",
         "fileId":695,
         "exists":true,
         "permitted":true,
         "children":[
            
         ],
         "name":"Abbyy.atmx",
         "productionVersionApplicable":false,
         "cyclic":false,
         "isProtected":false,
         "clientSideUpdatedOn":"2020-03-06T14:03:35Z",
         "isVariablizedPath":false,
         "dependencyMode":0
      },
      {
         "parentId":698,
         "relativePath":"Automation Anywhere\\My Tasks\\child-bot.atmx",
         "fileId":696,
         "exists":true,
         "permitted":true,
         "children":[
            
         ],
         "name":"child-bot.atmx",
         "productionVersionApplicable":false,
         "cyclic":false,
         "isProtected":false,
         "clientSideUpdatedOn":"2021-01-21T06:15:35Z",
         "isVariablizedPath":false,
         "dependencyMode":0
      }
   ],
   "name":"parent.atmx",
   "productionVersionApplicable":false,
   "cyclic":false,
   "isProtected":false,
   "clientSideUpdatedOn":"2021-02-11T04:36:03Z",
   "isVariablizedPath":false,
   "dependencyMode":0
}

Response Parameters

Parameter Type Description
relativepath String Path of the parent file.
fileId Integer File Id of the parent.
Exists Boolean Check to see if the file exists.
  • True - File exists
  • False - File does not exist
Children Array Array of Children objects that lists all the file dependencies