Les communautés
Les communautés sont la base de l'utilisation de la plateforme. Elles permettent de regrouper des utilisateurs, en précisant leurs droits sur chacune. D'un point de vue modèle, c'est une entité community.
Créer une communauté
Une communauté est décrite par :
- un nom
- un nom technique, URL-compliant, utilisé pour stocker et diffuser certaines données liées à la communauté
- est-elle publique. Une communauté publique apparaîtra dans le catalogues des communautés
- un utilisateur référent. Celui-ci sera connu des utilisateurs de la communauté. Il ne pourra pas en être exclu et aura tous les droits sur cette communauté.
- un courriel de contact. Ce sera celui du référent s'il n'est pas précisé et est diffusé dans les livraisons et données stockées partagées.
Toutes ces informations sont précisées lors de l'appel à l'API POST /administrator/communities pour créer une nouvelle communauté.
Parcourir les communautés
L'API GET /administrator/communities permet de récupérer l'ensemble des communautés (avec pagination).
L'API GET /administrator/communities/{id} permet de récupérer toutes les informations sur une communauté en particulier.
Modifier une communauté
L'API PATCH /administrator/communities/{id} permet de modifier partiellement une communauté, seulement sur ses attributs de nom, de publicité et d'utilisateur référent. Le courriel de contact et le nom sont modifiables par le référent via l'API PATCH /communities/{id}.
Supprimer une communauté
La suppression d'une communauté (DELETE /administrator/communities/{id}) est très limitée : elle ne peut être faite qu'en l'absence d'entrepôt rattaché.
Ajouter un entrepôt à une communauté
Cette action se fait via la création d'un entrepôt.