Liste des Webservices

Edit me

Liste WS Voozanoo4

Connection

Actions :

post

post

type	parameter
Array	acl

Dataset

Actions :

index
get

Ce webservice permet de récupérer la liste des dataquery, un dataset résultant de l’éxécution d’un dataquery ou même la liste des champs d’un dataquery.

Après “ws/dataset/”, il faut renseigner un (s)id de dataquery (“id/42” ou “sid/42”). Si aucun id n’est fournit, c’est la liste des dataquery qui est retournée.
Le paramètre format possède aussi des valeurs spéciales comme “field_list”, qui permet de lister les champs du dataquery
On peut utiliser chunk_index et filename pour récupérer un fichier en plusieurs parties

Exemple d’utilisation :

curl -X GET https://root:root@respe-decl.preprod.voozanoo.net/decl/ws/dataset/id/115

Exécute le dataquery N°115

curl -X GET https://root:root@respe-decl.preprod.voozanoo.net/decl/ws/dataset/id/116/format/json

Exécute le dataquery N°116, et retourne le résultat au format json

curl -X GET https://root:root@respe-decl.preprod.voozanoo.net/decl/ws/dataset/id/116/param1/value1/param2/value2

Exécute le dataquery N°116, en passant deux paramètres : param1 et param2, ayant pour valeurs respectives value1 et value2

Token

get

type	parameter	description
String	id	identifiant de l’utilisateur servant à générer le token
Integer	minute	minutes avant l’expiration du token
Integer	hour	heures avant l’expiration du token
Integer	day	jours avant l’expiration du token
Integer	month	mois avant l’expiration du token
Integer	year	années avant l’expiration du token

Ce webservice peut-être utilisé pour exécuter un dataquery d’une application depuis son portail de connexion

Exemple d’utilisation :

Sur le portail, je suis connecté en tant que médecin (username: med)
Dans le code de mon appli j’appelle ce webservice pour récupérer un token de connexion (via un utilisateur admin) : https://admin:admin@monappli.voozanoo.net/pj/ws/user-token/id/med
Le webservice me renvoie le token (par ex G86HZCPA5), et me permet d’exécuter un dataquery en tant que med : https://monappli.voozanoo.net/pj/ws/dataset/id/{id_dataquery}/t/G86HZCPA5

index

No parameters

get

type	parameter
String	filename
Integer	chunk_index
String	format (‘xml’, ‘csv’, ‘str_hash’, ‘field_list’, ‘json’)
Boolean	stream
Boolean	local

Error

Actions :

acl
exception

acl

type	parameter
String	error_msg
String	error_code
String	format

exception

No parameters

Group

Actions :

index

index

No parameters

HubAuthentication

Actions :

get
index

get

type	parameter
String	uuid
Integer	imei

index (alias de getAction)

type	parameter
String	uuid
Integer	imei

HubDataset

Actions :

get
post
put

get

No parameters

post

type	parameter
String	data
String	type

put (alias de post)

type	parameter
String	data
String	type

HubProject

Actions :

get

type	parameter
String	type

Mailing

Actions :

post

post

type	parameter
Boolean	mailing

Metrics

Ce web service sert à récupérer des informations quantitatives sur une application : le nombre de projets au sein de l’application, le nombre de dictionnaires, le nombre d’enregistrements dans un varset ou encore le nombre d’utilisateur par rôle au sein de un, plusieurs ou tous les projets.

Il est décrit en détail dans cet article :

OauthUser

Actions :

post

post

type	parameter
String	provider
array	users

SysProject

Actions :

get
post

get

type	parameter
String	id
String	type

post

type	parameter
String	type
String	id
String	uniq_id
Integer	environment_id
Integer	id_editor
String	token
String	feedback_url
String	next_action_to_play
String	last_action_to_play
String	project_label_b64
Boolean	sand_box

UserConsumer

Actions :

index
post
delete

index

type	parameter
String	username
String	consumer_name

post

type	parameter
String	username
Integer	id_user
Integer	id_consumer
String	consumer_name

delete

type	parameter
Integer	id

User

Actions :

get

type	parameter
String	id
Integer	minute
Integer	hour
Integer	day
Integer	month
Integer	year