Chapitre 12 Famille
Cette collection décrit les familles de Dynacase.
12.1 URL
L'url d'accès est : /api/v1/families
12.2 Méthodes
La collection familles implémente les méthodes suivantes :
- Collection : Il n'y a pas d'accès possible directement auprès de la collection famille :
| Action | URL | Action effectuée |
|---|---|---|
GET |
/api/v1/families/ |
N/A |
POST |
/api/v1/families/ |
N/A |
PUT |
/api/v1/families/ |
N/A |
DELETE |
/api/v1/families/ |
N/A |
- Ressource :
| Action | URL | Action effectuée |
|---|---|---|
GET |
/api/v1/families/<famid> |
Retourne les propriétés de la famille famid |
POST |
/api/v1/families/<famid> |
N/A |
PUT |
/api/v1/families/<famid> |
N/A |
DELETE |
/api/v1/families/<famid> |
N/A |
- Sous-ressource /documents/ :
| Action | URL | Action effectuée |
|---|---|---|
GET |
/api/v1/families/<famid>/documents/ |
Liste des documents de la famille famid |
POST |
/api/v1/families/<famid>/documents/ |
Créé un document de la famille famid |
PUT |
/api/v1/families/<famid>/documents/ |
N/A |
DELETE |
/api/v1/families/<famid>/documents/ |
N/A |
- Sous-ressource /documents/ :
| Action | URL | Action effectuée |
|---|---|---|
GET |
/api/v1/families/<famid>/documents/<id> |
Retourne le document id |
POST |
/api/v1/families/<famid>/documents/<id> |
N/A |
PUT |
/api/v1/families/<famid>/documents/<id> |
Met à jour le document id |
DELETE |
/api/v1/families/<famid>/documents/<id> |
Supprime le document id |
Contenu du chapitre
- 12.3 Propriétés d'une famille
- 12.3.1 URL
- 12.3.2 Content
- 12.3.3 Structure de retour
- 12.3.4 Résultat partiel
- 12.4 Consultation des documents de la familles
- 12.4.1 URL canonique
- 12.4.2 Content
- 12.4.3 Structure de retour
- 12.4.4 Résultat partiel
- 12.4.5 Cache
- 12.5 Création d'un document
- 12.5.1 URL
- 12.5.2 Content
- 12.5.3 Structure de retour