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

**Files** Parameters:
Name	Parameter	Data Type	Required
Path	path	string	No
TextContents	query	string	No
ForDownload	query	bool	No

**FilesResponse** Parameters:
Name	Parameter	Data Type	Required
Directory	form	FolderResult	No
File	form	FileResult	No
ResponseStatus	form	ResponseStatus	No

**FolderResult** Parameters:
Name	Parameter	Data Type	Required	Description
Folders	form	List<Folder>	No
Files	form	List<File>	No

**Folder** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
ModifiedDate	form	DateTime	No
FileCount	form	int	No

**File** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Extension	form	string	No
FileSizeBytes	form	long	No
ModifiedDate	form	DateTime	No
IsTextFile	form	bool	No

**FileResult** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Extension	form	string	No
FileSizeBytes	form	long	No
ModifiedDate	form	DateTime	No
IsTextFile	form	bool	No
Contents	form	string	No

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