| 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 |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SCADFiles:
# @ApiMember(Description="File path")
path: Optional[str] = None
"""
File path
"""
# @ApiMember(Description="Contents of a file. NOTE: This is not yet supported in the API")
text_contents: Optional[str] = None
"""
Contents of a file. NOTE: This is not yet supported in the API
"""
# @ApiMember(Description="Whether or not you want to download the file.")
for_download: bool = False
"""
Whether or not you want to download the file.
"""
# @ApiMember(Description="Where the files are hosted. If the source is not specified, your default source will be used")
source: Optional[str] = None
"""
Where the files are hosted. If the source is not specified, your default source will be used
"""
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
{}