Name | Type | Read-only | Mandatory | Comment |
|---|---|---|---|---|
| id | integer | yes | no | |
| subject | string | no | yes | |
| problem | string | no | yes | |
| resolution | string | no | yes | |
| date | date | |||
| private | boolean | no | no | |
| groupId | integer | no | yes | |
| timesViewed | integer | yes | no | |
| attachmentIds | array | array of Attachment.id |
Uri | Method | Request Data | Request Params | Success Response Code | Description |
|---|---|---|---|---|---|
| /api/knowledge-base-articles | GET | 200 | Returns an Array of all KnowledgeBaseArticles | ||
| /api/knowledge-base-articles/{id} | GET | 200 | Returns one KnowledgeBaseArticle | ||
| /api/knowledge-base-articles | POST | KnowledgeBaseArticle | 201 | Create new KnowledgeBaseArticle | |
| /api/knowledge-base-articles/{id} | PUT | KnowledgeBaseArticle | 204 | Update an existing KnowledgeBaseArticle | |
| /api/knowledge-base-articles/{id} | DELETE | 200 | Delete a KnowledgeBaseArticle | ||
| /api/knowledge-base-articles/search | GET | searchText | 200 | Returns an array of matching KnowledgeBaseArticles | |
| /api/knowledge-base-articles/{id}/attachments | GET | 200 | Returns an array of all Attachments for the KnowledgeBaseArticle | ||
| /api/knowledge-base-articles/{id}/attachments/{attachId} | GET | 200 | Returns one Attachment | ||
| /api/knowledge-base-articles/{id}/attachments | POST | Attachment | 201 | Create new Attachment for KnowledgeBaseArticle | |
| /api/knowledge-base-articles/{id}/attachments/{attachId} | DELETE | 200 | Deletes an Attachment |