Skip to main content

Interface: IAuditableItemGraphVertex

Interface describing an auditable item graph vertex.

Extends​

Properties​

dateCreated?​

optional dateCreated?: string

The date/time of when the element was created.

Inherited from​

IAuditableItemGraphAuditedElement.dateCreated

dateModified?​

optional dateModified?: string

The date/time of when the element was modified.

Inherited from​

IAuditableItemGraphAuditedElement.dateModified

dateDeleted?​

optional dateDeleted?: string

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

Inherited from​

IAuditableItemGraphAuditedElement.dateDeleted

@context​

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

JSON-LD Context.

id​

id: string

The id of the element.

Overrides​

IAuditableItemGraphAuditedElement.id

type​

type: "AuditableItemGraphVertex"

JSON-LD Type.

organizationIdentity?​

optional organizationIdentity?: string

The identity of the organization which controls the vertex.

auditMode?​

optional auditMode?: AuditableItemGraphAuditMode

How the mutations of the vertex are recorded, when absent the vertex behaves as audited. Once a vertex is set to bypass it can not be returned to audited.

annotationObject?​

optional annotationObject?: IJsonLdNodeObject

The JSON-LD annotation object for the vertex.

aliases?​

optional aliases?: IAuditableItemGraphAlias[]

Alternative aliases that can be used to identify the vertex.

resources?​

optional resources?: IAuditableItemGraphResource[]

The resources attached to the vertex.

edges?​

optional edges?: IAuditableItemGraphEdge[]

Edges connected to the vertex.

verified?​

optional verified?: boolean

Is the vertex verified, will only be populated when verification is requested. Always undefined when the vertex is in bypass mode.

version?​

optional version?: number

The version of the vertex, populated only when getting a specific version. Always undefined when the vertex is in bypass mode. Maps to https://schema.org/version.