| Requires any of the roles: | Client, Admin, Partner |
| GET | /files | List contents of the root directory | |
|---|---|---|---|
| POST | /files | Add file or create an empty folder to the root directory | |
| GET | /files/{Path*} | Get file metadata or list directory contents in a given path | |
| POST | /files/{Path*} | Add file or create an empty folder in a given path | |
| DELETE | /files/{Path*} | Delete file or folder in a given path |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Path | path | string | No | File path |
| TextContents | body | string | No | Contents of a file. NOTE: This is not yet supported in the API |
| ForDownload | body | bool | No | Whether or not you want to download the file. |
| Source | body | string | No | Where the files are hosted. If the source is not specified, your default source will be usedAllowable Values
|
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /files HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Path":"String","TextContents":"String","ForDownload":false,"Source":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{}