Get Attachment by Id for an article

Overview

  • This API retrieves the requested attachment Id for for an article in given language.
  • User must have the required permissions to fetch attachments on the given article.

Permissions

  • User is allowed to view the attachments, only if they are allowed to view the article specified in the request.

Preconditions:

  • Both articleID and $lang must exist and the combination must be valid as well (the article must exist in that language).
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

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

Examples:
Providing readable article id.
PROD-2268
Providing numeric article id.
202200000002268
attachmentID
required
string

ID of the Attachment

Example: 202200000001234
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
$attribute
string

The attributes to be returned in the response.

Enum: "id" "name" "created" "contentUrl" "all"
Example: $attribute=all
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

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/articles/{ID}/attachments/{attachmentID}
Request samples
Response samples
application/json
{
  • "attachment": [
    ]
}