{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Articles
/api/knowledgebase/articles/{articleId}/solution
Resource-oriented WebAPI for readable and editable knowledge base articles.
The endpoint deliberately stages writable values in memory. A commit re-reads the article and applies only the values supplied by the request so that PUT and PATCH preserve fields omitted by the client.
GET /api/knowledgebase/articles/{articleId}/solution
Returns solution HTML with attachment URLs adapted for the client.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
articleId |
path | string |
yes | article identifier from the route |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
solution HTML, or null |
Example Request
# Request GET /api/knowledgebase/articles/<articleId>/solution HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json "string"
PUT /api/knowledgebase/articles/{articleId}/solution
Stages a solution HTML change.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
articleId |
path | string |
yes | article identifier from the route |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
string |
yes | new solution HTML |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
string |
Successful response. |
Example Request
# Request PUT /api/knowledgebase/articles/<articleId>/solution HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json "string" # Response HTTP/1.1 200 OK Content-Type: application/json "string"
Common Error Responses
The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:
{
"status": 404,
"code": "route_not_found",
"message": "The requested API route does not exist.",
"details": []
}
Schemas
Request and response schemas used on this page.
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |