Files
Endpoints
StoredFilesApi
For storing files.
/api/StoredFilesApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
DELETE |
| storedFileId * |
|
|
GET |
| storedFileId * |
|
|
POST |
|
|
|
|
StoredFilesContentApi
For Retrieve stored file content only.
/api/StoredFilesContentApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
GET |
| storedFileId * |
|
|
UploadFileApi
For uploading files.
/api/UploadFileApi | ||||
---|---|---|---|---|
Operation | Logged in User | Parameters | Body | Response |
POST |
| fileName |
|
|
Models
Inline Model
Property | Data Type | Description |
---|---|---|
StoredFileId | Integer | Stored file id. |
StoredFilesApiKey
Property | Data Type | Description |
---|---|---|
StoredFileId | Integer | Stored file id. |
StoredFilesApiModel
Property | Data Type | Description |
---|---|---|
Key |
| |
RelatedRecord | String |
|
RelatedRecordId | String |
|
FileGroupId | Integer |
|
Details | String |
|
FileName | String |
|
Url | String |
|
ImageDocument | Boolean |
|
SecondaryPath | String |
|
KeyStr | String |
|
KeyDate | String |
|
KeyInt | Integer |
|
UploadedFileApiModel
Property | Data Type | Description |
---|---|---|
FileName | String | File name. |
FileExtension | String | File extension. |
ContentType | String |
|
RelatedRecordId | String | Related records. |
RelatedRecordType | String | Related records type. |
StoredFileId | Integer | Stored file id. |
Example
%Title
- 1 Endpoints
- 1.1 StoredFilesApi
- 1.2 StoredFilesContentApi
- 1.3 UploadFileApi
- 2 Models
- 3 Example
- 3.1 %Title