Get All Ancestor Topics
Overview
The Get All Ancestor Topics API retrieves the hierarchy from the root topic down to the given 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 a topic.A topic 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 that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used.
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"
The attributes of a topic to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' returns all attributes.
Default Attributes
These topic attributes are always returned:
| Name | Description |
|---|---|
| id | The ID of the topic. |
| name | The name of the topic. |
| articleCountInTopic | Number of articles in this topic. |
| articleCountInTopicTree | Number of articles in this topic and all sub-topics. |
| createdBy.id | The ID of the user that created the topic. |
| createdDate | The date when the topic was created. |
| departmentId | ID of the department for which this topic belongs to. |
| topicHomeArticleId | The ID of the article used as the home page of this topic. |
| modifiedBy.id | The ID of the user that last modified the topic. |
| modifiedDate | The date when the topic was last modified on. |
| childCount | Total number of children sub-topis below the current topic |
| subTopicIds | Array with the list of sub-topics |
| parentTopicId | ID of the parent topic. -1 if it is the root topic. |
One or more comma-separated names for custom attributes defined by the user to be returned.
^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$1 <= length <= 4000Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
int321 <= value <= 9991Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.
int321 <= value <= 7510Header 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"
The 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 numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9A 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/topics/PROD-1069/parents?topicAdditionalAttributes=modifiedBy.userName&%24customAdditionalAttributes=country_name" \ -H "Accept-Language: en-US" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176"{ "topic": [ { "name": "Checking and Savings Accounts", "articleCountInTopic": 0, "createdBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "createdDate": "2022-08-04T16:25:45Z", "departmentId": "1001", "modifiedBy": { "id": "1013", "firstName": "John", "middleName": "", "lastName": "Doe" }, "modifiedDate": "2022-09-04T16:25:45Z", "topicHomeArticleId": "", "parentTopicId": "-1", "childCount": 0, "subTopicsIds": [], "link": { "rel": "self", "href": "/knowledge/portalmgr/v3/portals/PROD-1000/topics/PROD-1066?%24lang=en-US" }, "id": "PROD-1066" } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 }}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.
Get All Topics GET
## Overview The Get All Topics API retrieves the topic tree for a portal. 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.

