Get Notes

Overview

This API allows user to retrieve all notes on existing article, suggestions and personal articles.

Permissions

  • User must have 'View' permission on article, suggestion.
  • User must be the reviewer of the current stage of the suggestion.
  • User must have 'View Folder' permission if notes are being retrieved for personal articles.
  • User must have 'View Knowledge Base' action assigned.

PreConditions

  • ID of the article, suggestion or personal article must be valid.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

The ID of the article for which the operation is performed. Both numeric and alternate ID formats are supported.

Examples:
A readable article ID.
PROD-2268
A numeric article ID.
202200000002268
query Parameters
$lang
required
string

The knowledge base language used for retrieving response. Must be a language enabled in the system.

Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"
Example: $lang=en-US
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Responses
200

Success

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/{ID}/notes
Request samples
Response samples
application/json
{
  • "note": [
    ]
}