Contact
info-emea@leapwork.com
+45 35 25 14 14
+45 35 25 14 14
Leapwork ApS
Store Kongensgade 72C,
1264 Copenhagen K,
Denmark
Find tutorials, guides and use case examples in the
Learning centerGet Hierarchy
'Get Hierarchy' returns a hierarchical list of the Asset Menu (Folders, flows, data etc.). The returned hierarchy contains detailed information about the following types of items: 'Folder', 'Flow', 'DataFile', 'SubFlow', 'InteractiveImage', 'DesktopElement', 'WebElement', 'InteractiveImageCollection'.
The ItemIDs in the hierarchy can be used as import to the Import/Export endpoints and individual itemId can be also used as 'targetItemId' in Import/Export endpoints.
http://{controllerMachine}:{controllerPort}/api/v3/hierarchy/{itemId}
Field | Type | Description | Comments |
---|---|---|---|
itemId | string | Optional: Unique identifier for Items in the Asset hierarchy, if not provided then returns all existing hierarchy items | The itemId can be from the following types of items: - 'Folder' - 'Flow' - 'DataFile' - 'SubFlow' - 'InteractiveImage' - 'DesktopElement' - 'WebElement' - 'InteractiveImageCollection' |
curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v3/hierarchy/{itemId}'
$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/hierarchy/{itemId}" -ContentType "application/json" -Headers $headers -Method GET
List of Variables
[ { "$id": "1", "Id": "a3caa583-6243-4cf0-a411-2d4fdabc0e53", "Title": "Projects", "Type": "Folder", "DateCreation": "12/19/2018 12:38:02 PM +00:00", "DateModify": "12/19/2018 12:38:02 PM +00:00", "Children": [ { "$id": "2", "Id": "87705158-39ba-4148-8cdb-8e8227e69df7", "Title": "Automation case 1", "Type": "Flow", "ParentId": "a3caa583-6243-4cf0-a411-2d4fdabc0e53", "DateCreation": "10/3/2018 1:46:29 PM +00:00", "DateModify": "12/19/2018 1:36:30 PM +00:00", "Children": [] } ] }, { "$id": "3", "Id": "74821680-c687-4b4c-8872-59ab47e1af8c", "Title": "RPA Flow", "Type": "Flow", "PreviousSiblingId": "a3caa583-6243-4cf0-a411-2d4fdabc0e53", "DateCreation": "10/3/2018 1:46:39 PM +00:00", "DateModify": "12/19/2018 12:39:26 PM +00:00", "Children": [] }, { "$id": "4", "Id": "e2b5912c-254b-406a-bf4f-5771fa8b7e30", "Title": "Citrix Test", "Type": "Flow", "PreviousSiblingId": "74821680-c687-4b4c-8872-59ab47e1af8c", "DateCreation": "10/3/2018 1:46:50 PM +00:00", "DateModify": "12/19/2018 12:39:39 PM +00:00", "Children": [] } ] |
Field | Type | Description | Values |
---|---|---|---|
$id | string | ID of internal item(Folder/ Flow/Element etc.) | |
Title | string | Title of item | |
Type | string | Type of item | 'Folder','Flow','SubFlow','InteractiveImage', 'DesktopElement','WebElement','DataFile' 'InteractiveImageCollection' |
PreviousSiblingId | string | Previous item Id | |
DateCreation | string | Item Creation date | |
DateModify | string | Item Modification date | |
Children | List<AssetHierarchyApiInfo> | List of all children | |
AssetHierarchyApiInfo | List of objects | ||
$id | string | ID of internal item (Folder/ Flow/Element etc.) | |
Title | string | Title of item | |
Type | string | Type of item | 'Folder','Flow','SubFlow','InteractiveImage', 'DesktopElement','WebElement','DataFile' 'InteractiveImageCollection' |
ParentId | string | Parent item Id | |
DateCreation | string | Item Creation date | |
DateModify | string | Item Modification date | |
Children | List<AssetHierarchyApiInfo> | List of all children |
Response Code
200 (OK)
404 (Not Found)
401 (Unauthorized, Incorrect access Keys)
400 (Bad Request)
404 (Asset Not Found)
500 (Internal Server Error)
Leapwork ApS
Store Kongensgade 72C,
1264 Copenhagen K,
Denmark
©2023, LEAPWORK. All rights reserved. Legal