DeleteFile

This api will delete entity from specific storage path.

DeleteFile Api options

The options available in this api are described below:

Option name	Type	Default Value	Required	Description
Path	string			The entity's path that are going to be deleted

Calling DeleteFile Api

For calling this api, the following details are required to apply:

note

The options and parameters introduced in the previous section must be included as json data in the request body part.

URL	Method	ContentType	Body
http://localhost:5860/storage/deletefile	DELETE	application/json	{ "path": <STRING VALUE> }

Now, if we want to have these details in the form of an http api call, open a new terminal and enter the following command:

info

First of all make sure flowsynx is running.

HTTP API (Bash)

curl -X POST -H "Content-Type: application/json" -d '{ "path": "/path/testfile.txt" }' http://localhost:5860/storage/deletefile

HTTP API (PowerShell)

Invoke-RestMethod -Method Post -ContentType 'application/json' -Body '{ "path": "C:/path/testfile.txt" }' -Uri 'http://localhost:5860/storage/deletefile'

Also you can use Http Api test clients to test this api. Anyway, after executing this api, a result like below will be obtained.

{
  "data": null,
  "messages": [
    "The file(s) were deleted successfully."
  ],
  "succeeded": true
}

The answer is divided into three data, messages, and succeeded parts. succeeded indicates the status of the execution of this api which is boolean value and can be true or false. messages also indicates the list of possible messages that are returned with the response. data contains the data to be returned.