REST API - Voir une liste de SLA


GET  /slas

  • Cette méthode permet d’obtenir une liste de SLA.
  • Pour obtenir les informations détaillées d'un SLA déterminé : GET /slas/{sla_id}  - Open url.png voir la méthode

Remarques

      Open url.png  voir Conventions de l'API REST Service Manager

  • En cas de succès, un code de statut HTTP 200 est retourné.
    • Par défaut, si le paramètre optionnel fields n’est pas utilisé, seul un extrait des champs les plus utiles sélectionnés par EasyVista est affiché pour chaque enregistrement fourni.
    • Un lien URL (HREF) vers chaque ressource est fourni permettant d'obtenir la liste complète des champs pour un enregistrement.

Liste des paramètres / champs

Paramètres obligatoires

Aucun

Paramètres optionnels

Dans la chaîne de requête HTTP, vous pouvez utiliser les paramètres détaillés ci-dessous.

Version minimum Paramètre Type Description / Exemple
max_rows integer Nombre maximal d’enregistrements à afficher.
  • Valeur par défaut : 100
  • exemple /slas?max_rows=5
sort string Tri ascendant ou descendant.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • exemple /slas?sort=delay+desc
fields string Sélection de champs à afficher.
  • exemple /slas?fields=name_en,name_fr
search string Recherche/filtre sur des champs définis   -   Open url.png voir ?search=Description des options
  • exemple /slas?search=delay:"8"
Oxygène 2.1.2 - Build 2018.1.183.0 search

(opérateur logique OU)

string Recherche/filtre sur plusieurs valeurs d'un même champ
  • Syntaxe : search=champ:valeur1,champ:valeur2
  • exemple
    • /slas?search=name_en:4 hours,name_en:6 hours ==> tous les SLA pour lesquels le champ name_en est 4 hours ou 6 hours
Oxygène 1.7 - Build 2018.1.131.0 ~

(équivalent à like)

string Inclure tous les résultats commençant par ou contenant une chaîne de caractères donnée
  • Syntaxe : ~ suivi de la chaîne à inclure, placée entre guillemets
  • Utilisez le caractère joker *.
    • < chaîne >* = inclure ce qui commence par < chaîne >
    • *< chaîne >* = inclure ce qui contient < chaîne >
  • exemple
    • /slas?search=name_en~"4 ho*" ==> tous les SLA dont le champ name_en commence par 4 ho
    • /slas?search=name_en~"*4 ho*" ==> tous les SLA dont le champ name_en contient 4 ho
Oxygène 1.7 - Build 2018.1.131.0 !~

(équivalent à not like)

string Exclure tous les résultats commençant par ou contenant une chaîne de caractères donnée
  • Syntaxe : !~ suivi de la chaîne à exclure, placée entre guillemets
  • Utilisez le caractère joker *.
    • < chaîne >* = exclure ce qui commence par < chaîne >
    • *< chaîne >* = exclure ce qui contient < chaîne >
  • exemple
    • /slas?search=name_en!~"4 ho*" ==> tous les SLA en excluant ceux dont le champ name_en commence par 4 ho
    • /slas?search=name_en!~"*4 ho*" ==> tous les SLA en excluant ceux dont le champ name_en contient 4 ho
Oxygène 1.7 - Build 2018.1.131.0 !

(équivalent à not)

string Exclure tous les résultats égaux à une chaîne de caractères donnée
  • Syntaxe : ! suivi de la chaîne à exclure, placée entre guillemets
  • exemple /slas?search=name_en!"4 hours" ==> tous les SLA en excluant celles dont le champ name_en est égal à 4 hours
Oxygène 2.1.2 - Build 2018.1.183.0 is_null string Remonter tous les résultats pour lesquels les valeurs du champ sont vides (valeur du champ = null)
  • Syntaxe : Nom du champ suivi de "is_null"
  • exemple
    • /slas?search=name_en:"is_null" ==> tous les SLA pour lesquels le champ name_en est vide
Oxygène 2.1.2 - Build 2018.1.183.0 is_not_null string Remonter tous les résultats pour lesquels les valeurs du champ sont non vides (valeur du champ = not null)
  • Syntaxe : Nom du champ suivi de "is_not_null"
  • exemple
    • /slas?search=name_en:"is_not_null" ==> tous les SLA pour lesquels le champ name_en n'est pas vide
Oxygène 1.7 - Build 2018.1.131.0 formatDate string Formater l’affichage des champs de type Date dans le résultat de la requête HTTP   -   Open url.png voir Description des options de formatage
  • exemple
    • /slas?fields=time_limit&formatDate=l/M/Y ==> "time_limit_format": "Friday/Nov/2018"
    • /slas?fields=time_limit&formatDate=l jS \of F Y h:i:s A ==> "time_limit_format": "Friday 16th of November 2018 12:00:00 AM"

Champs pouvant être utilisés pour les paramètres optionnels

Vous pouvez utiliser tous les champs de la table SD_SLA.

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"
}

Exemple

Résultat pour 2 SLA (code de statut 200)

{
 "HREF": "http://{your_server}/api/v1/{your_account}/slas?fields=name_en,name_fr&max_rows=2",
 "record_count": "2",
 "total_record_count": "6",
 "records": [
    {
     "HREF": "http://{your_server}/api/v1/{your_account}/80003/slas/4",
     "DELAY": "4,00",
     "NAME_EN": "4 hours",
     "NAME_FR": "4 heures",
     "SLA_ID": "4"
    },
    {
     "HREF": "http://{your_server}/api/v1/{your_account}/slas/8",
     "DELAY": "6,00",
     "NAME_EN": "6 hours",
     "NAME_FR": "6 heures",
     "SLA_ID": "8"
    }
  ]
}


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)"  }  }

Tags :

Raccourcis

Powered by XWiki © EasyVista 2022