Chapitre 6 Extension de l'api HTTP
Ce module étend l'API HTTP de dynacase avec les routes suivantes :
6.1 Carte de l'api donnée
| Type | URL | Implémenté | Signification |
|---|---|---|---|
| GET | /api/v1/documents/<docid>/views/ | Oui | Liste des rendus de documents |
| PUT | /api/v1/documents/<docid>/views/ | N/A | N/A |
| POST | /api/v1/documents/<docid>/views/ | N/A | N/A |
| DELETE | /api/v1/documents/<docid>/views/ | N/A | N/A |
| GET | /api/v1/documents/<docid>/views/<viewId> | Oui | Récupération du rendu d'un document |
| PUT | /api/v1/documents/<docid>/views/<viewId> | Oui | Mise à jour d'un document avec le rendu indiqué |
| POST | /api/v1/documents/<docid>/views/<viewId> | N/A | N/A |
| DELETE | /api/v1/documents/<docid>/views/<viewId> | N/A | N/A |
| GET | /api/v1/families/<famid>/views/structure | Oui | Récupération de la structure d'une famlille (caractéristiques des attributs) |
| PUT | /api/v1/families/<famid>/views/structure | Non | N/A |
| POST | /api/v1/families/<famid>/views/structure | N/A | N/A |
| DELETE | /api/v1/families/<famid>/views/structure | N/A | N/A |
| GET | /api/v1/documents/<docid>/revision/<revision>/views/<viewId> | Oui | Récupération du rendu d'une révision de document |
| PUT | /api/v1/documents/<docid>/revision/<revision>/views/<viewId> | N/A | N/A |
| POST | /api/v1/documents/<docid>/revision/<revision>/views/<viewId> | N/A | N/A |
| DELETE | /api/v1/documents/<docid>/revision/<revision>/views/<viewId> | N/A | N/A |
| GET | /api/v1/families/<famid>/documentsViews/ | N/A | N/A |
| PUT | /api/v1/families/<famid>/documentsViews/ | N/A | N/A |
| POST | /api/v1/families/<famid>/documentsViews/ | Oui | Création d'un document de la famille en utilisant le rendu de création |
| DELETE | /api/v1/families/<famid>/documentsViews/ | N/A | N/A |
| GET | /api/v1/documents/<docid>/views/states/<states> | Oui | [Caractéristiques d'affichage de la transition vers l'état "state"] |
| PUT | /api/v1/documents/<docid>/views/states/<states> | N/A | N/A |
| POST | /api/v1/documents/<docid>/views/states/<states> | Oui | Passage de la transition vers l'état "state" |
| DELETE | /api/v1/documents/<docid>/views/states/<states> | N/A | N/A |
| GET | /api/i18n/<catalogName> | Oui | Récupération du catalogue catalogName
|
| PUT | /api/i18n/<catalogName> | N/A | N/A |
| POST | /api/i18n/<catalogName> | N/A | N/A |
| DELETE | /api/i18n/<catalogName> | 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.
6.2 Carte de l'api HTML
| Type | URL | Implémenté | Signification |
|---|---|---|---|
| GET | /api/v1/documents/<docid>.html | Oui | Affichage du document n°docid |
| GET | /api/v1/documents/<docid>/revision/<revision>.html | Oui | Affichage de la révision n°revision du document n°docid |
| GET | /api/v1/documents/<docid>/views/<viewId>.html | Oui | Affichage de la vue viewId du document n°docid |
| GET | /api/v1/documents/<docid>/views/<viewId>/revision/<revision>.html | Oui | Affichage de la vue viewId de la révision n°revision du document n°docid |
Si les extensions "html" sont remplacés par l'extension "json", l'url reste valide et retourne les données du documents ou de la vue.