Domain Model
Knowledge Article
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| title | string | Yes | — | Title |
| topicTags | string[] | No | — | Topic tags |
| solutionFamily | string | No | — | Solution family |
| roleScope | string | No | — | Role scope |
| contentMarkdown | string | Yes | — | Content markdown |
| status | enum(draft, published, archived) | Yes | — | Status |
| sourceReferenceIds | string[] | No | — | Source reference ids |
| revisionNumber | integer | Yes | — | Revision number |
| ownerUserId | string | No | — | ID of the associated owner user |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| title | string | Yes | — | Title |
| topicTags | string[] | No | — | Topic tags |
| solutionFamily | string | No | — | Solution family |
| roleScope | string | No | — | Role scope |
| contentMarkdown | string | Yes | — | Content markdown |
| status | enum(draft, published, archived) | Yes | "draft" | Status |
| sourceReferenceIds | string[] | No | — | Source reference ids |
| revisionNumber | integer | Yes | 1 | Revision number |
| ownerUserId | string | No | — | ID of the associated owner user |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| title | string | No | — | Title |
| topicTags | string[] | No | — | Topic tags |
| solutionFamily | string | No | — | Solution family |
| roleScope | string | No | — | Role scope |
| contentMarkdown | string | No | — | Content markdown |
| status | enum(draft, published, archived) | No | — | Status |
| sourceReferenceIds | string[] | No | — | Source reference ids |
| revisionNumber | integer | No | — | Revision number |
| ownerUserId | string | No | — | ID of the associated owner user |