Skip to main content

documents

Module: documents

Document records with versioning support.

NameTypeNullableDefault ValueNotes
PKID
integerDocument ID
fork
forks.ID
integerFork ID (`null` for base module)
owneruser
users.ID
integerOwner user ID (PUBLIC if `owneruser`=`null` and `ownergroup`=`null`)
ownergroup
groups.ID
integerOwner group ID (PUBLIC if `owneruser`=`null` and `ownergroup`=`null`)
creator
integerCreator user ID (defaults to authenticated user on creation)
assigneduser
users.ID
integerAssigned user ID
creationdate
bigintEXTRACT(epoch FROM now())Creation date and time as a Unix timestamp (defaults to current date and time on creation)
lastmodified
bigintEXTRACT(epoch FROM now())Last modification date and time as a Unix timestamp (auto-reset on modification)
binfile
binfiles.ID
integerBinary file ID; is read-only (not for `PUT` or `PATCH`)
visibility
smallint0Visibility (`0`=REGULAR, `1`=ARCHIVED, `2`=DELETED)
name
textName
documentnum
text''Document number
status
smallint0Status (`0`=DRAFT, `1`=FEEDBACKREQUIRED, `2`=INREVISION, `3`=AWAITINGAPPROVAL, `4`=FINAL, `5`=OBSOLETE)
filename
text''Filename
mimetype
text'application/octet-stream'MIME type (RFC 2045)
public
smallint0Publicly accessible
description
text''Detailed general description
NameUniqueNulls DistinctPrimaryPartialMethodKeys
fk_documents_assigneduserginassigneduser
fk_documents_binfilebtreebinfile
fk_documents_forkginfork
fk_documents_ownergroupginownergroup
fk_documents_owneruserginowneruser
i_documents_noforkginfork
i_documents_noownerginownergroup
pk_documentsbtreeID
s_documents_documentnumgindocumentnum
s_documents_filenameginfilename
s_documents_nameginname
NameType
c_documents_ownercheck
dc_documents_descriptioncheck
dc_documents_documentnumcheck
dc_documents_filenamecheck
dc_documents_namecheck
dc_documents_statuscheck
dc_documents_visibilitycheck
dc_files_mimetypecheck
fk_documents_assigneduserforeign_key
fk_documents_binfileforeign_key
fk_documents_forkforeign_key
fk_documents_ownergroupforeign_key
fk_documents_owneruserforeign_key
pk_documentsprimary_key
Loading...