Skip to main content
Version: Next

listMediaFolderNodes

GET 
/media-folder-nodes

Returns the flat, typed rows (MediaFolderNode) that make up the navigation tree of a marketplace: categories and folders live in the same collection and are told apart by attributes.nodeType. With the same signature the service covers three use cases:

  • the navigation tree of the left column, passing sort=sequenceNum;
  • the table of the folders associated to a category, passing filter[categoryId] and filter[nodeType]=eq:MediaFolder;
  • the category select of the "associate folder to" dialog, passing filter[nodeType] = eq:MediaFolderCategory and sort=sequenceNum.

The tree reflects the published configuration. 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[draftProcessingStatusId] acts on folders only; passing ProcessingStatus.Released excludes the folders that have an open draft, be it a creation or an edit.

To access the service you need at least one of the following permissions:

Permission (one of)
listMediaFolderNodes

Request​

Responses​

List of MediaFolderNodes.