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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class SCADFiles
            '''<Summary>
            '''File path
            '''</Summary>
            <ApiMember(Description:="File path")>
            Public Overridable Property Path As String

            '''<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")>
            Public Overridable Property TextContents As String

            '''<Summary>
            '''Whether or not you want to download the file.
            '''</Summary>
            <ApiMember(Description:="Whether or not you want to download the file.")>
            Public Overridable Property ForDownload As Boolean

            '''<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")>
            Public Overridable Property Source As String
        End Class
    End Namespace
End Namespace

VB.NET 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/" />