Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Get Immediate Parents API

  • Updated: 2022/03/31

    Get Immediate Parents API

    Use this API to get the immediate parents of a Task Bot. The Get Immediate Parents API gets a fileId as input and lists the immediate parent details.

    Request

    GET http://{{ControlRoomURL}}/v2/repository/files/{fileid}/parents
    Header: X-Authorization <<authentication token>>
    All API calls must contain an authentication token in the request header. Generate a token with the Authenticate (username and password).

    Request Parameters

    Parameter Type Required Description
    fileid Integer Yes File id for which you want to view the parents.
    GET http://{{ControlRoomURL}}/v2/repository/files/698/parents

    Response

    {
       "dependencies":[
          {
             "id":"349",
             "name":"Parent",
             "path":"Automation Anywhere\\Bots\\demo_test\\Parent",
             "size":"1536",
             "type":"application/vnd.aa.taskbot",
             "dependencyType":"SCANNED",
             "url":"",
             "requiredByFileId":"349",
             "version":"0",
             "lockedBy":"0",
             "botStatus":"PUBLIC",
             "permission":{
                "delete":true,
                "download":true,
                "upload":true,
                "run":true,
                "publishBotstore":false,
                "viewContent":true,
                "clone":true,
                "editContent":false,
                "createFolder":false,
                "move":false,
                "cancelCheckout":false,
                "revertCheckout":false,
                "viewHistory":false,
                "labelBots":false
             },
             "versionNumber":"0",
             "label":""
          }
       ]
    }

    Response Parameters

    Parameter Type Description
    id Integer File Id of the parent.
    name String Name of the parent.
    path String Path of the parent file.
    size Integer Size of the parent file.
    type String Type of the parent.
    dependencyType String The type of the related object.
    • NONE: It is the relation with the parent file. Parent to parent relation.
    • 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.
    url String Not pertinent to this API.
    requiredByFileId Integer The Id of the parent bot that is calling the child bot.
    version Integer Version of the parent file.
    lockedBy Integer The user that has checked out this file.
    botStatus String bot status. Possible values can be: NEW, CHECKED_OUT, CLONED, and PUBLIC.
    permission Object Lists all the permissions of the parent.
    Send Feedback