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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SCADFiles implements JsonSerializable
{
    public function __construct(
        /** @description File path */
        // @ApiMember(Description="File path")
        /** @var string|null */
        public ?string $Path=null,

        /** @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")
        /** @var string|null */
        public ?string $TextContents=null,

        /** @description Whether or not you want to download the file. */
        // @ApiMember(Description="Whether or not you want to download the file.")
        /** @var bool|null */
        public ?bool $ForDownload=null,

        /** @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")
        /** @var string|null */
        public ?string $Source=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Path'])) $this->Path = $o['Path'];
        if (isset($o['TextContents'])) $this->TextContents = $o['TextContents'];
        if (isset($o['ForDownload'])) $this->ForDownload = $o['ForDownload'];
        if (isset($o['Source'])) $this->Source = $o['Source'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Path)) $o['Path'] = $this->Path;
        if (isset($this->TextContents)) $o['TextContents'] = $this->TextContents;
        if (isset($this->ForDownload)) $o['ForDownload'] = $this->ForDownload;
        if (isset($this->Source)) $o['Source'] = $this->Source;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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

{}