REST API - Voir un fournisseur

Modifié le 23/01/2023 11:06

Version minimum Service Manager : Oxygène 2022 - Build 2022.1.133.0.01

GET  /suppliers/{supplier_id}

  • Cette méthode permet d’obtenir des informations concernant un fournisseur déterminée.
         exemple /suppliers/56

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
supplier_id number Identifiant du fournisseur

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 /suppliers/56?fields=address1,address2
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
    • /suppliers/56?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /suppliers/56?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

Aucun

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.
Status400
400 Bad Request (Mauvaise requête) Requête formulée de façon incorrecte, qui ne peut pas être exécutée correctement.

exemple

{
 "error": "Nothing to update (check fieldnames)"
}

ou si l'appel REST "Suspendre un ticket" avec comme réponse: { "error": "The request is already suspended. Operation aborted."} quand le ticket est déjà suspendu.

ou si l'appel REST "Reprendre un ticket" avec comme réponse: { "error": "The request is not suspended. Operation aborted."} quand le ticket n'a pas été encore suspendu.

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}/suppliers/56",
   "ADDRESS_1": "1501 api create supplier",
   "ADDRESS_2": "",
   "AVAILABLE_FIELD_1": "",
   "AVAILABLE_FIELD_2": "",
   "AVAILABLE_FIELD_3": "",
   "AVAILABLE_FIELD_4": "",
   "AVAILABLE_FIELD_5": "",
   "AVAILABLE_FIELD_6": "",
   "CITY": "",
   "COMMENT_SUPPLIER": {
       "HREF": "https://{your_server}/api/v1/{your_account}/56/comment_supplier"
    },
   "COUNTRY_ID": "",
   "CURRENCY_ID": "",
   "DISCOUNT_RATE": "",
   "E_MAIL": "testapi@create.com",
   "FAX": "",
   "LOCATION_PATH": "",
   "LOCATION_ID": "6",
   "MAIN_PHONE": "",
   "PHONE": "",
   "SUPPLIER": "API create",
   "SUPPLIER_BEGIN_OF_CONTRACT": "",
   "SUPPLIER_END_OF_CONTRACT": "",
   "SUPPLIER_PATH": "API create",
   "SUPPLIER_ID": "56",
   "SUPPLIER_TYPE_ID": "",
   "WEB_SITE": "",
   "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 :
Powered by XWiki © EasyVista 2024