[HTTP DELETE] ~/files?filePath={filePath}&download={download}
Description: Deletes the file as specified by the filePath parameter.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| filePath |
The relative path (including filename) to the file in the FTP folder |
string |
Required |
| download |
Optional flag - when set to 'true' will attach the file to the response before deletion |
boolean |
Default value is False |
Body Parameters
None
Response Information
Description
Successful Response - OK (200):
If the download parameter is set to 'true', return the contents of the file
Response Content : HttpResponseMessage
| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |
Response Codes:
-
200 - OK
- The File was deleted successfully.
-
401 - Unauthorized
- Request has been denied as it lacks valid Authentication credentials.
-
403 - Forbidden
- The user is missing required FileDelete permission.
-
404 - NotFound
- The specified file was not found.
-
500 - InternalServerError
- An error occurred while processing this request.