REST API - Voir les informations de la clé de licence Service Manager
Sommaire
GET /license
- Cette méthode permet d’obtenir des informations concernant la clé de licence Service Manager.
Remarques
voir Conventions de l'API REST Service Manager
- En cas de succès, un code de statut HTTP 200 est retourné.
Liste des paramètres / champs
Paramètres obligatoires
Aucun
Paramètres optionnels
Aucun
Codes de statut HTTP de la méthode
StatusHeader
Note : Un code erreur Timeout est renvoyé et la méthode échoue si le serveur ne répond pas à la requête du web service REST au bout d'un certain temps (par défaut, 60 secondes).
| Code | Erreur | Description |
|---|
Status200
| 200 | OK (Succès) | Requête traitée avec succès. |
Status401
| 401 | Unauthorized (Non autorisé) | Processus d'authentification pour accéder à la ressource incorrect : Login/Mot de passe incorrect, Session non valide, Compte Service Manager incorrect.
exemple { "error": "Invalid Login / Password" } |
Status404
| 404 | Not found (Non trouvée) | Ressource non trouvée : URI incorrecte, Ressource inexistante, Communication avec le serveur incorrecte, rfc_number non trouvé.
exemple { "error": "Resource not found" } |
Exemple
Résultat avec un code de statut retourné 200
{
"HREF": "http://{your_server}/api/v1/{your_account}/license",
"License": {
"Account": "40000",
"Connected": "1",
"DateTime": "2022-02-07T16:14:06+0000",
"MaxConnexions": "9999"
}
}
"HREF": "http://{your_server}/api/v1/{your_account}/license",
"License": {
"Account": "40000",
"Connected": "1",
"DateTime": "2022-02-07T16:14:06+0000",
"MaxConnexions": "9999"
}
}
ConventionsAPI
Conventions de l'API REST
| Convention | Signification | |
|---|---|---|
| Orange | Paramètres utilisés dans la chaîne d’une requête HTTP et qui ne correspondent pas à des champs de la base Service Manager.
exemple Méthode Voir une liste de biens https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag |
|
| Noir et Gras | Paramètres utilisés dans l’URL d’une requête HTTP et qui correspondent à des champs de la base Service Manager.
exemple Méthode Voir un bien https://{your_server}/api/v1/{your_account}/assets/{asset_id} |
|
| Vert | Paramètres utilisés dans le corps d’une requête HTTP et qui représentent des noms d’objets JSON correspondant à des champs de la base Service Manager ; ils permettent d’affecter ou de modifier une valeur de champ dans la base.
exemple Méthode Terminer un ticket { "closed": { "end_date": "11/20/2016 12:12:12", } } |
|
| Paramètres utilisés dans le corps d’une requête HTTP et qui représentent des noms d’objets JSON ne correspondant pas à des champs de la base Service Manager.
exemple Méthode Reprendre un ticket { "restarted": { "comment": "string (required)" } } |
||