FileController
Base route: crm/files
| Namespace | Axiom.App.Crm.Api.Controllers.Files |
|---|---|
| Base Route | crm/files |
| Security | Required |
Endpoints
| Method | Route | Method Name | Parameters | Return Type |
|---|---|---|---|---|
| Get | crm/files/{fileId:int}/path |
GetPath | fileId: int | FilePathInfo |
| Get | crm/files/{fileId:int} |
Get | fileId: int | File |
| Get | crm/files/download/{id:int} |
DownloadFile | id: int | IActionResult |
| Post | crm/files/folder |
PostFolder | folder: File | File |
| Delete | crm/files/association/{fileAssociationId:int} |
Delete | fileAssociationId: int | bool |
| Delete | crm/files/version |
DeleteVersion | fileId: int | bool |
| Post | crm/files/association |
Post | newAssociation: FileAssociation | int |
| Patch | crm/files/{id:int} |
PatchFile | id: int, patch: JsonPatchDocument | File |
Detailed Endpoint Information
Get
crm/files/{fileId:int}/path
GetPath
Return Type
FilePathInfo
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
fileId |
int |
Query | No |
Get
crm/files/{fileId:int}
Get
Return Type
File
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
fileId |
int |
Query | No |
Get
crm/files/download/{id:int}
DownloadFile
Return Type
IActionResult
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
id |
int |
Query | No |
Post
crm/files/folder
PostFolder
Delete
crm/files/association/{fileAssociationId:int}
Delete
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
fileAssociationId |
int |
Query | No |
Delete
crm/files/version
DeleteVersion
Return Type
bool
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
fileId |
int |
Query | No |
Post
crm/files/association
Post
Return Type
int
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
newAssociation |
FileAssociation |
FromBody | No |
Patch
crm/files/{id:int}
PatchFile
Return Type
File
Parameters
| Name | Type | Source | Optional |
|---|---|---|---|
id |
int |
FromRoute | No |
patch |
JsonPatchDocument |
FromBody | No |