Get All Topics

Overview

The Get All Topics API retrieves the topic tree for a portal. The $level attribute determines how deep the topic hierarchy should go, or how many child topics of a topic are returned in the response.

SecurityoAuthUser or oAuthOnBehalfOfUser or oAuthCustomer or oAuthOnBehalfOfCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

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.

Example: PROD-1000
query Parameters
level
integer <int64> [ -1 .. 20 ]

Depth of the topic hierarchy to be returned in the response.

Examples:
All levels are returned
level=-1
Only parent topic is returned
level=0
Parent and immediate children topics are returned
level=1
Immediate children and grand children are returned
level=2
$lang
string

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.

    • Enum: "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" "sr-RS" "xx-XX"
    Example: $lang=en-US
    topicAdditionalAttributes
    Array of strings

    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.
    Items Enum: "description" "createdBy.userName" "createdBy.firstName" "createdBy.lastName" "createdBy.middleName" "modifiedBy.userName" "modifiedBy.firstName" "modifiedBy.lastName" "modifiedBy.middleName" "imageUrl" "textMetaData" "all" Examples:
    An additional attribute to be returned.
    topicAdditionalAttributes=modifiedBy.userName
    Additional attributes to be returned.
    topicAdditionalAttributes=description,imageUrl
    All additional attributes to be returned.
    topicAdditionalAttributes=all
    $customAdditionalAttributes
    string [ 1 .. 4000 ] characters ^([a-zA-Z0-9_-]+)(?:,[a-zA-Z0-9_-]+)*$

    One or more comma-separated names for custom attributes defined by the user to be returned.

    Examples:
    A user-defined custom attribute.
    $customAdditionalAttributes=country_name
    Multiple user-defined custom attributes.
    $customAdditionalAttributes=internalScore,performance-rating_dept_923
    $pagenum
    integer <int32> [ 1 .. 999 ]
    Default: 1

    Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

    $pagesize
    integer <int32> [ 1 .. 75 ]
    Default: 10

    Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

    header Parameters
    Accept-Language
    required
    string

    The Language locale accepted by the 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"
    Example: en-US
    x-ext-integration-id
    string <= 40 characters ^[\w\W]+$

    The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

    Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    x-egain-activity-id
    string [ 4 .. 9 ] characters ^[0-9]{4,9}$

    A unique numeric interaction identifier from eGain.

    Example: 59237
    x-ext-interaction-id
    string <= 40 characters ^[\w\W]+$

    A unique interaction identifier from other CRM applications.

    Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

    Examples:
    3155180e-0c13-43e9-9c38-e9045bcbf176
    00Dbn00000IxGnx
    Responses
    200

    Success

    204

    No Content

    400

    Bad Request

    401

    Unauthorized

    403

    Forbidden

    404

    Not Found

    406

    Not acceptable

    500

    Internal server error

    get/portals/{portalID}/topics
    Request samples
    Response samples
    application/json
    {
    • "topicTree": [
      ]
    }