ZRM Docs
Domain Model

Knowledge Article

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
titlestringYesTitle
topicTagsstring[]NoTopic tags
solutionFamilystringNoSolution family
roleScopestringNoRole scope
contentMarkdownstringYesContent markdown
statusenum(draft, published, archived)YesStatus
sourceReferenceIdsstring[]NoSource reference ids
revisionNumberintegerYesRevision number
ownerUserIdstringNoID of the associated owner user
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
titlestringYesTitle
topicTagsstring[]NoTopic tags
solutionFamilystringNoSolution family
roleScopestringNoRole scope
contentMarkdownstringYesContent markdown
statusenum(draft, published, archived)Yes"draft"Status
sourceReferenceIdsstring[]NoSource reference ids
revisionNumberintegerYes1Revision number
ownerUserIdstringNoID of the associated owner user
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
titlestringNoTitle
topicTagsstring[]NoTopic tags
solutionFamilystringNoSolution family
roleScopestringNoRole scope
contentMarkdownstringNoContent markdown
statusenum(draft, published, archived)No"draft"Status
sourceReferenceIdsstring[]NoSource reference ids
revisionNumberintegerNo1Revision number
ownerUserIdstringNoID of the associated owner user

On this page