1.Points finaux disponibles
Il est possible d'accéder via HTTP à divers objets du HS/FS. Les appels correspondant aux différents objets sont décrits en détail ci-dessous.
Des points finaux sont disponibles pour les objets suivants :
Des points finaux sont disponibles pour les objets suivants :
2.Appel
Dans le principe, un appel se présent ainsi (les jokers sont en MAJUSCULES) :
Les différents objets présentent une description des méthodes (et éventuellement des paramètres qui vous sont nécessaires).
https://HS_IP/endpoints/call?key=OBJECT-KEY&method=METHOD&PARAMETER=VALUE&user=USER&pw=PWD
Joker | Explication |
---|---|
HS_IP | L'adresse IP du HS/FS. |
OBJECT-KEY | La clé d'objet est composée d'un préfixe défini pour l'objet concerné, suivi d'un signe'@'- et de l'ID déterminé pour l'objet dans l'Expert. Exemple de clé d'un objet de communication : CO@100_2_3 . |
METHOD | La méthode mentionnée dépend du type de l'objet concerné. Une liste des méthodes disponibles pour l'objet concerné se trouve dans l'aide de l'objet. |
PARAMETER=VALUE | En option, peut aussi exister plusieurs fois. Le nombre de paramètres varie selon la méthode utilisée (de 0 à n). Ils sont intégrés dans l'appel via un signe '&', suivi du type de paramètre, d'un signe '=' et de la valeur du paramètre. Selon l'objet et la méthode utilisés, il est possible de déterminer si des paramètres sont requis, et si oui, lesquels. Exemple : pour régler un objet comm. sur la valeur 7, entrer 'value' comme PARAMETRE et '7' comme valeur : &value=7 . |
USER | Nom d'utilisateur d'un utilisateur utilisé dans HS/FS Expert. Cet utilisateur doit disposer de droits d'accès en lecture et éventuellement en écriture sur l'objet concerné. |
PWD | Mot de passe de l'utilisateur indiqué plus haut, dans l'Expert HS/FS. |
Les différents objets présentent une description des méthodes (et éventuellement des paramètres qui vous sont nécessaires).