REST API - Voir une liste de questions associées à tous les questionnaires

Modifié le 17/04/2023 15:16
Sommaire

Version minimum Service Manager : 2023.2 - Build 2023.2.111.0

GET  /questions-questionnaire

  • Cette méthode permet d’obtenir une liste de questions associées à tous les questionnaires.
  • Pour obtenir les informations détaillées d'une liste de questions d'un questionnaire déterminé : GET /questions-questionnaire/{questionnaire_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 /questions-questionnaire?max_rows=5
sort string Tri ascendant ou descendant.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • exemple /questions-questionnaire?sort=question_list_id+asc
fields string Sélection de champs à afficher.
  • exemple /questions-questionnaire?fields=email
search string Recherche/filtre sur des champs définis   -   Open url.png voir ?search=Description des options
  • exemple /questions-questionnaire?search=question.question_en:"Cause of change"
Oxygène 2.1.2 - Build 2018.1.183.0 search

(opérateur logique OU)

 string Recherche/filtre sur des champs définis
  • Syntaxe : search=champ:valeur1,champ:valeur2
  • exemple
    • /questions-questionnaire?search=question.question_en:"Cause of change", question.question_en:"Product" ==> toutes les questions pour lesquelles le champ question_en est Cause of change ou Product
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 >
  • /questions-questionnaire?search=question.question_en~"cause*" ==> toutes les questions dont le champ question_en commence par cause
    • /questions-questionnaire?search=question.question_en~"*oup*" ==> toutes les questions dont le champ question_en contient oup
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
    • /questions-questionnaire?search=question.question_en!~"group*" ==> toutes les questions en excluant celles dont le champ question_en commence par group
    • /questions-questionnaire?search=question.question_en!~"*oup*" ==> toutes les questions en excluant celles dont le champ question_en contient oup
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 /questions-questionnaire?search=question.question_en!"Cause of change" ==> toutes les questions en excluant celles dont le champ question_en est égal à Cause of change
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
    • /questions-questionnaire?search=question.question_en:"is_null" ==> toutes les questions pour lesquelles le champ question_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
    • /questions-questionnaire?search=question.question_en:"is_not_null" ==> toutes les questions pour lesquelles le champ question_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
    • /questions-questionnaire?fields=start_date&formatDate=l/M/Y ==> "start_date_format": "Friday/Feb/2023"
    • /questions-questionnaire?fields=start_date&formatDate=l jS \of F Y h:i:s A ==> "start_date_format": "Friday 17th of February 2023 12:00:00 AM"

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

Vous pouvez utiliser tous les champs de la table SD_QUESTION_RESULT.

Codes de statut HTTP de la méthode

StatusHeader

   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 avec un code de statut retourné 200

{
   "HREF": "https://{your_server}/api/v1/{your_account}/QUESTIONS-QUESTIONNAIRE?max_rows=2",
   "record_count": "2",
   "total_record_count": "80",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/questions-questionnaire/1",
           "DISPLAY_ORDER": "1",
           "QUESTION_LIST_ID": "1",
           "QUESTION": {
               "DEPENDS_ON_ANOTHER_QUESTION": "",
               "IS_REST_SUPPORTED": "1",
               "IS_VARIABLE": "",
               "QUESTION_CODE": "",
               "QUESTION_EN": "Patch ID",
               "QUESTION_FR": "Numéro de patch",
               "QUESTION_GE": "Verbesserungsnummer",
               "QUESTION_GUID": "{5572E6AC-979C-4722-A05C-B6E6D65CC8CB}",
               "HREF": "https://{your_server}/api/v1/{your_account}/question/6",
               "QUESTION_ID": "6",
               "QUESTION_IT": "Patch ID",
               "QUESTION_L1": "",
               "QUESTION_L2": "",
               "QUESTION_L3": "",
               "QUESTION_L4": "",
               "QUESTION_L5": "",
               "QUESTION_L6": "",
               "QUESTION_PO": "Patch ID",
               "QUESTION_SP": "Número de Parche",
               "VALUE_TYPE": "text"
            }
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/questions-questionnaire/1",
           "DISPLAY_ORDER": "2",
           "QUESTION_LIST_ID": "1",
           "QUESTION": {
               "DEPENDS_ON_ANOTHER_QUESTION": "",
               "IS_REST_SUPPORTED": "1",
               "IS_VARIABLE": "",
               "QUESTION_CODE": "",
               "QUESTION_EN": "Availability Date",
               "QUESTION_FR": "Date de mise à disposition du patch par l'éditeur",
               "QUESTION_GE": "Verfügbarkeitsdatum",
               "QUESTION_GUID": "{FFE07814-580F-4619-B3E6-62B001EC5C90}",
               "HREF": "https://{your_server}/api/v1/{your_account}/question/8",
               "QUESTION_ID": "8",
               "QUESTION_IT": "Disponibilità della patch",
               "QUESTION_L1": "",
               "QUESTION_L2": "",
               "QUESTION_L3": "",
               "QUESTION_L4": "",
               "QUESTION_L5": "",
               "QUESTION_L6": "",
               "QUESTION_PO": "Availability Date",
               "QUESTION_SP": "Fecha de Disponibilidad",
               "VALUE_TYPE": "date"
            }
        }
    ]
}
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 :
Powered by XWiki © EasyVista 2022