Get Article By Link Alias

Overview

  • This API allows a user to get the latest version of an article using its link alias.

Permissions

  • If the user has either the 'Edit Article' permission on the parent folder or the 'View Folder' permission, then the user will see the article details.
  • If the requested article is checked out by the same user, the user will see the checked-out version.
  • If the requested article is checked out by someone else, the the user will see the latest checked-in version.

Response attributes

  • If $attribute is not passed as a query parameter, then only the summary (default) attributes are returned in the response body.
  • If $attribute is passed as a query parameter, then the response body contains the summary attributes and any additional attributes that are requested.

The following are the summary (default) attributes:

Attribute Description
id The numerical ID of the article.
name The name of the article.
alternateId The readable (alternate) ID of the article.
SecurityoAuthUser
Request
path Parameters
aliasID
required
string[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-...

The link alias of the article.

Example: 52C0CC90-E314-4192-8D22-C6116CBD1ECE
query Parameters
departmentId
required
number [ 999 .. 999999999 ]

The ID of the department.

Example: departmentId=999
$attribute
string

These additional attributes are returned in the response if specified.

Enum: "lastModified" "created" "folder" "language" "articleState" "description" "content" "department" "articleType" "path" "personalization" "ownedBy" "availabilityDate" "availabilityDateTimeZone" "expirationDate" "expiryDateTimeZone" "link" "hasAttachments" "all" Examples:
$attribute=content
$attribute=all
$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" "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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/alias/{aliasID}
Request samples
Response samples
application/json
{
  • "article": {
    }
}