RÉFÉRENCE REST Catalogue des endpoints Les exemples utilisent https://exemple.fr/silverpeas/services/ : adaptez le domaine et le contexte à votre installation.
ALL GET POST DELETE PUT
résultats affichés
POST Ouvrir une session/services/authentication
Authentifie un utilisateur. En mode Basic, ouvre une session HTTP ; en mode Bearer, la session ne vaut que pour la requête. Retourne le profil utilisateur JSON.
Paramètres / données : En-tête Authorization
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" \
"https://exemple.fr/silverpeas/services/authentication"
GET Vérifier un jeton/services/profile/users/token
Retourne le profil associé au jeton API ou à l’utilisateur authentifié.
Paramètres / données : Authorization: Bearer ; access_token possible selon le code
Copier curl -i -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" \
"https://exemple.fr/silverpeas/services/profile/users/token"
GET Rechercher des utilisateurs/services/profile/users
Liste les profils visibles selon les droits et l’isolation des domaines. La réponse inclut X-Silverpeas-UserSize.
Paramètres / données : id, group, name, page, domain, accessLevel, userStatesToExclude, includeRemoved
Copier curl -i -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" \
"https://exemple.fr/silverpeas/services/profile/users"
GET Consulter un profil/services/profile/users/{userId}
Récupère un profil ; « me » représente l’utilisateur courant.
Paramètres / données : userId ; extended (booléen)
Copier curl -i -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" \
"https://exemple.fr/silverpeas/services/profile/users/{userId}"
GET Utilisateurs d’une application/services/profile/users/application/{instanceId}
Liste les utilisateurs ayant accès à une instance d’application, avec filtres de rôles et pagination.
Paramètres / données : instanceId, group, roles, matchingAllRoles, resource, name, page, userStatesToExclude, includeRemoved
Copier curl -i -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" \
"https://exemple.fr/silverpeas/services/profile/users/application/{instanceId}"
GET Jeton de session Web/services/session/token
Génère un jeton Web lié à une session HTTP existante. Réponse JSON avec la propriété token ; ne pas confondre avec le jeton API.
Paramètres / données : Session HTTP valide
Copier curl -i -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" \
"https://exemple.fr/silverpeas/services/session/token"
GET Consulter un groupe/services/profile/groups/{groupId}
Identifiant numérique ; les groupes imbriqués utilisent un chemin de groupes.
GET Lister les sous-groupes/services/profile/groups/{groupId}/groups
Filtres : name, page, withChildren, userStatesToExclude.
GET Lire un événement/services/calendar/{componentInstanceId}/{calendarId}/events/{eventId}
Retour JSON de l’événement.
POST Créer un événement/services/calendar/{componentInstanceId}/{calendarId}/events
Corps de requête : événement.
GET Lister les emplacements/services/private/publications/{componentId}/{pubId}/locations
Paramètre lang facultatif.
PUT Ajouter un alias/services/private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}
Crée un emplacement supplémentaire pour une publication.
DELETE Supprimer un alias/services/private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}
Retire un emplacement secondaire.
DELETE Supprimer un lien de publication/services/publications/{componentId}/{pubId}/links/{linkId}
Supprime le lien identifié.
GET Lister les espaces/services/admin/spaces
Espaces visibles pour l’utilisateur.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/admin/spaces"
GET Consulter un espace/services/admin/spaces/{spaceId}
Identifiant de l’espace.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/admin/spaces/{spaceId}"
PUT Modifier un espace/services/admin/spaces/{spaceId}
Corps JSON ; droits administrateur requis.
Copier curl -i -X PUT -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/admin/spaces/{spaceId}"
GET Lister les applications/services/admin/components
Filtres filter, param et value.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/admin/components"
GET Télécharger une pièce jointe/services/attachments/{componentId}/{id}/{name}
Réponse binaire application/octet-stream.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/attachments/{componentId}/{id}/{name}"
GET Contacts d’un utilisateur/services/profile/users/{userId}/contacts
Filtres : instance, roles, matchingAllRoles, resource, name, page, domain, userStatesToExclude, includeRemoved.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/profile/users/{userId}/contacts"
GET Lister les variables/services/variables
Retourne les variables disponibles.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables"
GET Valeurs courantes des variables/services/variables/currents
Consulte les valeurs courantes.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables/currents"
GET Consulter une variable/services/variables/{variableId}
Identifiant variableId.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables/{variableId}"
POST Créer une valeur planifiée/services/variables/{variableId}/values
Corps JSON avec la valeur planifiée.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" -H "Content-Type: application/json" --data @requete.json "https://exemple.fr/silverpeas/services/variables/{variableId}/values"
POST Modifier une valeur planifiée/services/variables/{variableId}/values/{valueId}
Corps JSON avec la valeur planifiée.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" -H "Content-Type: application/json" --data @requete.json "https://exemple.fr/silverpeas/services/variables/{variableId}/values/{valueId}"
GET Consulter le panier de sélection/services/selection
Retourne les éléments du panier courant.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/selection"
DELETE Retirer un élément du panier/services/selection/item/{id}
Identifiant de l’élément.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/selection/item/{id}"
DELETE Retirer une position du panier/services/selection/index/{index}
Index de l’élément dans la sélection.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/selection/index/{index}"
GET Lister les langues/services/languages
Retourne les langues disponibles.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/languages"
GET Consulter une notation/services/rating/{componentId}/{contributionType}/{contributionId}
Notation associée à une contribution.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/rating/{componentId}/{contributionType}/{contributionId}"
GET Consulter un partage/services/sharing/{token}
Accès à une ressource partagée à partir de son jeton.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/sharing/{token}"
PUT Modifier les préférences/services/mypreferences
Corps JSON décrivant les préférences.
Copier curl -i -X PUT -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" -H "Content-Type: application/json" --data @requete.json "https://exemple.fr/silverpeas/services/mypreferences"
POST Créer une variable/services/variables
Crée une variable depuis une entité JSON.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables"
POST Modifier une variable/services/variables/{variableId}
Met à jour la variable identifiée, via un corps JSON.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables/{variableId}"
DELETE Supprimer une variable/services/variables/{variableId}
Supprime la variable.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables/{variableId}"
DELETE Supprimer les variables/services/variables
Opération de suppression sur la collection ; à réserver aux utilisateurs autorisés.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables"
DELETE Supprimer une valeur planifiée/services/variables/{variableId}/values/{valueId}
Supprime une valeur planifiée.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/variables/{variableId}/values/{valueId}"
POST Ajouter au panier/services/selection
Ajoute une entrée au panier de sélection.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/selection"
DELETE Vider le panier/services/selection
Supprime les entrées du panier de sélection.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/selection"
POST Évaluer une contribution/services/rating/{componentId}/{contributionType}/{contributionId}
Enregistre une évaluation pour la contribution ciblée.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/rating/{componentId}/{contributionType}/{contributionId}"
GET Lister les groupes/services/profile/groups
Recherche les groupes racines selon les filtres ids, withChildren, name, page, domain et userStatesToExclude.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/profile/groups"
GET Groupes d’une application/services/profile/groups/application/{instanceId}
Liste les groupes disposant de droits sur une application.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/profile/groups/application/{instanceId}"
GET Détail d’un groupe/services/profile/groups/{path}
Retourne un groupe selon son chemin hiérarchique numérique.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/profile/groups/{path}"
GET Lister les commentaires/services/comments/{componentId}/{contentType}/{contentId}
Récupère les commentaires associés à une contribution.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/comments/{componentId}/{contentType}/{contentId}"
GET Lire un commentaire/services/comments/{componentId}/{contentType}/{contentId}/{commentId}
Récupère un commentaire particulier.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/comments/{componentId}/{contentType}/{contentId}/{commentId}"
POST Créer un commentaire/services/comments/{componentId}/{contentType}/{contentId}
Enregistre un commentaire transmis en JSON.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/comments/{componentId}/{contentType}/{contentId}"
PUT Modifier un commentaire/services/comments/{componentId}/{contentType}/{contentId}/{commentId}
Met à jour un commentaire en JSON.
Copier curl -i -X PUT -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/comments/{componentId}/{contentType}/{contentId}/{commentId}"
DELETE Supprimer un commentaire/services/comments/{componentId}/{contentType}/{contentId}/{commentId}
Supprime un commentaire selon les droits du demandeur.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/comments/{componentId}/{contentType}/{contentId}/{commentId}"
GET Rechercher/services/search
Recherche des contenus ; filtres notamment taxonomyPosition, spaceId, appId, startDate, endDate et form.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/search"
GET Lister les calendriers/services/calendar/{componentInstanceId}
Retourne les calendriers de l’application.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}"
GET Lire un calendrier/services/calendar/{componentInstanceId}/{calendarId}
Retourne les informations du calendrier.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}/{calendarId}"
POST Créer un calendrier/services/calendar/{componentInstanceId}
Crée un calendrier.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}"
PUT Modifier un calendrier/services/calendar/{componentInstanceId}/{calendarId}
Met à jour un calendrier.
Copier curl -i -X PUT -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}/{calendarId}"
DELETE Supprimer un calendrier/services/calendar/{componentInstanceId}/{calendarId}
Supprime un calendrier.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}/{calendarId}"
GET Exporter au format iCalendar/services/calendar/{componentInstanceId}/{calendarId}/export/ical
Retourne un document text/calendar.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}/{calendarId}/export/ical"
POST Importer un iCalendar/services/calendar/{componentInstanceId}/{calendarId}/import/ical
Importe des événements depuis un calendrier iCalendar.
Copier curl -i -X POST -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}/{calendarId}/import/ical"
PUT Synchroniser un calendrier/services/calendar/{componentInstanceId}/{calendarId}/synchronization
Déclenche la synchronisation.
Copier curl -i -X PUT -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/calendar/{componentInstanceId}/{calendarId}/synchronization"
GET Lister les publications privées/services/private/publications/{componentId}
Retourne les publications selon les filtres de la ressource.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/private/publications/{componentId}"
GET Localisations d’une publication/services/private/publications/{componentId}/{pubId}/locations
Retourne les emplacements d’une publication.
Copier curl -i -X GET -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/private/publications/{componentId}/{pubId}/locations"
PUT Ajouter un alias/services/private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}
Ajoute un emplacement secondaire.
Copier curl -i -X PUT -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}"
DELETE Supprimer un alias/services/private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}
Supprime un emplacement secondaire.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}"
DELETE Supprimer un lien/services/private/publications/{componentId}/{pubId}/links/{linkId}
Supprime un lien de publication.
Copier curl -i -X DELETE -H "Authorization: Bearer $SILVERPEAS_API_TOKEN" "https://exemple.fr/silverpeas/services/private/publications/{componentId}/{pubId}/links/{linkId}"
Autres opérations REST GET Consulter une notification reçue/services/usernotifications/inbox/{id}
DELETE Supprimer une notification/services/usernotifications/inbox/{id}
GET Marquer une notification comme lue/services/usernotifications/inbox/{id}/read
GET Lister les abonnements/services/subscriptions/{componentId}
GET Consulter les abonnements d’une ressource/services/subscriptions/{componentId}/{subscriptionType}/{id}
GET Consulter les abonnés/services/subscriptions/{componentId}/subscribers
GET Consulter la politique des mots de passe/services/password/policy
POST Vérifier un fichier envoyé/services/fileUpload/verify
GET Configuration de l’éditeur/services/wysiwyg/editor/{componentInstanceId}/{resourceType}/{resourceId}
GET Consulter les axes du plan de classement/services/pdc/{componentId}
DELETE Supprimer une relation/services/relations/{userId}
POST Ajouter des synonymes/services/thesaurus/vocabulary/{vocabularyId}/axis/{axisId}/values/{valueId}/synonyms