Get Suggestion Attachment By Id

Overview

This API allows eGain users and authenticated customers to get details of one attachment that belongs to their own suggestion. If requested, one of the response attributes is the contentUrl, which can be used to download the content of the attachment. This only exists temporarily on the server. The client should immediately download the attachment content if needed. The attachment can be retrieved only once as it is deleted from the server after download.

For this API to execute successfully:

  • The suggestion with id or alternateId specified in the URL must belong to the user.
  • The setting "Manage Suggestion" must be enabled for the portal specified in the URL.
  • If the user is a customer, the setting “Allow customer access” must be enabled for the portal.
SecurityoAuthUser or oAuthCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
attachmentID
required
number

The ID of the attachment on which the operation is performed.

Example: 202200000001000
query Parameters
$attribute
string

It is used to request additional attributes/elements of resource representation

Enum: "all" "contentUrl"
Example: $attribute=contentUrl
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"
X-egain-tenant-id
string

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/suggestions/attachments/{attachmentID}
Request samples
Response samples
application/json
{
  • "attachment": [
    ]
}