REST API - Voir une liste d'entités


GET  /departments

  • Cette méthode permet d’obtenir une liste d'entités.
  • Pour obtenir les informations détaillées d'une entité déterminée : GET /departments/{department_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 /departments?max_rows=5
sort string Tri ascendant ou descendant.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • exemple /departments?sort=start_date+desc
fields string Sélection de champs à afficher.
  • exemple /departments?fields=department_en,department_label,start_date,end_date
search string Recherche/filtre sur des champs définis   -   Open url.png voir ?search=Description des options
  • exemple /departments?search=parent_department_path:"IT"

Une recherche sur un champ Date est aussi possible.

  • exemple /departments?search=end_date:this_month
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
    • /departments?search=department_id:6,department_id:7 ==> toutes les entités pour lesquelles le champ department_id est 6 ou 7
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
    • /departments?search=department_en~"Sal*" ==> toutes les entités dont le champ department_en commence par Sal
    • /departments?search=department_en~"*Sal*" ==> toutes les entités dont le champ department_en contient Sal
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
    • /departments?search=department_en!~"Sal*" ==> toutes les entités en excluant celles dont le champ department_en commence par Sal
    • /departments?search=department_en!~"*Sal*" ==> toutes les entités en excluant celles dont le champ department_en contient Sal
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 /departments?search=department_en!"Sales" ==> toutes les entités en excluant celles dont le champ department_en est égal à Sales
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
    • /departments?search=department_en:"is_null"&sort=department_id+asc ==> toutes les entités pour lesquelles le champ department_en est vide, triées par identifiant croissant
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
    • /departments?search=department_en:"is_not_null"&sort=department_id+asc ==> toutes les entités pour lesquelles le champ department_en n'est pas vide, triées par identifiant croissant
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
    • /departments?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /departments?fields=last_update&formatDate=l jS \of F Y h:i:s A ==> "last_update_format": "Friday 16th of November 2018 12:00:00 AM"

Champs optionnels

Dans le corps de la requête HTTP, vous pouvez utiliser tous les champs de la table AM_DEPARTMENT sauf ceux indiqués ci-dessous.

NotAuthorizedOptionalFields_Department
  • label_color ; label_font ; label_size 
  • property_color ; property_font ; property_size 
  • xpos ; ypos ; zpos 
  • lft ; rgt ; level
  • path_to_compute 

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 3 entités (code de statut 200)

{
   "HREF": "http://{your_server}/api/v1/{your_account}/departments?max_rows=3",
   "record_count": "3",
   "total_record_count": "69",
   "records": [
        {
           "HREF": "http://{your_server}/api/v1/{your_account}/departments/5",
           "DEPARTMENT_CODE": "",
           "DEPARTMENT_EN": "-",
           "DEPARTMENT_PATH": "",
           "DEPARTMENT_ID": "5",
           "DEPARTMENT_LABEL": ""
        },
        {
           "HREF": "http://{your_server}/api/v1/{your_account}/departments/6",
           "DEPARTMENT_CODE": "",
           "DEPARTMENT_EN": "Sales",
           "DEPARTMENT_PATH": "Sales",
           "DEPARTMENT_ID": "6",
           "DEPARTMENT_LABEL": ""
        },
        {
           "HREF": "http://{your_server}/api/v1/{your_account}/departments/7",
           "DEPARTMENT_CODE": "",
           "DEPARTMENT_EN": "International USA",
           "DEPARTMENT_PATH": "Sales/Export",
           "DEPARTMENT_ID": "7",
           "DEPARTMENT_LABEL": ""
      }
    ]
}


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