REST Files

<back to all web services

Files

GET the File or Directory info at {Path}
POST multipart/formdata to upload a new file to any {Path} in the /ReadWrite folder
PUT {TextContents} to replace the contents of a text file in the /ReadWrite folder

The following routes are available for this service:
All Verbs/files
All Verbs/files/{Path*}
Files Parameters:
NameParameterData TypeRequiredDescription
PathpathstringNo
TextContentsquerystringNo
ForDownloadqueryboolNo
FilesResponse Parameters:
NameParameterData TypeRequiredDescription
DirectoryformFolderResultNo
FileformFileResultNo
ResponseStatusformResponseStatusNo
FolderResult Parameters:
NameParameterData TypeRequiredDescription
FoldersformList<Folder>No
FilesformList<File>No
Folder Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ModifiedDateformDateTimeNo
FileCountformintNo
File Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ExtensionformstringNo
FileSizeBytesformlongNo
ModifiedDateformDateTimeNo
IsTextFileformboolNo
FileResult Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ExtensionformstringNo
FileSizeBytesformlongNo
ModifiedDateformDateTimeNo
IsTextFileformboolNo
ContentsformstringNo

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 /csv/reply/Files HTTP/1.1 
Host: restfiles.servicestack.net 
Content-Type: text/csv
Content-Length: length

{"Path":"String","TextContents":"String","ForDownload":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Directory":{"Folders":[{"Name":"String","ModifiedDate":"\/Date(-62135596800000-0000)\/","FileCount":0}],"Files":[{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"\/Date(-62135596800000-0000)\/","IsTextFile":false}]},"File":{"Name":"String","Extension":"String","FileSizeBytes":0,"ModifiedDate":"\/Date(-62135596800000-0000)\/","IsTextFile":false,"Contents":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}