Yolo-Cianna-specifications.md

@@ -79,4 +79,33 @@ Retour JSON:
 }
 ```
 
+API du serveur de jobs accessible au serveur web:
+
+-  createJob(clientId, method, parameters)
+      clientId (string) : uuid fournie par le serveur web pour indentifier l'utilisateur
+      method (string) : nom du code à éxécuter
+      parameters (json) : objet json contenant les paramètres du code
+
+      retourne un jobId dans un objet json { jobId: "value"}
+
+
+-  pollJob(jobId)
+      jobId (string): id d'un job
+ 
+      retourne le statut du job (valeurs possibles : pending, executing, completed, aborted, error) 
+      {jobId: "value", status: ""}
+
+-  abortJob(jobId)
+      jobId (string) : id d'un job
+
+      retourne un object json contenant le nom du job et un flag indiquant le succès ou l'échec de la requête   
+      { jobId: "value", aborted : "boolean"}
+
+-  getResults(jobId)
+     jobId (string): id d'un job
+
+     retourne un objet json contenant le résultat de l'éxécution. Son format n'est pas encore défini
+     {jobId: "value", executionSucessful: "boolean", results : {}}
+
+