Skip to main content

Interface: IDocument

Interface describing a document.

Extends​

Extended by​

Properties​

@context​

@context: ["https://schema.org", "https://schema.twindev.org/documents/", "https://schema.twindev.org/common/", ...IJsonLdContextDefinitionElement[]]

JSON-LD Context.

type​

type: "Document"

JSON-LD Type.

id​

id: string

The full id of the document.

documentRevision​

documentRevision: number

The revision of the document as a 0 based index.

blobStorageId​

blobStorageId: string

The blob storage id for the document.

integrity​

integrity: string

The integrity of the blob data.

attestationId?​

optional attestationId?: string

The attestation for the document if one was created.

dateCreated​

dateCreated: string

The date/time of when the document was created.

dateModified?​

optional dateModified?: string

The date/time of when the document was modified.

dateDeleted?​

optional dateDeleted?: string

The date/time of when the document was deleted, as we never actually remove items.

organizationIdentity?​

optional organizationIdentity?: string

The organization which added the document to the graph.

userIdentity?​

optional userIdentity?: string

The user who added the document to the graph.

documentId​

documentId: string

The id of the document.

Inherited from​

IDocumentBase.documentId

documentIdFormat?​

optional documentIdFormat?: string

The format of the document id.

Inherited from​

IDocumentBase.documentIdFormat

documentCode​

documentCode: UneceDocumentCodeList

The code for the document type.

Inherited from​

IDocumentBase.documentCode

annotationObject?​

optional annotationObject?: IJsonLdNodeObject

Additional annotation information for the document.

Inherited from​

IDocumentBase.annotationObject