Get Top Pinned Related Articles

Overview

API to get top pinned related articles.

Authentication

  • Authentication is required. The client must be logged in to call this API.

Permissions

  • User must have 'View Article' Permission to fetch pinned related article of an article.

Response

  • List of RelatedArticle. Should have id, name, isWebArticle, self link.
  • The order in response will be the actual order of pinned related articles.
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
Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/{ID}/related/pintotop
Request samples
Response samples
application/json
{
  • "pinnedRelatedArticle": [
    ]
}