GET Setup/File
Get systemFiles from criteria
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
SystemFileIDs |
Filter by SystemFileIDs |
Collection of integer |
None. |
FileTypeID |
Filter by FileTypeID |
integer |
None. |
BinaryID |
Filter by BinaryID |
integer |
None. |
Description |
Filter by Description |
string |
None. |
FileName |
Filter by FileName |
string |
None. |
FileExtension |
Filter by FileExtension |
string |
None. |
FileSize |
Filter by FileSize |
integer |
None. |
FileDateUtcMin |
Filter by FileDateUtcMin |
date |
None. |
FileDateUtcMax |
Filter by FileDateUtcMax |
date |
None. |
Props |
Filter by Props |
Collection of Object |
None. |
Comments |
Filter by Comments |
string |
None. |
CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
IncludePayload |
Filter by IncludePayload |
boolean |
None. |
IncludeSystemFileTypes |
Filter by IncludeSystemFileTypes |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of SystemFileDTOs
Collection of SystemFileDTOName | Description | Type | Additional information |
---|---|---|---|
SystemFileID |
Entity File ID |
integer |
None. |
SystemFileKey |
Entity File Key |
string |
None. |
FileTypeID |
File Type ID |
integer |
None. |
FileTypeName |
File Type Name |
string |
None. |
BinaryID |
Binary ID |
integer |
None. |
Description |
Description |
string |
None. |
FileName |
File Name |
string |
None. |
FileExtension |
File Extension |
string |
None. |
FileSize |
File Size |
integer |
None. |
FileDateUtc |
File Date Utc |
date |
None. |
Props |
Props |
Collection of Object |
None. |
Comments |
Comments |
string |
None. |
Data |
Base64 version of data |
string |
None. |
DataCompressionType |
Compression Type used on data |
CompressionType |
None. |
DataProps |
Props describing data |
Collection of Object |
None. |
RecordState |
Record State |
RecordState |
None. |
Created |
Created |
AuditDataDTO |
None. |
LastUpdated |
Last Updated |
AuditDataDTO |
None. |
Summary |
Summary |
string |
None. |