{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Articles
/api/knowledgebase/articles/{articleId}/resolved
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}/resolved
Returns safe category, location, editor, and ticket display information.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
articleId |
path | string |
yes | article identifier from the route |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
ResolvedDisplay |
resolved display information |
Example Request
# Request
GET /api/knowledgebase/articles/<articleId>/resolved HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
# Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"editor": {
"displayName": "string",
"id": "string"
},
"referenceTicket": {
"subject": "string",
"id": 0
},
"location": {
"displayName": "string",
"id": 0
},
"category": {
"displayName": "string",
"id": 0,
"key": "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.
ResolvedDisplay
| Property | Type | Required | Description |
|---|---|---|---|
editor |
EditorDisplay |
no | — |
referenceTicket |
TicketDisplay |
no | — |
location |
LocationDisplay |
no | — |
category |
CategoryDisplay |
no | — |
EditorDisplay
| Property | Type | Required | Description |
|---|---|---|---|
displayName |
string |
no | — |
id |
string |
no | — |
TicketDisplay
| Property | Type | Required | Description |
|---|---|---|---|
subject |
string |
no | — |
id |
integer (int32) |
no | — |
LocationDisplay
| Property | Type | Required | Description |
|---|---|---|---|
displayName |
string |
no | — |
id |
integer (int32) |
no | — |
CategoryDisplay
| Property | Type | Required | Description |
|---|---|---|---|
displayName |
string |
no | — |
id |
integer (int32) |
no | — |
key |
string |
no | — |
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |