Get Attachment by Id for an article version

Overview

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

Permissions

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

Preconditions:

  • Both article ID and version ID provided in path param must exist, and the versionID provided must be linked to the specified article ID.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

The Id of the article. Both numeric and alternate Id formats are supported for article Id.

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

The Id of the article version.

Example: 202200000002270
attachmentID
required
string

ID of the Attachment

Example: 202200000001234
query Parameters
$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}/versions/{versionID}/attachments/{attachmentID}
Request samples
Response samples
application/json
{
  • "attachment": [
    ]
}