Endpoint:/sites/{siteId}/awe-tasks-folders

NOTE: Available as of EFT 8.1.0

(GET) Returns advanced workflow folder list from specified site and (POST) create advanced workflow folder for specified site

  • GET

  • POST

Method & URL

GET https://{{host}}/admin/v2/sites/{{Siteid}}/awe-task-folders

GET Body Sample

Copy
### GET ALL AWE TASK FOLDERS ###
GET https://{{host}}/admin/v2/sites/{{Siteid}}/awe-tasks-folders HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy
{"data":[{"id":"00000000-0000-0000-0000-000000000000","type":"aweFolder","attributes":
{"name":"<root>","tasks":[{"id":"92ac1ba6-5fcc-5b85-b5da-e1b3c4d4a300",
"name":"Sample - Environment Variables","created":"2022-08-01","description":""},
{"id":"432c99b4-fcf3-5472-981d-416946a9b95a","name":"Sample - Excel Actions",
"created":"2022-08-01","description":""},{"id":"df5f43bb-1f34-57be-9e59-75bd272ba408",
"name":"Sample - Expectations","created":"2022-08-01","description":""},
{"id":"cf774000-2d0a-5962-a060-111aa4d94d1c","name":"Sample - File Date Operations",
"created":"2022-08-01","description":""},{"id":"40536ad8-327e-53d6-8566-0d7722156b42",
"name":"Sample - FTP Actions","created":"2022-08-01","description":""},
{"id":"a6a79232-f9e5-5a14-b944-d7922e275fd0","name":"Sample - If and Else and EndIf",
"created":"2022-08-01","description":""},{"id":"27c02e7e-ef14-5c1f-b694-50e3ad672ae3",
"name":"Sample - Ping","created":"2022-08-01","description":""},
{"id":"dc274226-442e-5ee4-b968-35e5ebfbd521",
"name":"Sample - Query a CSV File","created":"2022-08-01","description":""},
{"id":"5cd49fc4-4f4d-5369-9901-d785aebf4f38",
"name":"Sample - Run Embedded Script","created":"2022-08-01","description":""},
{"id":"e61f958c-c541-5dc6-8f75-4ee68a9601e1",
"name":"Sample - Send E-mail","created":"2022-08-01","description":""},
{"id":"c72543b2-9374-5e9e-9fd6-85befa3dcf73",
"name":"Sample - Sites and Users through COM","created":"2022-08-01","description":""},
{"id":"d9f234c1-cb38-5afe-9416-71c33a2987c8","name":"Sample - Terminal Emulation",
"created":"2022-08-01","description":""},{"id":"c6b17e66-598b-5838-a3fd-b671e93bafb6",
"name":"Sample - _README FIRST_","created":"2022-08-01","description":""},
{"id":"8405b064-aa9a-46b8-b0b5-4c60eb3d3e09","name":"MyNewAWEScript","created":"2022-08-01",
"description":"Hello, world!"}]},"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/
awe-tasks-folders/00000000-0000-0000-0000-000000000000"}},
{"id":"793e3b44-cb54-47db-8116-9bc45a50d158","type":"aweFolder","attributes":
{"name":"AWE_Folder_Two","tasks":[]},
"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/
awe-tasks-folders/793e3b44-cb54-47db-8116-9bc45a50d158"}},
{"id":"859dc605-0600-42ab-a1fa-f23f5a19e8cd","type":"aweFolder","attributes":
{"name":"AWE _ Folder_One","tasks":[]},
"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/
awe-tasks-folders/859dc605-0600-42ab-a1fa-f23f5a19e8cd"}}],
"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/
awe-tasks-folders"}}

GET PowerShell Sample

Copy
####Added 2/01/2020
### Returns all site auto ban list###
Write-Output "AWE Task Folders"
Write-Output "----"
$siteList = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/awe-tasks-folders" 
-Method 'GET' -Headers $authHeader
Write-Output $siteList | ConvertTo-Json 

Method & URL

POST https://{{host}}/admin/v2/sites/{{Siteid}}/awe-task-folders

POST Body Sample

Copy
### create a folder named AWE_Folder_Three
###

###
POST https://{{host}}/admin/v2/sites/{{Siteid}}/awe-tasks-folders HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "type": "aweTaskFolder",
    "attributes": {
      "name": "AWE_Folder_Three"
    }
  }  
}
###

POST Response Body Sample

Copy
{"data":{"id":"dc70ad42-47ad-4239-a81a-fe9d650820aa","type":"aweFolder","attributes":
{"name":"AWE_Folder_Three","tasks":[]},"links":{
"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/
awe-tasks-folders/dc70ad42-47ad-4239-a81a-fe9d650820aa"}},
"links":{"self":"/admin/v2/sites/b65892e9-399d-4447-a3b1-477c08f0abca/awe-tasks-folders"}}

POST PowerShell Sample

Copy
####Added 2/01/2020
### Returns all site auto ban list###
Write-Output "AWE Task Folders"
Write-Output "----"
$siteList = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/awe-tasks-folders" 
-Method 'GET' -Headers $authHeader
Write-Output $siteList | ConvertTo-Json 

##POST SITE AWE TASKS FOLDERS
Write-Output "Site AWE TASK FOLDER POST"
Write-Output "-----"
$update = 
'{
  "data": {
    "type": "aweTaskFolder",
    "attributes": {
      "name": "AWE_Folder_FIVE-O"
    }
  }  
}'

$update = $update | ConvertFrom-Json
$update = $update | ConvertTo-Json -Depth 10
$postAWETASKReturn = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/awe-tasks-folders" 
-Method 'POST' -Headers $authHeader -Body $update
Write-Output $postAWETASKReturn | ConvertTo-Json