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

import 'package:servicestack/servicestack.dart';

class SCADFiles implements IConvertible
{
    /**
    * File path
    */
    // @ApiMember(Description="File path")
    String? Path;

    /**
    * 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")
    String? TextContents;

    /**
    * Whether or not you want to download the file.
    */
    // @ApiMember(Description="Whether or not you want to download the file.")
    bool? ForDownload;

    /**
    * 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")
    String? Source;

    SCADFiles({this.Path,this.TextContents,this.ForDownload,this.Source});
    SCADFiles.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Path = json['Path'];
        TextContents = json['TextContents'];
        ForDownload = json['ForDownload'];
        Source = json['Source'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Path': Path,
        'TextContents': TextContents,
        'ForDownload': ForDownload,
        'Source': Source
    };

    getTypeName() => "SCADFiles";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'SCADFiles': TypeInfo(TypeOf.Class, create:() => SCADFiles()),
});

Dart SCADFiles DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<SCADFiles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ForDownload>false</ForDownload>
  <Path>String</Path>
  <Source>String</Source>
  <TextContents>String</TextContents>
</SCADFiles>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />