WebService REST - API references - Conventions and Common Optional parameters


ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string which do not correspond to Service Manager database fields.

example   Method View a list of assets


https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag

Black and Bold Parameters used in the URL of an HTTP request which correspond to Service Manager database fields.

example   Method View an asset


https://{your_server}/api/v1/{your_account}/assets/{asset_id}

Green Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified.

example   Method Close an incident/request

{  "closed": {  "end_date": "11/20/2019 12:12:12",  }  }
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.

example   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }
EndConventionsAPI

Notes on the JSON format and the field format

CommonNotes_JSONandFields

JSON Format / Field Format:

  • The field names are those of the Service Manager.data model.

    example  available_field_1

  • To update a field, respect the following JSON format: "field_name":"value".

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

  • JSON object names, including those representing Service Manager database fields, are not case sensitive.

    example  field_name, Field_Name and FIELD_NAME are equivalent

EndCommonNotes_JSONandFields

Create, Update, See an employee methods: Optional parameters / Fields not authorized

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 
  • login
  • profil_id
  • location_code ; location_path
  • department_code ; department_path
EndNotAuthorized_OptionalParametersFields_Employee

See a list of locations / a location methods: Optional parameters fields not authorized

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

Methods See an asset / incident / request catalog entry: Optional parameters fields not authorized

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:
Last modified by Unknown User on 2020/06/22 15:41
Created by Administrator XWiki on 2017/01/02 12:12

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020