|
Http Verb |
GET |
|---|---|
|
Url |
/documents/r1/files |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2025 W2 (FSM 20.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE |
Business Logic
This API returns a list of files filtered by the input criteria. Please note that when using the uuid as a filter, the API will retrieve all versions related to that uuid (unlike the GET /documents/r1/files/{fileUuid} API, which returns only the main version).
Query String Parameters
Filter ℹ️
|
Field |
Validations |
Note |
|---|---|---|
|
id |
|
Collection of ids |
|
version |
|
Collection of ids |
|
deleted |
|
|
|
active |
|
Collection of ids |
|
draft |
|
|
|
uuid |
Max length: 80 |
Collection of String |
|
name |
Max length: 200 |
Collection of String |
|
directoryUuid |
Max length: 4000 |
Collection of String |
|
uuidPath |
Max length: 4000 |
Collection of String |
|
creationDate |
|
|
|
creationDateCentral |
|
|
|
editDate |
|
|
|
editDateCentral |
|
|
|
authorId |
|
Collection of ids |
|
editorId |
|
Collection of ids |
|
typeId |
|
Collection of ids |
|
startValidityDate |
|
|
|
endValidityDate |
|
|
|
system |
|
|
|
originId |
|
Collection of ids |
|
physicalPath |
Max length: 1000 |
Collection of String |
|
fileExtension |
Max length: 10 |
Collection of String |
|
byteDimension |
|
|
|
originalName |
Max length: 4000 |
Collection of String |
Order ℹ️
Default Order
id (ASC)
Page ℹ️
Default.
Fields ℹ️
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Note |
|---|---|
|
id |
|
|
version |
|
|
deleted |
|
|
active |
|
|
draft |
|
|
uuid |
|
|
name |
|
|
directoryUuid |
|
|
uuidPath |
|
|
creationDate |
|
|
creationDateCentral |
|
|
editDate |
|
|
editDateCentral |
|
|
authorId |
|
|
editorId |
|
|
typeId |
|
|
startValidityDate |
|
|
endValidityDate |
|
|
system |
|
|
originId |
|
|
physicalPath |
|
|
fileExtension |
|
|
byteDimension |
|
|
originalName |
|