DeleteFolder

Delete an existing folder.

Purpose

Use this API to delete an existing folder.

Attention: As with all APIs that allow users to delete data, use DeleteFolder with extra care.

Used by

  • Case Builders with access to the specified case
  • Case Administrators with access to the specified case
  • Super Users

Parameters (required)

CaseID
The unique identifier of the case.
FolderName
The name of the folder to be deleted.

Responses

XML example (success)
<?xml version="1.0" encoding="UTF-8" ?>
<response>
   <status>0</status>
</response>
JSON example (success)
{"status": 0}

Sample

http://localhost:9080/EDMWorkMgrServer/api?CallName=DeleteFolder&Password=
password&User=administrator&FolderName=foldername&CaseID=CaseID