Get folders By ID

Overview

This GET API service allows users to read one or more folders.

Permissions

  • 'View Folder' permission on each folder is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
ID
required
string

One folderID or Comma separated folder IDs

Example: 201500000002039
query Parameters
$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"
Example: $lang=en-US
$attribute
string

Attributes to be returned in response.

Enum: "created" "description" "department" "access" "owner" "translate" "acl" "all"
Example: $attribute=department
$level
integer

This specifies the depth of the level of folder hierarchy. Acceptable values are -1 (to fetch entire hierarchy) , 0 (to fetch only root level), any positive intger (to fetch details upto a level).

Example: $level=0
$sort
string

Attribute on which result list will be sorted.

Enum: "id" "name" "description" "createdBy" "lastModifiedBy" "createdOn" "lastModifiedTime"
Example: $sort=name
$order
string

Common query parameter $order.

Enum: "asc" "desc"
Example: $order=asc
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by 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"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/folders/{ID}
Request samples
Response samples
application/json
GET /knowledge/contentmgr/v3/folders/222200000005761?$attribute=all


{
  • "folder": [
    ]
}