Médiathèque

Arborescence

Liste les dossiers racines GET
/v1/sites/{code_site}/media/folders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
recursiveExtrait toute l'arborescence

Format de sortie :

data:[
    {
        "folder_id": "integer",
        "name": "string",
        "parent_folder_id": "integer",
        "is_bookmarked": "boolean",
        "has_restrictions": "boolean",
        "restrictions": "List",
        "folder_key": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer"
    }
]
NomTypeDescription
folder_idintegerIdentifiant du dossier
namestringIntitulé du dossier
parent_folder_idintegerIdentifiant du dossier parent
is_bookmarkedbooleanDossier en favoris
has_restrictionsbooleanDossier en accès restreint
restrictionsFacultatifListAccès extranet
folder_keyFacultatifstringClé API du dossier
creation_dateFacultatifstringDate de création
creation_date_fFacultatifstringDate de création formatée
creation_date_timestampFacultatifintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
Ajoute un dossier POST
/v1/sites/{code_site}/media/folders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
parent_folder_idObligatoireintegerIdentifiant du dossier parent
namestringNom du dossier
is_bookmarkedbooleanDossier en favoris

Format de sortie :

data:[]
NomTypeDescription
Détail d'un dossier GET
/v1/sites/{code_site}/media/folders/{folder_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier

Format de sortie :

data:{
    "folder_id": "integer",
    "name": "string",
    "parent_folder_id": "integer",
    "is_bookmarked": "boolean",
    "has_restrictions": "boolean",
    "restrictions": "List",
    "folder_key": "string",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer"
}
NomTypeDescription
folder_idintegerIdentifiant du dossier
namestringIntitulé du dossier
parent_folder_idintegerIdentifiant du dossier parent
is_bookmarkedbooleanDossier en favoris
has_restrictionsbooleanDossier en accès restreint
restrictionsFacultatifListAccès extranet
folder_keyFacultatifstringClé API du dossier
creation_dateFacultatifstringDate de création
creation_date_fFacultatifstringDate de création formatée
creation_date_timestampFacultatifintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
Modifie un dossier PUT
/v1/sites/{code_site}/media/folders/{folder_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
parent_folder_idintegerIdentifiant du dossier parent
namestringNom du dossier
is_bookmarkedbooleanDossier en favoris
max_heightintegerHauteur maximale des images (Médiathèque avancée)
max_widthintegerLargeur maximale des images (Médiathèque avancée)
jpg_compressionintegerTaux de compression des jpg (Médiathèque avancée)
Supprime un dossier DELETE
/v1/sites/{code_site}/media/folders/{folder_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
Liste les droits extranet sur un dossier GET
/v1/sites/{code_site}/media/folders/{folder_id}/restrictions.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier

Format de sortie :

data:[
    {
        "type": "string",
        "customer_id": "integer",
        "customer_firstname": "string",
        "customer_lastname": "string",
        "group_id": "integer",
        "group_name": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer"
    }
]
NomTypeDescription
typestringType de restriction
customer_idFacultatifintegerIdentifiant du client
customer_firstnameFacultatifstringPrénom du client
customer_lastnameFacultatifstringNom du client
group_idFacultatifintegerIdentifiant du groupe extranet
group_nameFacultatifstringNom du groupe extranet
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
Modifie les droits extranet sur un dossier PUT
/v1/sites/{code_site}/media/folders/{folder_id}/restrictions.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
customer_idarrayListe d'identifiants des utilisateurs
group_idarrayListe d'identifiants des groupes
Ajoute un droit extranet sur un dossier POST
/v1/sites/{code_site}/media/folders/{folder_id}/restrictions.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
customer_idintegerIdentifiant de l'utilisateur
group_idintegerIdentifiant du groupe
Supprime les droits extranet sur un dossier DELETE
/v1/sites/{code_site}/media/folders/{folder_id}/restrictions.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
customer_idarrayListe des identifiants des utilisateurs
group_idarrayListe des identifiants des groupes

Fichiers

Recherche de médias dans la médiathèque GET
/v1/sites/{code_site}/media/files.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idintegerIdentifiant du dossier
termstringTerme recherché
sortstringDétermine l'ordre de tri parmis les critères suivants :
nameTri selon le nom du fichier
-dateTri selon la date de modification
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "media_id": "integer",
        "name": "string",
        "ext": "string",
        "thumb": {
            "id": "integer",
            "ext": "string",
            "url": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string",
            "url_miniature": "string",
            "url_vignette": "string"
        },
        "folder_id": "integer",
        "description": "string",
        "original_name": "string",
        "type": "string",
        "mime": "string",
        "weight": "integer",
        "width": "integer",
        "height": "integer",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "modification_by": "string"
    }
]
NomTypeDescription
media_idintegerIdentifiant du média
namestringIntitulé du média
extstringIntitulé du média
thumbFacultatifobjectVignettes
idFacultatifintegerIdentifiant du media
extstringExtension du media
urlstringUrl du media
url_g_miniatureFacultatifstringUrl de la grande miniature
url_g_vignetteFacultatifstringUrl de la grande vignette
url_miniatureFacultatifstringUrl de la miniature
url_vignetteFacultatifstringUrl de la vignette
folder_idFacultatifintegerIdentifiant du dossier
descriptionFacultatifstringDescription du média
original_nameFacultatifstringNom d'origine du fichier
typestringType du média
mimestringType mime du média
weightFacultatifintegerPoids du média
widthFacultatifintegerLargeur du média, pour une image
heightFacultatifintegerHauteur du média, pour une image
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
modification_byFacultatifstringAuteur de la dernière modification
Ajoute un média POST
/v1/sites/{code_site}/media/files.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
namestringIntitulé du fichier
descriptionstringDescription du fichier
folder_idObligatoireintegerIdentifiant du dossier
fileObligatoirefileFichier à envoyer

Format de sortie :

data:[]
NomTypeDescription
Supprime un lot de médias DELETE
/v1/sites/{code_site}/media/files.json

Permet de regrouper la suppression de jusqu'à 20 médias en un seul appel à l'API.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
mediasarrayIdentifiants de médias (max:20)
Détail d'un média GET
/v1/sites/{code_site}/media/files/{media_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
media_idObligatoireintegerIdentifiant du média

Format de sortie :

data:{
    "media_id": "integer",
    "name": "string",
    "ext": "string",
    "thumb": {
        "id": "integer",
        "ext": "string",
        "url": "string",
        "url_g_miniature": "string",
        "url_g_vignette": "string",
        "url_miniature": "string",
        "url_vignette": "string"
    },
    "folder_id": "integer",
    "description": "string",
    "original_name": "string",
    "type": "string",
    "mime": "string",
    "weight": "integer",
    "width": "integer",
    "height": "integer",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "modification_by": "string"
}
NomTypeDescription
media_idintegerIdentifiant du média
namestringIntitulé du média
extstringIntitulé du média
thumbFacultatifobjectVignettes
idFacultatifintegerIdentifiant du media
extstringExtension du media
urlstringUrl du media
url_g_miniatureFacultatifstringUrl de la grande miniature
url_g_vignetteFacultatifstringUrl de la grande vignette
url_miniatureFacultatifstringUrl de la miniature
url_vignetteFacultatifstringUrl de la vignette
folder_idFacultatifintegerIdentifiant du dossier
descriptionFacultatifstringDescription du média
original_nameFacultatifstringNom d'origine du fichier
typestringType du média
mimestringType mime du média
weightFacultatifintegerPoids du média
widthFacultatifintegerLargeur du média, pour une image
heightFacultatifintegerHauteur du média, pour une image
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
modification_byFacultatifstringAuteur de la dernière modification
Modifie un média PUT
/v1/sites/{code_site}/media/files/{media_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
media_idObligatoireintegerIdentifiant du média
namestringIntitulé du fichier
descriptionstringDescription du fichier
folder_idintegerIdentifiant du dossier
filefileFichier à envoyer
max_heightintegerHauteur maximale des images (Médiathèque avancée)
max_widthintegerLargeur maximale des images (Médiathèque avancée)
jpg_compressionintegerTaux de compression des jpg (Médiathèque avancée)
Supprime un média DELETE
/v1/sites/{code_site}/media/files/{media_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
media_idObligatoireintegerIdentifiant du média
Liste les médias d'un dossier GET
/v1/sites/{code_site}/media/folders/{folder_id}/files.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
termstringTerme recherché
sortstringDétermine l'ordre de tri parmis les critères suivants :
nameTri selon le nom du fichier
-dateTri selon la date de modification
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "media_id": "integer",
        "name": "string",
        "ext": "string",
        "thumb": {
            "id": "integer",
            "ext": "string",
            "url": "string",
            "url_g_miniature": "string",
            "url_g_vignette": "string",
            "url_miniature": "string",
            "url_vignette": "string"
        },
        "folder_id": "integer",
        "description": "string",
        "original_name": "string",
        "type": "string",
        "mime": "string",
        "weight": "integer",
        "width": "integer",
        "height": "integer",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "modification_by": "string"
    }
]
NomTypeDescription
media_idintegerIdentifiant du média
namestringIntitulé du média
extstringIntitulé du média
thumbFacultatifobjectVignettes
idFacultatifintegerIdentifiant du media
extstringExtension du media
urlstringUrl du media
url_g_miniatureFacultatifstringUrl de la grande miniature
url_g_vignetteFacultatifstringUrl de la grande vignette
url_miniatureFacultatifstringUrl de la miniature
url_vignetteFacultatifstringUrl de la vignette
folder_idFacultatifintegerIdentifiant du dossier
descriptionFacultatifstringDescription du média
original_nameFacultatifstringNom d'origine du fichier
typestringType du média
mimestringType mime du média
weightFacultatifintegerPoids du média
widthFacultatifintegerLargeur du média, pour une image
heightFacultatifintegerHauteur du média, pour une image
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
modification_byFacultatifstringAuteur de la dernière modification

Favoris

Liste les dossiers favoris GET
/v1/sites/{code_site}/media/bookmarks.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "folder_id": "integer",
        "name": "string",
        "parent_folder_id": "integer",
        "is_bookmarked": "boolean",
        "has_restrictions": "boolean",
        "restrictions": "List",
        "folder_key": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer"
    }
]
NomTypeDescription
folder_idintegerIdentifiant du dossier
namestringIntitulé du dossier
parent_folder_idintegerIdentifiant du dossier parent
is_bookmarkedbooleanDossier en favoris
has_restrictionsbooleanDossier en accès restreint
restrictionsFacultatifListAccès extranet
folder_keyFacultatifstringClé API du dossier
creation_dateFacultatifstringDate de création
creation_date_fFacultatifstringDate de création formatée
creation_date_timestampFacultatifintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
Liste le contenu d'un dossier GET
/v1/sites/{code_site}/media/folders/{folder_id}/content.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idObligatoireintegerIdentifiant du dossier
sortarrayDétermine l'ordre de tri parmis les critères suivants :
nameTri selon le nom du fichier
-dateTri selon la date de modification

