Files
- 25 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Files
- Updated on 25 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
GET /files
Download a file using a document search query.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction.
|
| q | String | A VisualVault REST API Data Query. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
GET /files/{id}
Download a file by document ID.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The document id. |
POST /files
Upload a file revision from form data.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| checkIn | Bool | Check in status of the document. |
| checkInDocumentState* | String | Document status.
|
| revision* | String | Document revision number. |
| fileName | String | The name of the file. |
| changeReason* | String | Reason for the change. |
| indexFields | String | Index field names and values as a JSON array or object string. |
| parameters | {FileParameter} | Optional parameters. |
| fileId* | Guid | The ID of the file. |
| documentId* | Guid | The ID of the document. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
POST /files/file
Upload a file.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| allowNoFile | Bool | Allows a document to be created with no attached file (or a file containing 0 bytes). |
| checkIn | String | Check in status.
|
| checkInDocumentState | String | Document status.
|
| fileLength | String | Size of the file (in bytes). |
| fileName | String | The name of the file. |
| revision | String | Document revision number. |
| changeReason | String | Reason for the change. |
| fileId | Guid | The ID of the file. |
| documentId* | Guid | The ID of the document. |
| indexFields | {IndexField} | Index field names and values as a JSON array or object string. |
Response Codes
| Code | Description |
|---|---|
| 400 | Bad Request |
Was this article helpful?
