| 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 |
namespace digitaluapi.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SCADFiles() =
///<summary>
///File path
///</summary>
[<ApiMember(Description="File path")>]
member val Path:String = null with get,set
///<summary>
///Contents of a file. NOTE: This is not yet supported in the API
///</summary>
[<ApiMember(Description="Contents of a file. NOTE: This is not yet supported in the API")>]
member val TextContents:String = null with get,set
///<summary>
///Whether or not you want to download the file.
///</summary>
[<ApiMember(Description="Whether or not you want to download the file.")>]
member val ForDownload:Boolean = new Boolean() with get,set
///<summary>
///Where the files are hosted. If the source is not specified, your default source will be used
///</summary>
[<ApiMember(Description="Where the files are hosted. If the source is not specified, your default source will be used")>]
member val Source:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Path":"String","TextContents":"String","ForDownload":false,"Source":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{}