silverpeasDocumentation REST API

GED, publications et formulaires XML

Dossiers GED

Les dossiers de l’application GED disposent d’une API de navigation et de création. Les chemins hiérarchiques sont des suites d’identifiants numériques séparés par des barres obliques.

GET /folders/{componentId}

Récupérer le dossier racine

Paramètres / données : lang (optionnel)

GET /folders/{componentId}/{path}

Récupérer un dossier

Paramètres / données : lang (optionnel)

GET /folders/{componentId}/{path}/path

Chemin des dossiers parents

Paramètres / données : lang (optionnel)

GET /folders/{componentId}/{path}/children

Sous-dossiers

Paramètres / données : lang (optionnel)

GET /folders/{componentId}/{path}/treeview

Arborescence du dossier

Paramètres / données : lang (optionnel)

POST /folders/{componentId}/{path}

Créer un dossier enfant

Paramètres / données : Corps : NodeEntity

Publications

Les routes privées permettent de lister les publications d’une instance, d’obtenir leurs localisations et de gérer leurs alias. Les opérations de création et de modification de publications sont fournies par l’application GED.

GET /private/publications/{componentId}

Lister les publications

Paramètres / données : node, withAttachments

GET /private/publications/{componentId}/{pubId}/locations

Localisations et alias

Paramètres / données : lang

PUT /private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}

Ajouter un alias

DELETE /private/publications/{componentId}/{pubId}/locations/{nodeId}-{aliasComponentId}

Supprimer un alias

DELETE /private/publications/{componentId}/{pubId}/links/{linkId}

Supprimer un lien

POST /publications/{componentId}/{nodeId}

Créer une publication dans un dossier

Paramètres / données : JSON : PublicationEntity

POST /publications/{componentId}

Modifier une publication

Paramètres / données : JSON : PublicationEntity

Pièces jointes et documents

Les documents simples sont identifiés par l’instance, leur identifiant et éventuellement une langue. Le contenu binaire est accessible séparément des métadonnées.

GET /documents/{componentId}/resource/{id}/{lang}

Lister les documents d’une contribution

GET /documents/{componentId}/resource/{id}/types/{type}/{lang}

Filtrer les documents par type

GET /documents/{componentId}/document/{id}/{lang}

Métadonnées d’un document

GET /documents/{componentId}/document/{id}/content/{lang}

Télécharger le contenu binaire

GET /documents/{componentId}/document/{id}/translations

Lister les traductions

POST /documents/{componentId}/document/{id}/{filename}

Mettre à jour un fichier

Paramètres / données : multipart/form-data

DELETE /documents/{componentId}/document/{id}

Supprimer le document

DELETE /documents/{componentId}/document/{id}/content/{lang}

Supprimer le contenu d’une langue

PUT /documents/{componentId}/document/{id}/lock/{lang}

Verrouiller

POST /documents/{componentId}/document/{id}/unlock

Déverrouiller

Paramètres / données : force, webdav, private, comment

PUT /documents/{componentId}/document/{id}/moveUp

Remonter dans l’ordre

PUT /documents/{componentId}/document/{id}/moveDown

Descendre dans l’ordre

PUT /documents/{componentId}/document/{id}/switchState

Changer l’état de version

Paramètres / données : switch-version, switch-version-comment

POST /documents/{componentId}/document/{id}/switchDownloadAllowedForReaders

Autoriser ou interdire le téléchargement

Paramètres / données : allowed

POST /documents/{componentId}/document/{id}/switchDisplayAsContentEnabled

Afficher comme contenu

Paramètres / données : enabled

POST /documents/{componentId}/document/{id}/switchEditSimultaneouslyEnabled

Activer l’édition simultanée

Paramètres / données : enabled

GET /private/attachments/{componentId}/{id}/{name}

Télécharger une pièce jointe

Formulaires XML

Les données de formulaire sont disponibles au format JSON au moyen des opérations GET présentées ci-dessous.

GET /contribution/{componentInstanceId}/{contributionId}/content/form

Données du formulaire par défaut

Paramètres / données : lang

GET /contribution/{componentInstanceId}/{contributionId}/content/form/{formId}

Données du formulaire identifié

Paramètres / données : lang, renderView

Contenu WYSIWYG

La configuration de l’éditeur est exposée en REST, mais cela ne constitue pas une API de lecture/écriture du HTML d’une publication. Ne pas confondre configuration de CKEditor et contenu WYSIWYG.

GET /wysiwyg/editor/{componentInstanceId}/{resourceType}/{resourceId}

Configuration de l’éditeur

Exemples de consultation

Remplacer les valeurs entre chevrons et adapter le contexte de déploiement. Les exemples ci-dessous ne modifient aucune donnée.

curl -H 'Authorization: Bearer <JETON>' 'https://mon-silverpeas/services/private/publications/kmelia1?node=10&withAttachments=true'

curl -H 'Authorization: Bearer <JETON>' 'https://mon-silverpeas/services/documents/kmelia1/resource/123/fr'

curl -H 'Authorization: Bearer <JETON>' 'https://mon-silverpeas/services/contribution/kmelia1/123/content/form?lang=fr'

Structure JSON d’un formulaire

La réponse contient notamment formId, fields (indexé par nom de champ) et éventuellement renderedView. Chaque champ expose type, name, label, value ou values, et multiValues.

Attention : la présence de renderedView dépend de l’option renderView=true et du modèle de formulaire. La modification des données de formulaire XML et du HTML WYSIWYG n’est pas couverte par les routes GET ci-dessus.