Chapitre 3 Résumé de l'API

3.1 Carte de l'api

Type URL Implanté Signification
GET /api/v1/documents/ Oui Liste de documents
PUT /api/v1/documents/ N/A N/A
POST /api/v1/documents/ N/A N/A
DELETE /api/v1/documents/ N/A N/A
GET /api/v1/documents/<docid> Oui Récupération d'un document
PUT /api/v1/documents/<docid> Oui Mise à jour d'un document
POST /api/v1/documents/<docid> N/A N/A
DELETE /api/v1/documents/<docid> Oui Mise à la poubelle d'un document
GET /api/v1/documents/<docid>/history/ Oui Récupération des messages d'historique
PUT /api/v1/documents/<docid>/history/ N/A N/A
POST /api/v1/documents/<docid>/history/ Future version Ajout d'un message d'historique
DELETE /api/v1/documents/<docid>/history/ N/A N/A
GET /api/v1/documents/<docid>/revisions/ Oui Liste des révisions d'un document
PUT /api/v1/documents/<docid>/revisions/ N/A N/A
POST /api/v1/documents/<docid>/revisions/ N/A N/A
DELETE /api/v1/documents/<docid>/revisions/ N/A N/A
GET /api/v1/documents/<docid>/revisions/<revisionNumber> Oui Révision <revisionNumber>
PUT /api/v1/documents/<docid>/revisions/<revisionNumber> N/A N/A
POST /api/v1/documents/<docid>/revisions/<revisionNumber> N/A N/A
DELETE /api/v1/documents/<docid>/revisions/<revisionNumber> N/A N/A
GET /api/v1/families/ Oui Liste des familles
PUT /api/v1/families/ N/A N/A
POST /api/v1/families/ Future version Création d'une nouvelle famille
DELETE /api/v1/families/ N/A N/A
GET /api/v1/families/<family> Oui Consultation du document décrivant la famille
PUT /api/v1/families/<family> Future version Modification de la configuration de la famille
POST /api/v1/families/<family> N/A N/A
DELETE /api/v1/families/<family> Future version Suppression de la famille et des documents associés
GET /api/v1/families/<family>/documents/ Oui Liste des documents de cette famille
PUT /api/v1/families/<family>/documents/ Future version Modification en masse de documents de cette famille
POST /api/v1/families/<family>/documents/ Oui Création d'un document de cette famille
DELETE /api/v1/families/<family>/documents/ Future version Mise à la poubelle en masse des documents de cette famille
GET /api/v1/families/<family>/documents/<docid> Oui Récupération d'un document de la famille
PUT /api/v1/families/<family>/documents/<docid> Oui Mise à jour d'un document de la famille
POST /api/v1/families/<family>/documents/<docid> N/A N/A (Création d'un document avec un identifiant donné)
DELETE /api/v1/families/<family>/documents/<docid> Oui Suppression d'un document de la famille
GET /api/v1/families/<family>/enumerates/ Oui Récupération de la liste des énumérés
PUT /api/v1/families/<family>/enumerates/ N/A N/A
POST /api/v1/families/<family>/enumerates/ N/A N/A
DELETE /api/v1/families/<family>/enumerates/ N/A N/A
GET /api/v1/families/<family>/enumerates/<docid> Oui Récupération de la liste des valeurs
PUT /api/v1/families/<family>/enumerates/<docid> Future version Modification d'une valeur de la liste des énumérés
POST /api/v1/families/<family>/enumerates/<docid> Future version Ajout d'une valeur à la liste d'énumérés
DELETE /api/v1/families/<family>/enumerates/<docid> Future version Suppression d'un énuméré
GET /api/v1/temporaryFiles/ N/A N/A
PUT /api/v1/temporaryFiles/ N/A N/A
POST /api/v1/temporaryFiles/ Oui Création d'un fichier temporaire
DELETE /api/v1/temporaryFiles/ Future version Suppression d'un fichier temporaire
GET /api/v1/trash/ Oui Liste des documents de la poubelle
PUT /api/v1/trash/ N/A N/A
POST /api/v1/trash/ N/A N/A
DELETE /api/v1/trash/ Future version Supprime définitivement les documents de la poubelle
GET /api/v1/trash/<docid> Oui Récupération d'un document mis à la poubelle
PUT /api/v1/trash/<docid> N/A N/A
POST /api/v1/trash/<docid> N/A N/A
DELETE /api/v1/trash/<docid> Future version Suppression définitive d'un document mis à la poubelle
GET /api/v1/folders/ Oui Liste de documents de type dossier
PUT /api/v1/folders/ N/A N/A
POST /api/v1/folders/ N/A N/A
DELETE /api/v1/folders/ N/A N/A
GET /api/v1/folders/<folderId> Future version Description du dossier
PUT /api/v1/folders/<folderId> N/A N/A
POST /api/v1/folders/<folderId> N/A N/A
DELETE /api/v1/folders/<folderId> N/A N/A
GET /api/v1/folders/<folderId>/documents/ Oui Contenu du dossier folderId
PUT /api/v1/folders/<folderId>/documents/ N/A N/A
POST /api/v1/folders/<folderId>/documents/ Future version Ajout d'un document au dossier
DELETE /api/v1/folders/<folderId>/documents/ Future version Suppression d'un document du dossier
GET /api/v1/searches/ Oui Liste de documents de type recherche
PUT /api/v1/searches/ N/A N/A
POST /api/v1/searches/ N/A N/A
DELETE /api/v1/searches/ N/A N/A
GET /api/v1/searches/<searchId> Future version Description de la recherche
PUT /api/v1/searches/<searchId> N/A N/A
POST /api/v1/searches/<searchId> N/A N/A
DELETE /api/v1/searches/<searchId> N/A N/A
GET /api/v1/searches/<searchId>/documents/ Oui Contenu d'une recherche
PUT /api/v1/searches/<searchId>/documents/ N/A N/A
POST /api/v1/searches/<searchId>/documents/ N/A N/A
DELETE /api/v1/searches/<searchId>/documents/ N/A N/A
GET /api/v1/documents/<docid>/usertags/ Oui Liste des tags utilisateurs d'un document
PUT /api/v1/documents/<docid>/usertags/ N/A N/A
POST /api/v1/documents/<docid>/usertags/ N/A N/A
DELETE /api/v1/documents/<docid>/usertags/ N/A N/A
GET /api/v1/documents/<docid>/usertags/<tagIdentifier> Oui Tag utilisateur <tagIdentifier>
PUT /api/v1/documents/<docid>/usertags/<tagIdentifier> Oui Modification d'un tag utilisateur <tagIdentifier>
POST /api/v1/documents/<docid>/usertags/<tagIdentifier> Oui Création d'un tag utilisateur <tagIdentifier>
DELETE /api/v1/documents/<docid>/usertags/<tagIdentifier> Oui Suppression d'un tag utilisateur <tagIdentifier>
GET /api/v1/documents/<docid>/workflows/states/ Oui Liste des états possibles d'un document
PUT /api/v1/documents/<docid>/workflows/states/ N/A N/A
POST /api/v1/documents/<docid>/workflows/states/ N/A N/A
DELETE /api/v1/documents/<docid>/workflows/states/ N/A N/A
GET /api/v1/documents/<docid>/workflows/states/<state> Oui Caractéristiques de l'état
PUT /api/v1/documents/<docid>/workflows/states/<state> N/A N/A
POST /api/v1/documents/<docid>/workflows/states/<state> Oui Changement d'état d'un document <state>
DELETE /api/v1/documents/<docid>/workflows/states/<state> N/A N/A
GET /api/v1/documents/<docid>/workflows/transitions/ Oui Liste des transitions possibles d'un document
PUT /api/v1/documents/<docid>/workflows/transitions/ N/A N/A
POST /api/v1/documents/<docid>/workflows/transitions/ N/A N/A
DELETE /api/v1/documents/<docid>/workflows/transitions/ N/A N/A
GET /api/v1/documents/<docid>/workflows/transitions/<transitions> Oui Caractéristiques de la transition
PUT /api/v1/documents/<docid>/workflows/transitions/<transitions> N/A N/A
POST /api/v1/documents/<docid>/workflows/transitions/<transitions> Oui Passage d'une transition
DELETE /api/v1/documents/<docid>/workflows/transitions/<transitions> N/A N/A

Légende :

  • Les URL en italique font références à des collections,
  • Les URL en gras font références à des ressources,

Les entrées documents de famillies et de trash possède aussi les sous-collections :

  • history,
  • revisions.

Les entrées en Future version sont prévues pour une implémentation future mais non présentes dans la version courante de l'API.

Source : resume.md Dynacase Platform 3.2 | API HTTP Core Manuel de référence, version 1.0 édition 3, © Anakeen Labs <labs@anakeen.com>
×
Publié sous licence CC (http://creativecommons.org/licenses/by-nc-sa/2.0/fr/) par Anakeen [www.anakeen.com]
Attribution Vous devez créditer l'Oeuvre, intégrer un lien vers la licence et indiquer si des modifications ont été effectuées à l'Oeuvre. Vous devez indiquer ces informations par tous les moyens possibles mais vous ne pouvez pas suggérer que l'Offrant vous soutient ou soutient la façon dont vous avez utilisé son Oeuvre.
Pas d’Utilisation Commerciale Vous n'êtes pas autoriser à faire un usage commercial de cette Oeuvre, tout ou partie du matériel la composant.
Partage dans les Mêmes Conditions Dans le cas où vous effectuez un remix, que vous transformez, ou créez à partir du matériel composant l'Oeuvre originale, vous devez diffuser l'Oeuvre modifiée dans les même conditions, c'est à dire avec la même licence avec laquelle l'Oeuvre originale a été diffusée.