Get Topic Breadcrumb for Article
Overview
- Use this API to retrieve the topic breadcrumb for an article in a portal. A breadcrumb shows the hierarchical path from the root topic to the article's primary topic.
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 Article.An Article 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 language used for fetching the details of a resource. Resources available in different languages may differ from each other.
Value in
- "en-US"
- "fr-FR"
- "en-GB"
- "es-ES"
- "it-IT"
- "nl-NL"
- "da-DA"
- "sv-SE"
- "pt-PT"
- "fi-FI"
- "no-NB"
- "no-NN"
- "ja-JA"
- "de-DE"
- "pt-BR"
- "zh-CN"
- "zh-TW"
- "ko-KO"
- "ru-RU"
- "el-EL"
- "tr-TR"
- "pl-PL"
- "cs-CS"
- "sk-SK"
- "hu-HU"
- "sr-SR"
- "ar-SA"
- "hr-HR"
- "ro-RO"
- "th-TH"
- "de-AT"
- "vi-VN"
- "id-ID"
- "ms-MY"
- "fil-PH"
- "fr-CA"
- "hi-IN"
- "uk-UA"
- "bg-BG"
- "sl-SI"
- "xx-XX"
Header Parameters
The 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"
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 <= 40Response 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/articles/PROD-2996/breadcrumb?%24lang=en-US" \ -H "Accept-Language: en-US" \ -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"{ "topicBreadcrumb": [ { "topicSummary": [ { "id": "PROD-1001", "name": "Digital Banking", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1001" } }, { "id": "PROD-1072", "name": "Electronic Payments", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1072" } }, { "id": "PROD-1075", "name": "Transfer Funds", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1075" } } ] }, { "topicSummary": [ { "id": "PROD-1066", "name": "Checking and Savings Accounts", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1066" } }, { "id": "PROD-1075", "name": "Transfer Funds", "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/topics/PROD-1075" } } ] } ]}Get Article Personalization Details GET
## Overview The Get Article Personalization Details API allows agents to retrieve the personalization tag details of an Article.
Get Immediate Child Topics GET
## Overview The Get Immediate Child Topics API retrieves details about a topic and it's immediate child topics. The <code>$level</code> attribute determines how deep the topic hierarchy should go, or how many child topics of a topic are returned in the response.

