Files
Overview
Provides access to Stored Files related data.
Endpoints
The resources available in this module.
StoredFilesApi
Provides API access to Stored File records.
/api/StoredFilesApi | ||||
|---|---|---|---|---|
Operation | Performed As | Request Query | Request Body | Response |
GET | Logged in User | - | ||
POST | Logged in User | - | ||
DELETE | Logged in User | - | ||
StoredFilesContentApi
Provides API access to the contents of Stored Files.
/api/StoredFilesContentApi | ||||
|---|---|---|---|---|
Operation | Performed As | Request Query | Request Body | Response |
GET | Logged in User | - | ||
UploadFileApi
For uploading files.
/api/UploadFileApi | ||||
|---|---|---|---|---|
Operation | Performed As | Request Query | Request Body | Response |
POST Upload a file to create a Stored File record. | Logged in User | - | ||
Models
The definitions of models specific to endpoints in this module.
StoredFileKey
Property | Data Type | Length | Description |
|---|---|---|---|
StoredFileId | Integer |
| The Unique ID of the Stored File. |
StoredFilesApiModel
Property | Data Type | Length | Description |
|---|---|---|---|
Key |
| The unique key for the Stored File. | |
RelatedRecord | String | 255 | The Related Record Type of the Stored File. |
RelatedRecordId | String | 50 | The Related Record ID of the Stored File. |
FileGroupId | Integer | 50 | The ID of the File Group the Stored File belongs to. |
Details | String | 2000 | The Details text on the Stored File. |
SecondaryPath | String | 2000 | The secondary path of the Stored File. |
ImageDocument | Boolean |
| A flag to indicate if the File comes from Xtracta. |
FileHttpResponse
This is a non-JSON HTTP response. The HTTP body is the file contents as an array of bytes. The HTTP Headers include the following:
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=[file name]; size=[file size]
UploadFileKey
Property | Data Type | Description |
|---|---|---|
FileName | String | The name of the Uploaded File. |
RelatedRecordId | String | The Related Record ID of the Uploaded File |
RelatedRecordType | String | The Related Record Type of the Uploaded File. |
UploadFileApiModel
Property | Data Type | Length | Description |
|---|---|---|---|
FileName | String | 255 | The name of the Uploaded File. |
FileExtension | String | 260 | The extension of the Uploaded File. |
ContentType | String |
| The HTTP Content-Type Header |
RelatedRecordId | String | 50 | The Related Record ID of the Uploaded File |
RelatedRecordType | String | 255 | The Related Record Type of the Uploaded File. |
StoredFileId | Integer |
| The unique ID of the Stored File. |
On this page
- 1 Overview
- 2 Endpoints
- 2.1 StoredFilesApi
- 2.2 StoredFilesContentApi
- 2.3 UploadFileApi
- 3 Models
- 3.1 StoredFileKey
- 3.2 StoredFilesApiModel
- 3.3 FileHttpResponse
- 3.4 UploadFileKey
- 3.5 UploadFileApiModel