digitaluapi

Files

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
All Verbs	/restfiles/files
All Verbs	/restfiles/files/{Path*}


export class Files
{
    public Path: string;
    public TextContents: string;
    public ForDownload: boolean;

    public constructor(init?: Partial<Files>) { (Object as any).assign(this, init); }
}

export class Folder
{
    public Name: string;
    public ModifiedDate: string;
    public FileCount: number;

    public constructor(init?: Partial<Folder>) { (Object as any).assign(this, init); }
}

export class File
{
    public Name: string;
    public Extension: string;
    public FileSizeBytes: number;
    public ModifiedDate: string;
    public IsTextFile: boolean;

    public constructor(init?: Partial<File>) { (Object as any).assign(this, init); }
}

export class FolderResult
{
    public Folders: Folder[];
    public Files: File[];

    public constructor(init?: Partial<FolderResult>) { (Object as any).assign(this, init); }
}

export class FileResult
{
    public Name: string;
    public Extension: string;
    public FileSizeBytes: number;
    public ModifiedDate: string;
    public IsTextFile: boolean;
    public Contents: string;

    public constructor(init?: Partial<FileResult>) { (Object as any).assign(this, init); }
}

export class FilesResponse
{
    public Directory: FolderResult;
    public File: FileResult;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<FilesResponse>) { (Object as any).assign(this, init); }
}

TypeScript Files DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /restfiles/files HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Path":"String","TextContents":"String","ForDownload":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Directory":{"Folders":[{"Name":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","FileCount":0}],"Files":[{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"0001-01-01T00:00:00.0000000","IsTextFile":false}]},"File":{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"0001-01-01T00:00:00.0000000","IsTextFile":false,"Contents":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}