Get Articles By Ids

Overview

  • This GET API service allows users to read one or more articles.
  • The user must have proper viewing permissions for each requested article to ensure successful retrieval.
  • This API returns latest published and available version for the articles and approved article suggestions.
  • This API returns latest and the only existing version for personal articles and article suggestions that have not been approved.

Permissions

  • Articles in folders (personal or shared): 'View folder' permission is required.
  • Articles in approval process (new, pending feedback, and rejected): User who is retrieving should be the suggester, or Use has 'View Folder' permission on the folder and 'View Knowledge Base' action.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

The comma separated Ids of the articles on which operation is performed. Both numeric and alternate Ids formats are supported for article Id.

Examples:
Providing readable article ids.
PROD-2268,PROD-2269
Providing numeric article ids.
202200000002268,202200000002269
query Parameters
$lang
string

The knowledge base language used for retrieving the response. This must be a language that is made available to the user. If this parameter is not passed, then the default language of the system is used.

Enum: "en-US" "en-GB" "fr-FR" "fi-FI" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DA" "ru-RU" "zh-CN" "sv-SE" "no-NB" "no-NN" "zh-TW" "tr-TR" "pl-PL" "cs-CS" "hu-HU" "ar-SA" "ro-RO" "ja-JA" "ko-KO" "el-EL" "xx-XX"
Example: $lang=en-US
expandMacros
string

This is an optional query parameter. Allowed values are 'yes' or 'no'. If 'expandMacros=yes', then it will expand all the macros in the result.

Enum: "no" "yes"
Example: expandMacros=no
$attribute
string

article attributes to be returned. comma separated input

Enum: "id" "lastModified" "created" "suggestionState" "folder" "lock" "language" "attachments" "name" "versionNumber" "articleState" "availabilityDate" "expirationDate" "description" "keywords" "summary" "additionalInfo" "content" "label" "imageUrl" "translationStatus" "department" "articleType" "notes" "relatedQuestions" "macro" "linkAlias" "availableEditions" "path" "personalization" "classification" "suggestionResolutionCode" "currentReviewStage" "previousReviewStage" "currentWorkflow" "ownedBy" "lockedBy" "expiryDateTimeZone" "availabilityDateTimeZone" "returnArticleStateInfo" "all"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/{ID}
Request samples
Response samples
application/json
GET Article


{
  • "link": {
    },
  • "paginationInfo": {
    },
  • "article": [
    ],
  • "count": 1
}