Interface TreeListParams

Filters for GET /api/v1/category/ and /api/v1/classification/ (taxonomy trees).

interface TreeListParams {
    ancestor?: Id;
    depth?: number;
    is_topic?: boolean;
    limit?: number;
    name?: string;
    offset?: number;
    parent?: Id;
    q?: string;
}

Hierarchy (View Summary)

Pagination
- TreeListParams

Index

Properties

ancestor? depth? is_topic? limit? name? offset? parent? q?

Properties

`Optional`ancestor

ancestor?: Id

`Optional`depth

depth?: number

`Optional`is_topic

is_topic?: boolean

`Optional`limit

limit?: number

Page size. The server caps this (see DEVELOPING.md); defaults server-side.

`Optional`name

name?: string

`Optional`offset

offset?: number

`Optional`parent

parent?: Id

`Optional`q

q?: string