Endpoint:/sites/{sitetId}/awe-tasks-folders/{aweTaskFolderID}

NOTE: Available as of EFT 8.1.0

Returns advanced workflow folder from specified site (GET), updates advanced workflow folder settings (PATCH), and deletes advanced workflow folder (DELETE).

GET
PATCH
DELETE

Method & URL

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

GET Body Sample

Copy

### GET A SPECIFIC AWE TASK FOLDERS ###
@AWEId = 859dc605-0600-42ab-a1fa-f23f5a19e8cd
GET https://{{host}}/admin/v2/sites/{{Siteid}}/awe-tasks-folders/{{AWEId}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy

{"data":{"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 awe folder information###
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 

$aweID = $siteList.data[1].id
Write-Output "----"
$siteList = Invoke-RestMethod 
-Uri "$baseURL/v2/sites/$siteID/awe-tasks-folders/$aweID" 
-Method 'GET' -Headers $authHeader
Write-Output $siteList | ConvertTo-Json

Method & URL

PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/awe-tasks-folders/{{AWEId}}

PATCH Body Sample

Copy

@AWEId = dc70ad42-47ad-4239-a81a-fe9d650820aa
### PATCH AWE TASK FOLDERS ###
PATCH  https://{{host}}/admin/v2/sites/{{Siteid}}/awe-tasks-folders/
{{AWEId}} HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
  "data": {
    "id": "dc70ad42-47ad-4239-a81a-fe9d650820aa",
    "attributes": {
      "name": "NewFirstFolder"
    },
    "type": "aweTaskFolder"
  }
}
###

PATCH Response Body Sample

Copy

{"data":{"id":"dc70ad42-47ad-4239-a81a-fe9d650820aa","type":"aweFolder",
"attributes":{"name":"NewFirstFolder","tasks":[{"id":
"432c99b4-fcf3-5472-981d-416946a9b95a","name":
"Sample - Excel Actions","created":"2022-08-01","description":
"My Description"},{"id":"40536ad8-327e-53d6-8566-0d7722156b42",
"name":"Sample - FTP Actions","created":"2022-08-01","description":""}]},
"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"}}

PATCH PowerShell Sample

Copy

$folderID = $aweFolderList.data[1].id

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

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

Method & URL

DELETE https://{{host}}/admin/v2/sites/{{Siteid}}/awe-tasks-folders/{{AWEId}}

NOTE: The folder should be emptied before it is deleted; else the EFT will return a HTTP 500 Server error.

DELETE Body Sample

Copy

### AWEId will be the id of a folder to be deleted.
@AWEId = e1d62bf1-8bdd-4e82-8efd-395467069306
### DELETE AWE TASK FOLDERS ###
DELETE  https://{{host}}/admin/v2/sites/{{Siteid}}/awe-task-folders/{{AWEId}} 
HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

DELETE Response Body Sample

Copy

HTTP/1.1 204 No Content
Date: Tue, 02 Aug 2022 17:47:50 GMT
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
Expires: -1
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' data:;
Referrer-Policy: no-referrer

DELETE PowerShell Sample

Copy

$folderID = $aweFolderList.data[1].id 

$deleteAWETASKReturn = Invoke-RestMethod -Uri 
"$baseURL/v2/sites/$siteID/awe-tasks-folders/$folderID" 
-Method 'DELETE' -Headers $authHeader
Write-Output $deleteAWETASKReturn | ConvertTo-Json