REST API - Voir un ticket


GET  /requests/{rfc_number}

Remarques

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

  • Le contenu des champs de type Memo n’est pas retourné dans les résultats des requêtes concernant les ressources principales. Pour obtenir le contenu de ces champs, vous devez utiliser une ressource spécifique que vous trouverez dans les exemples ci dessous.
  • En cas de succès, un code de statut HTTP 200 est retourné.
    • Un lien URL (HREF) vers la ressource est fourni.
    • Tous les champs sont fournis, y compris ceux de type e_field_name et available_field_x, à l’exception de certains champs sensibles réservés à EasyVista.
       

Liste des paramètres / champs

Paramètres obligatoires

Dans l'URL, vous devez utiliser le paramètre ci-dessous.
 

Paramètre Type Description / Exemple
rfc_number string Identifiant du ticket

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
fields string Sélection de champs à afficher.
  • exemple /requests/S161123_000034?fields=available_field_1,comment
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
    • /requests/S161123_000034?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /requests/S161123_000034?fields=last_updatet&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"
}
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"
}

Exemples

Résultat avec un code de statut retourné 200

{
 "HREF": "https://{your_server}/api/v1/{your_account}/requests/S161123_000034",
 "ANALYTICAL_CHARGE_PATH": "",
 "AVAILABLE_FIELD_1": "",
 "AVAILABLE_FIELD_2": "",
 "AVAILABLE_FIELD_3": "",
 "AVAILABLE_FIELD_4": "",
 "AVAILABLE_FIELD_5": "",
 "AVAILABLE_FIELD_6": "",
 "BUDGET_EFFECTIVE": "",
 "BUDGET_ID": "",
 "BUDGET_PLANNED": "",
 "CAN_BE_DUPLICATED": "0",
 "CLICK_2_GET_INSTALL_RESULT": "",
 "COMMENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/comment/S161123_000034"
  },
 "CREATION_DATE_UT": "2016-11-23T20:19:22.117Z",
 "DELAY": "",
 "DEPARTMENT_PATH": "",
 "DESCRIPTION": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/description/S161123_000034"
  },
 "DYNAMIC_DETAILS": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/dynamic_details/S161123_000034"
  },
 "EFFECTIVE_CHANGE_DATE_END": "",
 "EFFECTIVE_CHANGE_DATE_START": "",
 "END_DATE_UT": "",
 "ESTIMATED_NET_PRICE": "",
 "ESTIMATED_PERCENT_COMPLETE": "",
 "EXPECTED_DATE_UT": "",
 "EXPECTED_DURATION": "",
 "EXPECTED_END_DATE_UT": "",
 "EXPECTED_START_DATE_UT": "",
 "EXTERNAL_REFERENCE": "",
 "FIRST_CALL_RESOLUTION": "0",
 "HOUR_PER_DAY": "",
 "IMPUTATION_DATE": "",
 "INITIAL_SD_CATALOG_PATH": "",
 "IS_FINANCIAL_COMPTED": "1",
 "IS_MAJOR_INCIDENT": "",
 "IS_TEMPLATE": "0",
 "KNOWN_PROBLEMS_PATH": "",
 "LAST_UPDATE": "2016-11-23T20:19:22.200Z",
 "LOCATION_PATH": "Europe/United Kingdom",
 "MARK_1": "",
 "MARK_2": "",
 "MAX_RESOLUTION_DATE_UT": "",
 "MS_PROJECT_IMPORT_VALIDATION_WAITING": "0",
 "NET_PRICE": "0.00",
 "NOT_DEDUCED_CALL": "",
 "ORDER_NET_PRICE": "",
 "PLANNED_CHANGE_DATE_END": "",
 "PLANNED_CHANGE_DATE_START": "",
 "PROJECT_NAME": "",
 "PROJECT_START_DATE_UT": "",
 "QTY": "",
 "RENTAL_NET_PRICE": "0.00",
 "REQUALIFICATION_PROCESSING": "0",
 "REQUEST_ID": "61320",
 "REQUESTED_CHANGE_DATE_END": "",
 "REQUESTED_CHANGE_DATE_START": "",
 "REQUESTOR_FEEDBACK": "",
 "REQUESTOR_IP_ADDRESS": "176.34.179.238",
 "REQUESTOR_PHONE": "",
 "RFC_NUMBER": "S161123_000034",
 "RISK_AMOUNT": "",
 "RISK_DESCRIPTION": {
   "HREF": "https://{your_server}/api/v1/{your_account}/requests/risk_description/S161123_000034"
  },
 "SD_CATALOG_PATH": "Service Request/Other request/(evApps test) questionnaire",
 "SUBMIT_DATE_UT": "2016-11-23T20:19:22.117Z",
 "TIME_USED_TO_DELIVER_FEEDBACK": "",
 "TIME_USED_TO_SOLVE_REQUEST": "",
 "VALIDATION_LEVEL_REQUIRED": "",
 "WAVE_ID_TARGET": "",
 "RECIPIENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/18520",
   "BEGIN_OF_CONTRACT": "2014-07-21T00:00:00.000Z",
   "CELLULAR_NUMBER": " -",
   "DEPARTMENT_PATH": "",
   "E_MAIL": "argointegrationtests@easyvista.com",
   "LAST_NAME": "Argo Integration Tests",
   "LOCATION_PATH": "Europe/United Kingdom",
   "PHONE_NUMBER": " -"
  },
 "REQUESTOR": {
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/18520",
   "BEGIN_OF_CONTRACT": "2014-07-21T00:00:00.000Z",
   "CELLULAR_NUMBER": " -",
   "DEPARTMENT_PATH": "",
   "E_MAIL": "argointegrationtests@easyvista.com",
   "LAST_NAME": "Argo Integration Tests",
   "LOCATION_PATH": "Europe/United Kingdom",
   "PHONE_NUMBER": " -"
  },
 "LOCATION": {
   "HREF": "https://{your_server}/api/v1/{your_account}/locations/92",
   "CITY": "",
   "LOCATION_CODE": "",
   "LOCATION_EN": "United Kingdom",
   "LOCATION_PATH": "Europe/United Kingdom"
  },
 "DEPARTMENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/departments/5",
   "DEPARTMENT_CODE": "",
   "DEPARTMENT_EN": "-",
   "DEPARTMENT_PATH": "",
   "DEPARTMENT_LABEL": ""
  },
 "STATUS": {
   "HREF": "https://{your_server}/api/v1/{your_account}/status/12",
   "STATUS_EN": "In progress",
   "STATUS_GUID": "{6E554FC1-1A5D-47E4-B303-CD98A8767AEC}"
  }
}


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 2020/07/17 19:53
Créé par Administrator XWiki le 2017/04/07 12:02

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Powered by XWiki ©, EasyVista 2021