Endpoint: /sites/{siteid}/event-rule-folders/{folderid}

Get, update, or delete a specific site event rule folder data

Method & URL

GET https://[server URL]:[port]/admin/v2/sites/{siteId}/event-rule-folders/{folderid}

GET Body Sample

Copy 
###

@folderID = {{foldersList.response.body.$.data[0].id}}

GET https://{{host}}/admin/v2/sites/{{Siteid}}/event-rule-folders/{{folderID}} HTTP/1.1

Authorization: EFTAdminAuthToken {{AuthToken}}

###

GET Response Body Sample

Copy 
HTTP/1.1 200 OKDate: Tue, 09 Aug 2022 17:23:43 GMTContent-Type: application/vnd.api+jsonETag: "98C84003"Content-Length: 255Cache-Control: no-cache, no-store, must-revalidateExpires: -1X-Content-Type-Options: nosniffX-XSS-Protection: 1; mode=blockContent-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' data:;Referrer-Policy: no-referrer{"data": {"attributes": {"isRemote": false,"name": "<root>"},"id": "00000000-0000-0000-0000-000000000000","type": "eventRuleFolder"},"links": {"self": "/admin/v2/sites/6203305a-d7c6-499e-a59b-81500765f8f2/event-rule-folders/00000000-0000-0000-0000-000000000000"}}

GET PowerShell Sample

Copy 
Write-Output "ER Folders"

Write-Output "----"

#$siteID = Enter SiteID here

$folderList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/event-rule-folders" -Method 'GET' -Headers $authHeader

Write-Output $folderList | ConvertTo-Json

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

$foldersList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/event-rule-folders/$folderID" -Method 'GET' -Headers $authHeader

Write-Output $foldersList | ConvertTo-Json

Method & URL

PATCH https://[server URL]:[port]/admin/v2/sites/{siteId}/event-rule-folders/{folderid}

PATCH Body Sample

Copy 
PATCH https://{{host}}/admin/v2/sites/{{Siteid}}/event-rule-folders/{{folderID}} HTTP/1.1

Authorization: EFTAdminAuthToken {{AuthToken}}

{

  "data": {

    "attributes": {

      "isRemote": false,

      "name": "Folder of new events"

    },

    "type": "eventRuleFolder"

  }

}

PATCH Response Body Sample

Copy 
HTTP/1.1 200 OKDate: Tue, 09 Aug 2022 18:07:40 GMTContent-Type: application/vnd.api+jsonETag: "1268DCC6"Content-Length: 269Cache-Control: no-cache, no-store, must-revalidateExpires: -1X-Content-Type-Options: nosniffX-XSS-Protection: 1; mode=blockContent-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' data:;Referrer-Policy: no-referrer{"data": {"attributes": {"isRemote": false,"name": "Folder of new events"},"id": "38d270a9-6b40-4732-9942-5bdac9731d93","type": "eventRuleFolder"},"links": {"self": "/admin/v2/sites/6203305a-d7c6-499e-a59b-81500765f8f2/event-rule-folders/38d270a9-6b40-4732-9942-5bdac9731d93"}}

PATCH PowerShell Sample

Copy 
##Patch SITE EVENT RULE FOLDER settings

Write-Output "Site Folder PATCH"

Write-Output "-----"

$update =

'{

  "data": {

    "attributes": {

      "isRemote": false,

      "name": "Folder of newer events"

    },

    "type": "eventRuleFolder"

  }

}'

$update = $update | ConvertFrom-Json

$update = $update | ConvertTo-Json -Depth 10

$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/event-rule-folders/$folderID" -Method 'PATCH' -Headers $authHeader -Body $update

Write-Output $patchReturn | ConvertTo-Json

Method & URL

DELETE https://[server URL]:[port]/admin/v2/sites/{siteId}/event-rule-folders/{folderid}

DELETE Body Sample

Copy 
###

@folderID = {{foldersList.response.body.$.data[0].id}}

DELETE https://{{host}}/admin/v2/sites/{{Siteid}}/event-rule-folders/{{folderID}} HTTP/1.1

Authorization: EFTAdminAuthToken {{AuthToken}}

DELETE Response Body Sample

Copy 
HTTP/1.1 204 No ContentDate: Tue, 09 Aug 2022 18:12:00 GMTContent-Length: 0Cache-Control: no-cache, no-store, must-revalidateExpires: -1X-Content-Type-Options: nosniffX-XSS-Protection: 1; mode=blockContent-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval' data:;Referrer-Policy: no-referrer

DELETE PowerShell Sample

Copy 
$folderID = $folderList.data[1].id

$folderList = Invoke-RestMethod -Uri "$baseURL/v2/sites/$siteID/event-rule-folders/$folderID" -Method 'DELETE' -Headers $authHeader

Write-Output $folderList | ConvertTo-Json