REST API - Update an employee


PUT  /employees/{employee_id}

  • This method allows a specified employee to be modified.
             example   /assets/9477

Notes

      Open url.png  See Service Manager REST API Conventions.

  • You must supply a table in JSON format in the body of the HTTP request.
  • If successful, an HTTP status code 201 is returned and a URL link (HREF) to the updated resource is provided.
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".

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

    example  field_name, Field_Name and FIELD_NAME are equivalent

List of parameters / fields

Mandatory parameters

  • You must use the parameter below in the URL.
  • You must use at least one of the optional fields in the body of the HTTP request. Otherwise an error is returned.
     
Parameter Type Description / Example
employee_id integer Employee identifier

Optional parameters

None

Optional fields

  • You can use all the fields from the AM_EMPLOYEE table except those mentioned below in the body of the HTTP request.
    • 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 ( * )
    • location_code ; location_path
    • department_code ; department_path
    • e_mail
( * ) Note: Since the Service Manager Autumn 2020 - Build 2021.1.113.0, you can use the profil_id field in the body of the HTTP request only if the logged-in user profile is the master profile of the profile to assign (addition of a level of security) and you use another field in addition of the profil_id field.
  • In addition to the fields provided by EasyVista, you can also assign values to the fields which you have added to the Service Manager database. These are fields with the prefix e_.
             example  e_field_name_xyz

HTTP status codes for the method

StatusHeader
Code Error Description
Status201
201 Created Request processed successfully and an item created.
Status401
401 Unauthorized Authentication process for accessing the resource is incorrect: Login/Password incorrect, Invalid session, Incorrect Service Manager account.

example

{
 "error": "Invalid Login / Password"
}
Status405
405 Method not allowed Request method not authorized: not supported or not appropriate for the resource.

example

{
 "error": "Invalid input parameter"
}

Examples

Example of the body of an HTTP request

{
    "identification": "132456",
    "last_name": "Zama, Bart",
    "begin_of_contract": "21/01/2018"
}

Result with a status code 201 returned

{
 "HREF": "https://{your_server}/api/v1/{your_account}/employees/9477"
}


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

Tags:
Last modified by Unknown User on 2021/11/15 10:03
Created by Administrator XWiki on 2017/04/07 12:01

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021