Get Topics By ID

Overview

  • This API allows users to read one or more topics.
  • The user must have proper viewing permissions on each requested topic to ensure successful retrieval.
  • Retrieves details of one or more topics specified by ID in the URL. {ID} can be one or more topic IDs (comma separated in case of more than one).

Permissions

  • The user must have 'View' action on 'Topic' resource.
  • The user sending the request should be from the same or shared department as the topic.

Preconditions

  • All topic IDs provided in path must be from same department.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

The comma separated Ids of the topics on which operation is performed.

Examples:
202200000002268,202200000002269
query Parameters
$attribute
string

The attributes to be returned in the response.

Enum: "id" "name" "created" "description" "autogenerated" "language" "path" "isTranslatable" "imageUrl" "lastModified" "department" "parentTopic"
$lang
required
string

The knowledge base language used for retrieving response. Must be a language enabled in the system.

Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"
$pagenum
string

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

$pagesize
string

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

$level
integer

Levels of child topics to be returned :

  • -1: will return subtopics upto last level.
  • 0: no subtopics will be returned.
  • any positive number: sub-topics will be returned upto the given value.
Example: $level=2
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/topics/{ID}
Request samples
Response samples
application/json
{
  • "link": {
    },
  • "paginationInfo": {
    },
  • "topic": {
    },
  • "count": 1
}