L’API REST du service de diffusion premet de manipuler aussi bien les ressources en cours d’élaboration que celles qui sont publiées.

Une documentation complète est accessible à l’adresse Documentation API REST.

Création d’un espace

Pour créer un espace de travail, il faut envoyer une requête HTTP POST sur le chemin /workspaces avec les informations suivantes (FORM ou JSON) :

  • alias - Alias du nouvelle espace (Il ne peut y avoir deux alias identiques sur ORTOLANG et il est du type Alpha-numerique sans espace)
  • name - Nom de l’espace
  • type - Type de l’espace (Pour le moment, la seule valeur possible est ‘USER’)

Si l’alias existe déjà, le service retourne le code HTTP 409, sinon il renvoie le code HTTP 201.
Dans le payload de la réponse, il y a les informations du workspace (key, alias, …) au format JSON.

Publication d’un espace

La demande de publication est un processus, c’est pourquoi il faut envoyer une requête HTTP POST vers le chemin /runtime/processes avec les champs suivants (FORM) :

  • process-type = “publish-workspace”
  • process-name - Un nom suffisamment explicite serait : “Publication de l’espace: {nom_de_l’espace}”
  • wskey - Le champ “key” de l’espace qui a été fourni lors de la création de l’espace)
  • wstag - Un numéro de version, par convention, il faut commencer par v puis le numéro de la version; exemple “v1”)

Si le processus a été créé, le service renvoie le code HTTP 201 avec les informations sur le processus créé.

Back to top

Version: 10-SNAPSHOT. Last Published: 2017-09-22.