MyApp

<back to all web services

QueryFileSystemItems

Files
QueryFileSystemItems Parameters:
NameParameterData TypeRequiredDescription
AppUserIdqueryint?No
FileAccessTypequeryFileAccessType?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
FileSystemItem Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FileAccessTypeformFileAccessType?No
FileformFileSystemFileYes
AppUserIdformstringYes
FileAccessType Enum:
Public
Team
Private
FileSystemFile Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FileNameformstringYes
FilePathformstringYes
ContentTypeformstringYes
ContentLengthformlongNo
FileSystemItemIdformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Todo>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Todo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TextformstringYes
IsFinishedformboolNo

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 /jsv/reply/QueryFileSystemItems HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	appUserId: 0,
	fileAccessType: Public,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			fileAccessType: Public,
			file: 
			{
				id: 0,
				fileName: String,
				filePath: String,
				contentType: String,
				contentLength: 0,
				fileSystemItemId: 0
			},
			appUserId: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}