| All Verbs | /files | ||
|---|---|---|---|
| All Verbs | /files/{Path*} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Path | path | string | No | |
| TextContents | query | string | No | |
| ForDownload | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Directory | form | FolderResult | No | |
| File | form | FileResult | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Folders | form | List<Folder> | No | |
| Files | form | List<File> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| ModifiedDate | form | DateTime | No | |
| FileCount | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Extension | form | string | No | |
| FileSizeBytes | form | long | No | |
| ModifiedDate | form | DateTime | No | |
| IsTextFile | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /files HTTP/1.1
Host: restfiles.netcore.io
Accept: text/csv
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"}}}