Media Folder
APIs for the Contents > Documents and Resources feature.
A MediaFolderCategory is a first-level node bound to a single marketplace; a MediaFolder is a
folder of documents that is associated to one or more categories and holds one or more
MediaFolderContent groups. Each group carries the visibility rule (the user and, when the folder
targets customers, the customer audience resolved through PerimeterSets), its validity dates and
the linked files.
The lifecycle is managed on the folder as a whole following the API Draft mode convention: the draft covers the folder, its groups, their perimeters and the links to the files. Categories and groups have no processing status of their own. The folder-to-category associations are not part of the draft: they take effect immediately and always address the published folder id.
listMediaFolderNodes
Returns the flat, typed rows (`MediaFolderNode`) that make up the navigation tree of a marketplace:
listVisibleFolderNodes
Consultation service (B2B and BO): returns the flat, typed rows (`VisibleFolderNode`) that make up
createMediaFolderCategory
Creates a first-level `MediaFolderCategory` for a publication channel. The marketplace is mandatory
getMediaFolderCategory
Returns a single `MediaFolderCategory`: name, translations, icon, marketplace badge and the number
updateMediaFolderCategory
Updates the name and the translations of a `MediaFolderCategory`. The marketplace cannot be
deleteMediaFolderCategory
Deletes a `MediaFolderCategory`. The operation is allowed **only when the category has no
moveMediaFolderCategory
Moves a `MediaFolderCategory` within the categories of its marketplace, after a drag & drop in the
listEligibleMediaFolders
Returns the `MediaFolder`s of the organization that can be associated to the given category, to
addMediaFoldersToCategory
Associates one or more `MediaFolder`s to the category in a single call: it is the 'confirm' of the
removeMediaFolderCategoryAssociation
Removes the association between the folder and the category. Unlike the association, which is a
moveMediaFolder
Moves a `MediaFolder` within the folders of the given category, after a drag & drop in the
createMediaFolder
Creates a `MediaFolder`. The folder is born in `ProcessingStatus.Draft`: it is already
getMediaFolder
Returns a single `MediaFolder`. It accepts indifferently the id of the published folder or the id
updateMediaFolder
Updates the general data of a `MediaFolder`, saving each field as soon as it loses the focus. It is
deleteMediaFolder
Deletes a `MediaFolder`. The behaviour depends on the id that is passed, following the *API Draft
listMediaFolderRelatedCategory
Returns the `MediaFolderCategory`s the folder is associated to, to populate the 'associations'
listMediaFolderContents
Returns the `MediaFolderContent` groups of a folder. It populates the 'content groups' accordion of
createMediaFolderContent
Creates a `MediaFolderContent` group in the folder. The group gathers the files and carries the
listVisibleContents
Consultation service (B2B and BO): returns the files (`MediaContent`) of the content
publishMediaFolder
Publishes a draft `MediaFolder`, moving it from `ProcessingStatus.Draft` to
editMediaFolder
Opens the editing of a released `MediaFolder`: it creates the edit draft, or resumes the existing
getMediaFolderContent
Returns a single `MediaFolderContent`, with its validity dates, the number of linked files and the
updateMediaFolderContent
Updates the general data of a `MediaFolderContent`, saving each field as soon as it loses the
deleteMediaFolderContent
Deletes a `MediaFolderContent` together with its perimeters (only the ones still in draft) and the
upsertMediaFolderContentAudience
Creates or updates the user OR customer audience of a `MediaFolderContent` through its linked
widgetLatestVisibleContents
Feeds the **'YOUR RESOURCES'** widget of the B2B homepage: returns the most recent contents