digitaluapi

<back to all web services

SCADFiles

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/filesList contents of the root directory
POST/filesAdd 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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;

namespace digitaluapi.ServiceModel
{
    public partial class SCADFiles
    {
        ///<summary>
        ///File path
        ///</summary>
        [ApiMember(Description="File path")]
        public virtual string Path { get; set; }

        ///<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 virtual string TextContents { get; set; }

        ///<summary>
        ///Whether or not you want to download the file.
        ///</summary>
        [ApiMember(Description="Whether or not you want to download the file.")]
        public virtual bool ForDownload { get; set; }

        ///<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 virtual string Source { get; set; }
    }

}

C# SCADFiles DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Path":"String","TextContents":"String","ForDownload":false,"Source":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}