Get Suggestion Attachment by ID
Overview
The Get Suggestion Attachment by ID API allows authenticated users to get the details of an attachment that belongs to their own Suggestion. It also allows the download of attachment content.
Prerequisites
- Enable the setting "My Suggestions" for the portal specified in the URL
- If the user is a customer, enable the setting "Allow Customer Access" for the portal.
- The Suggestion specified in the URL must belong to the user.
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20The ID of the attachment.An attachment ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Query Parameters
The attributes of an attachment to be returned, along with the default attachment details.
| Attribute | Description |
|---|---|
| id | Unique identifier for the attachment |
| fileName | Name of the file |
| contentType | Content type of the file |
| size | Size of the file in bytes |
| link | Link to the attachment |
Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
^[\w\W]+$length <= 40A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
^[\w\W]+$length <= 40The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "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"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/suggestions/attachments/PROD-1000?attachmentAdditionalAttributes=contentUrl" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "Accept-Language: en-US"{ "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/suggestions/attachments/PROD-1001" }, "fileName": "eightbank.png", "size": 45152, "id": "PROD-1001"}Get Suggestion Attachments GET
## Overview The Get Suggestion Attachments API allows authenticated users to retrieve attachments for a Suggestion. ## Prerequisites * Enable the setting "My Suggestions" for the portal specified in the URL * If the user is a customer, enable the setting "Allow Customer Access" for the portal. * The Suggestion specified in the URL must belong to the user.
Get User Milestones GET
## Overview The User Milestones API provides information about the milestones of an agent within the article workflow. This API helps track the progress of articles by grouping them into relevant milestones based on their current stage. For example, an article might go through Knowledge Workflow Stages like Draft, Initial Review, Staging, Final Review and Publish. Articles in the Draft and Initial Review stages are part of the "authoring milestone", while articles in the Staging and Final Review stages are part of the "staging milestone".

