REST API - Voir une liste de problèmes


Version minimum : Service Manager Oxygène 1.8 - Build 2018.1.140.0

GET  /problems

  • Cette méthode permet d’obtenir une liste de problèmes.
  • Pour obtenir les informations détaillées d'un problème déterminé : GET /problems/{rfc_number}  - 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 /problems?max_rows=5
sort string Tri ascendant ou descendant.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • exemple /problems?sort=rfc_number+desc
fields string Sélection de champs à afficher.
  • exemple /problems?fields=rfc_number
search string Recherche/filtre sur des champs définis   -   Open url.png voir Description des options
  • exemple /problems?search=rfc_number:"P090330_000001"

Une recherche sur un champ Date est aussi possible.

  • exemple /problems?search=submit_date_ut:last_week
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
    • /problems?search=rfc_number:P090330_000003,rfc_number:P090330_000004 ==> tous les problèmes pour lesquels le champ rfc_number est P090330_000003 ou P090330_000004
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
    • /problems?search=catalog_request.title_en~"app*" ==> tous les problèmes dont le champ catalog_request.title_en commence par app
    • /problems?search=catalog_request.title_en~"*app*" ==> tous les problèmes dont le champ catalog_request.title_en contient app
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
    • /problems?search=catalog_request.title_en!~"app*" ==> tous les problèmes en excluant ceux dont le champ catalog_request.title_en commence par app
    • /problems?search=catalog_request.title_en!~"app*" ==> tous les problèmes en excluant ceux dont le champ catalog_request.title_en contient app
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 /problems?search=catalog_request.title_en!"application" ==> tous les problèmes en excluant ceux dont le champ catalog_request.title_en est égal à application
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
    • /problems?search=description:"is_null" ==> tous les problèmes pour lesquels la description 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
    • /problems?search=description:"is_not_null" ==> tous les problèmes pour lesquels la description 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
    • /problems?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /problems?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 pouvant être utilisés pour les paramètres optionnels

Vous pouvez utiliser tous les champs de la table SD_REQUEST.

Codes de statut HTTP de la méthode

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

Exemples

Résultat pour 3 problèmes (code de statut 200)

{
   "record_count": "3",
   "total_record_count": "7",
   "records": [
        {
           "COMMENT": {
               "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000001/comment"
            },
           "REQUEST_ID": "25989",
           "RFC_NUMBER": "P090330_000001",
           "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000001",
           "SUBMIT_DATE_UT": "2009-03-30T14:11:06.000+02:00",
           "CATALOG_REQUEST": {
               "CODE": "",
               "CATALOG_REQUEST_PATH": "Problème/Application*",
               "SD_CATALOG_ID": "4930",
               "TITLE_FR": "Application*"
            },
           "STATUS": {
               "STATUS_FR": "En cours",
               "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
               "STATUS_ID": "12"
            },
           "RECIPIENT": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Ventes/International France",
               "E_MAIL": "fuser@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18302",
               "EMPLOYEE_ID": "18302",
               "LAST_NAME": "Jennifer",
               "LOCATION_PATH": "Europe/France/Paris",
               "PHONE_NUMBER": "+33155859645"
            },
           "REQUESTOR": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            },
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "1733",
               "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1733",
               "LOCATION_ID": "2230"
            },
           "DEPARTMENT": {
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Finance",
               "DEPARTMENT_PATH": "Finance",
               "DEPARTMENT_ID": "10",
               "DEPARTMENT_LABEL": ""
            }
        },
        {
           "COMMENT": {
               "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000002/comment"
            },
           "REQUEST_ID": "25990",
           "RFC_NUMBER": "P090330_000002",
           "HREF": "http://{your_server}/api/v1/{your_account}/problems/P090330_000002",
           "SUBMIT_DATE_UT": "2009-03-30T14:13:10.000+02:00",
           "CATALOG_REQUEST": {
               "CODE": "",
               "CATALOG_REQUEST_PATH": "Problème/Bureautique",
               "SD_CATALOG_ID": "4928",
               "TITLE_FR": "Bureautique"
            },
           "STATUS": {
               "STATUS_FR": "En cours",
               "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
               "STATUS_ID": "12"
            },
           "RECIPIENT": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Ventes/International France",
               "E_MAIL": "fuser@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18302",
               "EMPLOYEE_ID": "18302",
               "LAST_NAME": "Jennifer",
               "LOCATION_PATH": "Europe/France/Paris",
               "PHONE_NUMBER": "+33155859645"
            },
           "REQUESTOR": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            },
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "1733",
               "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1733",
               "LOCATION_ID": "2230"
            },
           "DEPARTMENT": {
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Finance",
               "DEPARTMENT_PATH": "Finance",
               "DEPARTMENT_ID": "10",
               "DEPARTMENT_LABEL": ""
            }
        },
        {
           "COMMENT": {
               "HREF": "http://{your_server}/api/v1/{your_account}/problems/P180903_000001/comment"
            },
           "REQUEST_ID": "42732",
           "RFC_NUMBER": "P180903_000001",
           "HREF": "http://{your_server}/api/v1/{your_account}/problems/P180903_000001",
           "SUBMIT_DATE_UT": "2018-09-03T10:37:12.000+02:00",
           "CATALOG_REQUEST": {
               "CODE": "",
               "CATALOG_REQUEST_PATH": "Problème/Infrastructure",
               "SD_CATALOG_ID": "4929",
               "TITLE_FR": "Infrastructure"
            },
           "STATUS": {
               "STATUS_FR": "En cours",
               "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}",
               "STATUS_ID": "12"
            },
           "RECIPIENT": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Finance",
               "E_MAIL": "fadmin@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18368",
               "EMPLOYEE_ID": "18368",
               "LAST_NAME": "Eddy",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/120",
               "PHONE_NUMBER": "+41798248341"
            },
           "REQUESTOR": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "Finance",
               "E_MAIL": "fadmin@evtry.com",
               "HREF": "http://{your_server}/api/v1/{your_account}/employees/18368",
               "EMPLOYEE_ID": "18368",
               "LAST_NAME": "Eddy",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/120",
               "PHONE_NUMBER": "+41798248341"
            },
           "LOCATION": {
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "120",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/120",
               "LOCATION_ID": "1539"
            },
           "DEPARTMENT": {
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Finance",
               "DEPARTMENT_PATH": "Finance",
               "DEPARTMENT_ID": "10",
               "DEPARTMENT_LABEL": ""
            }
        },
    ],
   "HREF": "http://{your_server}/api/v1/{your_account}/problems/"
}


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:
Modifié par Utilisateur inconnu le 2021/02/05 16:53
Créé par Administrator XWiki le 2019/05/16 09:17

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021