digitaluapi

SCADFiles

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
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


export class SCADFiles
{
    /** @description File path */
    // @ApiMember(Description="File path")
    public Path: string;

    /** @description Contents of a file. NOTE: This is not yet supported in the API */
    // @ApiMember(Description="Contents of a file. NOTE: This is not yet supported in the API")
    public TextContents: string;

    /** @description Whether or not you want to download the file. */
    // @ApiMember(Description="Whether or not you want to download the file.")
    public ForDownload: boolean;

    /** @description Where the files are hosted. If the source is not specified, your default source will be used */
    // @ApiMember(Description="Where the files are hosted. If the source is not specified, your default source will be used")
    public Source: string;

    public constructor(init?: Partial<SCADFiles>) { (Object as any).assign(this, init); }
}

TypeScript SCADFiles DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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

{}