REST API - Voir une localisation


GET  /locations/{location_id}

  • Cette méthode permet d’obtenir des informations concernant une localisation déterminée.
           exemple    /locations/7

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é.
    • 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
location_id integer Identifiant de la localisation

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 /locations/7?fields=location_en,g_map_lat,g_map_lng
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
    • /locations/7?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /locations/7?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_LOCATION sauf ceux indiqués ci-dessous.

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

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

Exemple

Résultat avec un code de statut retourné 200

{
   "HREF": "http://{your_server}/api/v1/{your_account}/locations/7",
   "AVAILABLE_FIELD_1": "",
   "AVAILABLE_FIELD_2": "",
   "AVAILABLE_FIELD_3": "",
   "AVAILABLE_FIELD_4": "",
   "AVAILABLE_FIELD_5": "",
   "AVAILABLE_FIELD_6": "",
   "CITY": "",
   "COMMENT_LOCATION": {
       "HREF": "http://{your_server}/api/v1/{your_account}/locations/7/"
    },
   "COUNTRY_ID": "1",
   "DISCOVERY_NAME": "",
   "E_CAPACITY": "",
   "E_IS_MEETING_ROOM": "",
   "E_WIFI_LOGIN": "",
   "END_DATE": "",
   "FAX": "",
   "G_MAP_LAT": "37.09024",
   "G_MAP_LNG": "-95.712891",
   "IS_DELIVERY_ADDRESS": "0",
   "LAST_INTEGRATION": "2015-02-26",
   "LAST_UPDATE": "2017-03-21",
   "LEVEL": "3",
   "LOCATION_CODE": "",
   "LOCATION_EN": "USA",
   "LOCATION_FR": "USA",
   "LOCATION_GE": "USA",
   "LOCATION_PATH": "North America/USA",
   "LOCATION_ID": "7",
   "LOCATION_IT": "USA",
   "LOCATION_L1": "",
   "LOCATION_L2": "",
   "LOCATION_L3": "",
   "LOCATION_L4": "",
   "LOCATION_L5": "",
   "LOCATION_L6": "",
   "LOCATION_PO": "USA",
   "LOCATION_SP": "USA",
   "MANAGER_ID": "",
   "PARENT_LOCATION_PATH": "",
   "PARENT_LOCATION_ID": "6",
   "PHONE": "",
   "REGION_ZONE_ID": "",
   "SLA_ID": "",
   "START_DATE": "",
   "STATE_ID": "",
   "STATUS_ID": "",
   "STREET_ADDRESS_1": "",
   "STREET_ADDRESS_2": "",
   "TIME_ZONE_ID": "14",
   "URL_MAP": "/public/MapLib/Countries/USA.jpg",
   "ZIP_CODE": ""
}


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/04/20 15:35
Créé par Administrator XWiki le 2017/12/21 08:52

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Powered by XWiki ©, EasyVista 2021