tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ListsService > getTaxonomy

ListsService.getTaxonomy() method

Gets a full taxonomy for a specified Category. This operation returns an instance of ‘TaxonomyNode’ type.

Signature:

static getTaxonomy({ escapedCategoryId, includeAlternativeLabels, maxNodes, }: {
        escapedCategoryId: string;
        includeAlternativeLabels?: boolean;
        maxNodes?: number;
    }): CancelablePromise<TaxonomyNode>;

Parameters

Parameter	Type	Description
{ escapedCategoryId, includeAlternativeLabels, maxNodes, }	{ escapedCategoryId: string; includeAlternativeLabels?: boolean; maxNodes?: number; }

Returns:

CancelablePromise<TaxonomyNode>

TaxonomyNode The request was successful.

Exceptions

ApiError