Web services REST - Références API - Conventions et Paramètres optionnels communs


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

Notes communes sur le format JSON et le format des champs

CommonNotes_JSONandFields

Format JSON / Format des champs :

  • Les noms de champs sont ceux du modèle de données Service Manager.

    exemple  available_field_1

  • Pour mettre à jour un champ, respectez le format JSON suivant : "field_name":"value".

    exemple  "e_mail": "test@easyvista.com"

  • Les noms d’objets JSON, y compris ceux représentant les champs de la base Service Manager, ne sont pas sensibles à la casse.

    exemple  field_name, Field_Name et FIELD_NAME sont équivalents

EndCommonNotes_JSONandFields

Méthodes Créer, Modifier un employé : Paramètres / Champs optionnels non autorisés

NotAuthorized_OptionalParametersFields_Employee
  • passwd 
  • salt 
  • chat_passwd 
  • parameters ; parameters_2 ; local_parameters 
  • clickview_access ; named_access 
  • default_domain_id 
  • dft_application_perimeter_id
  • id_1 ; id_2 
  • jid 
  • profil_id
  • login
  • location_code ; location_path
  • department_code ; department_path
EndNotAuthorized_OptionalParametersFields_Employee

Méthodes Voir une liste de localisations / une localisation : Champs pour les paramètres optionnels non autorisés

NotAuthorized_OptionalParametersFields_Location
  • label_color ; label_font ; label_size 
  • property_color ; property_font ; property_size 
  • date_format_id 
  • xpos ; ypos ; zpos 
  • lft ; rgt 
  • path_to_compute 
EndNotAuthorized_OptionalParametersFields_Location

Méthodes Voir une entrée au catalogue des biens / tickets : Champs pour les paramètres optionnels non autorisés

NotAuthorized_OptionalParametersFields_Catalog
  • lft ; rgt 
  • level 
  • big_picture_path 
  • default_root_cause_id 
  • forms_id 
  • workflow_id ; closing_workflow_id ; immediate_workflow_id 
  • manager_id 
  • request_asset_tag 
  • move_service 
  • path_to_compute 
  • sd_catalog_id_for_caddy 
  • category_id
  • click_2_get_software_package_id 
  • click_2_get_button_label_*
EndNotAuthorized_OptionalParametersFields_Catalog
Tags:
Modifié par Utilisateur inconnu le 2020/06/22 15:40
Créé par Administrator XWiki le 2017/01/02 12:12

Raccourcis

L'actualité mensuelle
•  Newsletter

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

Glossaire

Powered by XWiki ©, EasyVista 2020