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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class SCADFiles
    {
        /**
        * File path
        */
        @ApiMember(Description="File path")
        public String Path = null;

        /**
        * 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 String TextContents = null;

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

        /**
        * 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 String Source = null;
        
        public String getPath() { return Path; }
        public SCADFiles setPath(String value) { this.Path = value; return this; }
        public String getTextContents() { return TextContents; }
        public SCADFiles setTextContents(String value) { this.TextContents = value; return this; }
        public Boolean isForDownload() { return ForDownload; }
        public SCADFiles setForDownload(Boolean value) { this.ForDownload = value; return this; }
        public String getSource() { return Source; }
        public SCADFiles setSource(String value) { this.Source = value; return this; }
    }

}

Java 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/" />