Add note

Overview

This API allows user to create a note on existing article, suggestions and personal articles.

Permissions

  • User must have 'Edit' permission on parent folder of article, suggestion or personal articles.
  • User must have 'Add Notes' action assigned.
  • User must be the reviewer of the current stage of the suggestion.

PreConditions

  • ID of the article, suggestion or personal article must be valid.
SecurityoAuthUser
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
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"
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
Request Body schema: application/json
Array of objects (Note)
Responses
201

Success. Note is added to article, suggestion, personal article.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

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

Required query parameter is missing

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}