ExternalDocumentDto
A file from the external storage provider, enriched with metadata from our DB
when the file is tracked. Untracked files (uploaded outside Sodium) have null
for DB-sourced fields like Code, Category, ReviewStatus, etc.
Properties
| Name | Type | Description |
|---|---|---|
| externalFileId | string | The platform-specific file identifier |
The platform-specific file identifier | ||
| fileName | string | File name from the external platform |
File name from the external platform | ||
| fileSize | integer | File size in bytes |
File size in bytes | ||
| modifiedDate | string | Last modified date from the external platform |
Last modified date from the external platform | ||
| externalUrl | string | URL to open/download the file from the provider |
URL to open/download the file from the provider | ||
| isFolder | boolean | Whether this file is tracked in our system. When false, the fields below |
Whether this file is tracked in our system. When false, the fields below | ||
| isTracked | boolean | |
| code | string | Our internal document code (null for untracked files) |
Our internal document code (null for untracked files) | ||
| title | string | Document title (null for untracked files) |
Document title (null for untracked files) | ||
| summary | string | Document summary (null for untracked files) |
Document summary (null for untracked files) | ||
| date | string | Document date (null for untracked files) |
Document date (null for untracked files) | ||
| category | CodeAndNameDto | |
| reviewStatus | enum | Approved PendingReview Rejected |
Approved PendingReview Rejected | ||
| clientApprovalStatus | enum | None Pending Approved Rejected |
None Pending Approved Rejected | ||
| visibleInClientPortal | boolean | Whether this document is visible in the client portal (null for untracked files) |
Whether this document is visible in the client portal (null for untracked files) | ||
| uploadedByContact | CodeAndNameDto | |
| downloadUrl | string | Signed download URL via our streaming endpoint (null for untracked files) |
Signed download URL via our streaming endpoint (null for untracked files) | ||
| documentRequest | CodeAndNameDto | |
| createdDate | string | When the document was created in our system (null for untracked files) |
When the document was created in our system (null for untracked files) | ||
JSON Example
{
"externalFileId": "string",
"fileName": "string",
"fileSize": 0,
"modifiedDate": "2024-01-01T00:00:00Z",
"externalUrl": "string"
}