Get sub folders

Overview

This API allows user to get the sub folders of parent folder or department.

Permissions

  • User must have view folder permission on the folder or department passed in request.

Query Parameters

Either parent folder id or department Id must be passed as query parameter.

SecurityoAuthUser or oAuthClient
Request
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
filter[parent]
number

Parent folder for which sub folders are requested.

Example: filter[parent]=40960000000096
fetchChildrenCount
string

Single value is allowed i.e "yes".If this parameter is present, the API will return the count of child folders for every sub folder. Only one value allowed i.e. 'yes'

Example: fetchChildrenCount=yes
$attribute
string

Attributes to be returned in response.

Enum: "created" "description" "department" "access" "owner" "translate" "acl" "all"
Example: $attribute=department
departmentId
number [ 999 .. 999999999 ]

The ID of the department

Example: departmentId=999
$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: 25

$order
string

Common query parameter $order.

Enum: "asc" "desc"
Example: $order=asc
$sort
string

Attribute on which result list will be sorted.

Enum: "id" "name" "description" "createdBy" "lastModifiedBy" "createdOn" "lastModifiedTime"
Example: $sort=name
filter[name]
string

Attribute to filter the result based on name.

Example: filter[name]=folder1
filter[description]
string

Attribute to filter the result based on description.

Example: filter[description]=This is folder
filter[createdBy]
string

Attribute to filter the result based on created by user/system.

Example: filter[createdBy]=user
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

204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/folders
Request samples
Response samples
application/json
{
  • "link": {
    },
  • "paginationInfo": {
    },
  • "folder": [
    ],
  • "count": 2
}