Format de sortie :

data:{
    "folders": [
        {
            "folder_id": "integer",
            "name": "string",
            "parent_folder_id": "integer",
            "is_bookmarked": "boolean",
            "has_restrictions": "boolean",
            "restrictions": "List",
            "folder_key": "string",
            "creation_date": "string",
            "creation_date_f": "string",
            "creation_date_timestamp": "integer",
            "modification_date": "string",
            "modification_date_f": "string",
            "modification_date_timestamp": "integer"
        }
    ],
    "files": [
        {
            "media_id": "integer",
            "name": "string",
            "ext": "string",
            "thumb": {
                "id": "integer",
                "ext": "string",
                "url": "string",
                "url_g_miniature": "string",
                "url_g_vignette": "string",
                "url_miniature": "string",
                "url_vignette": "string"
            },
            "folder_id": "integer",
            "description": "string",
            "original_name": "string",
            "type": "string",
            "mime": "string",
            "weight": "integer",
            "width": "integer",
            "height": "integer",
            "creation_date": "string",
            "creation_date_f": "string",
            "creation_date_timestamp": "integer",
            "modification_date": "string",
            "modification_date_f": "string",
            "modification_date_timestamp": "integer",
            "modification_by": "string"
        }
    ]
}
NomTypeDescription
foldersobject
folder_idintegerIdentifiant du dossier
namestringIntitulé du dossier
parent_folder_idintegerIdentifiant du dossier parent
is_bookmarkedbooleanDossier en favoris
has_restrictionsbooleanDossier en accès restreint
restrictionsFacultatifListAccès extranet
folder_keyFacultatifstringClé API du dossier
creation_dateFacultatifstringDate de création
creation_date_fFacultatifstringDate de création formatée
creation_date_timestampFacultatifintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
filesobject
media_idintegerIdentifiant du média
namestringIntitulé du média
extstringIntitulé du média
thumbFacultatifobjectVignettes
idFacultatifintegerIdentifiant du media
extstringExtension du media
urlstringUrl du media
url_g_miniatureFacultatifstringUrl de la grande miniature
url_g_vignetteFacultatifstringUrl de la grande vignette
url_miniatureFacultatifstringUrl de la miniature
url_vignetteFacultatifstringUrl de la vignette
folder_idFacultatifintegerIdentifiant du dossier
descriptionFacultatifstringDescription du média
original_nameFacultatifstringNom d'origine du fichier
typestringType du média
mimestringType mime du média
weightFacultatifintegerPoids du média
widthFacultatifintegerLargeur du média, pour une image
heightFacultatifintegerHauteur du média, pour une image
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
modification_byFacultatifstringAuteur de la dernière modification