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*}

"use strict";
export class Files {
    /** @param {{Path?:string,TextContents?:string,ForDownload?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Path;
    /** @type {string} */
    TextContents;
    /** @type {boolean} */
    ForDownload;
}
export class Folder {
    /** @param {{Name?:string,ModifiedDate?:string,FileCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    ModifiedDate;
    /** @type {number} */
    FileCount;
}
export class File {
    /** @param {{Name?:string,Extension?:string,FileSizeBytes?:number,ModifiedDate?:string,IsTextFile?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Extension;
    /** @type {number} */
    FileSizeBytes;
    /** @type {string} */
    ModifiedDate;
    /** @type {boolean} */
    IsTextFile;
}
export class FolderResult {
    /** @param {{Folders?:Folder[],Files?:File[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Folder[]} */
    Folders;
    /** @type {File[]} */
    Files;
}
export class FileResult {
    /** @param {{Name?:string,Extension?:string,FileSizeBytes?:number,ModifiedDate?:string,IsTextFile?:boolean,Contents?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Extension;
    /** @type {number} */
    FileSizeBytes;
    /** @type {string} */
    ModifiedDate;
    /** @type {boolean} */
    IsTextFile;
    /** @type {string} */
    Contents;
}
export class FilesResponse {
    /** @param {{Directory?:FolderResult,File?:FileResult,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FolderResult} */
    Directory;
    /** @type {FileResult} */
    File;
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript Files DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	Path: String,
	TextContents: String,
	ForDownload: False
}

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

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