listVisibleFolderNodes
GET/visible-folder-nodes
Consultation service (B2B and BO): returns the flat, typed rows (VisibleFolderNode) that make up
the tree of the Contents > Documents and Resources consultation section. Categories and folders
live in the same collection and are told apart by attributes.nodeType. The channel comes from the
X-Marketplace header.
The service reflects the published configuration only: it always returns the data of the
published version, even when a folder has an open draft. The id of a row is therefore always
the id of the published category or folder. Folders are never hidden based on the selected
customer: they are always all visible.
The list is not paginated: all the rows matching the filters are returned. The only supported
sort is sequenceNum (default).
The generic search filter[s] searches the name of categories and folders in OR: when a folder
matches, its parent category is returned too, even if the category itself does not match.
filter[nodeType] and filter[categoryId] support the B2B mobile drawer: first the list of the
categories only, then the folders of the selected category.
To access the service you need at least one of the following permissions:
| Permission (one of) |
|---|
| listVisibleContents |
Request
Responses
- 200
- 400
List of VisibleFolderNodes.
Bad request.