Un espace de travail (Workspace) est un ensemble de dossiers et de fichiers.
Collection Postman : Workspace.postman_collection.json
Créer un espace de travail (workspace)
Pour créer un espace de travail, vous devez envoyer une requête HTTP POST à la ressource /workspaces avec des paramètres (FORM ou JSON) :
- alias : un identifiant unique (alpha-numérique sans espace)
- name : un nom d’espace de travail
- type : un type d’espace de travail (seul USER est disponible pour l’instant)
Si l’espace de travail est créé, un code HTTP 201 est renvoyé. Et la charge utile contient la représentation de l’espace de travail au format JSON. Lorsque l’alias existe déjà, le serveur renvoie un code HTTP 409.
URL de la ressource : https://repository.ortolang.fr/api/workspaces
Obtenir des informations sur un espace de travail (workspace)
La représentation JSON d’un espace de travail est accessible en envoyant une requête HTTP GET avec la clé de l’espace de travail dans le chemin de la requête. Lorsque le paramètre md est réglé sur true, la réponse contient la représentation des métadonnées.
URL de la ressource : https://repository.ortolang.fr/api/workspaces/{wskey}
Créer un dossier dans un espace de travail (workspace)
Un dossier peut être créé en envoyant une requête HTTP POST avec un corps au format multipart/form. Les paramètres obligatoires sont : le chemin (path) et le type (doit être collection).
La liste des paramètres est :
- path : le chemin d’accès au dossier
- type : le type d’élément (collection dans ce cas)
URL de la ressource : https://repository.ortolang.fr/api/workspaces/{wskey}/elements
Téléverser un fichier sur un espace de travail (workspace)
Comme pour la création d’un dossier, la création d’un fichier se fait par l’envoi d’une requête HTTP POST avec un corps au format multipart/form. Les paramètres obligatoires sont : le chemin (path) et le type qui doit être un objet (object).
Un fichier peut être mis à jour par le même mécanisme ou en envoyant une requête HTTP PUT avec un corps au format JSON.
La liste des paramètres est :
- path : le chemin d’accès au fichier
- type : le type d’élément (object dans ce cas)
- stream : le contenu du fichier
URL de la ressource : https://repository.ortolang.fr/api/workspaces/{wskey}/elements
Obtenir des informations sur un élément
Récupère des informations sur un élément en envoyant une requête HTTP GET.
Liste des paramètres :
- path : le chemin d’accès à l’élément (obligatoire)
- root : la version de l’espace de travail (la valeur head est pour le contenu actuel)
- metadata : permet de récupérer un élément de métadonnées spécifique
- policy : permet d’obtenir des informations sur la politique de publication
URL de la ressource : https://repository.ortolang.fr/api/workspaces/{wskey}/elements
Supprimer un fichier
Supprime un élément en envoyant une demande HTTP DELETE.
Liste des paramètres :
- path : le chemin d’accès à l’élément (obligatoire)
- root : la version de l’espace de travail (la valeur head est pour le contenu actuel)
- metadataname : pour supprimer un élément de métadonnées
- force : supprimer le dossier même s’il n’est pas vide
URL de la ressource : https://repository.ortolang.fr/api/workspaces/{wskey}/elements
