REST API - View an employee

Last modified on 2023/03/28 13:06
Contents

GET  /employees/{employee_id}

  • This method allows information for a specified employee to be obtained.
          example   /employees/9477

Notes

      Open url.png  See Service Manager REST API Conventions.

  • If successful, an HTTP status code 200 is returned:
    • A URL link (HREF) to the resource is provided.
    • All fields are provided, including e_field_name and available_field_x, except for certain sensitive fields reserved for EasyVista.

List of parameters / fields

Mandatory parameters

You must use the parameter below in the URL.
 

Parameter Type Description / Example
employee_id integer Employee identifier

Optional parameters

You can use the parameters detailed below in the HTTP request string.

Minimum version Parameter Type Description / Example
fields string Select fields to display.
  • example /employees/9477?fields=last_name,e_mail
Oxygen 1.7 - Build 2018.1.131.0 formatDate string Format display of Date fields in the HTTP request result.   Open url.png See Description of the options.
  • example
    • /employees/9477?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /employees/9477?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"

Fields that could be used in optional parameters

  • You can use all the fields from the AM_EMPLOYEE table except those mentioned below.
    • passwd 
    • salt 
    • chat_passwd 
    • parameters ; parameters_2 ; local_parameters 
    • clickview_access ; named_access 
    • default_domain_id 
    • dft_application_perimeter_id
    • id_1 ; id_2 
    • location_code ; location_path
    • department_code ; department_path

HTTP status codes for the method

StatusHeader

   A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).

Code Error Description
Status200
200 OK (Successful) Request successfully processed.
Status401
401 Unauthorized Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

{
 "error": "Invalid Login / Password"
}
Status404
404 Not found Resource not found: Incorrect URI, missing resource, incorrect communication with the server, rfc_number not found.

example

{
 "error": "Resource not found"
}

Example

Result with a status code 200 returned

{
 "HREF": "https://{your_server}/api/v1/{your_account}/employees/9477",
 "APPROVED_TO_VALIDATE": "",
 "AVAILABLE_FIELD_1": "",
 "AVAILABLE_FIELD_2": "",
 "AVAILABLE_FIELD_3": "",
 "AVAILABLE_FIELD_4": "",
 "AVAILABLE_FIELD_5": "",
 "AVAILABLE_FIELD_6": "",
 "BEGIN_OF_CONTRACT": "1998-01-13T00:00:00.000Z",
 "CELLULAR_NUMBER": "780-064-340",
 "CHAT_LOGIN": "",
 "COMMENT_EMPLOYEE": {
   "HREF": "https://{your_server}/api/v1/{your_account}/employees/comment_employee/9477"
  },
 "COST_PER_HOUR": "",
 "DELEGATION_FROM": "",
 "DELEGATION_TO": "",
 "DEPARTMENT_PATH": "National Sales/Direct/Education",
 "DFT_APPLICATION_PERIMETER_PATH": "",
 "E_MAIL": "test@aef.com",
 "EMPLOYEE_ID": "9477",
 "END_OF_CONTRACT": "",
 "FAX_NUMBER": "",
 "ICQ_NUMBER": "",
 "ID_1": "",
 "ID_2": "",
 "IDENTIFICATION": "11759",
 "IMPACT": "",
 "IS_AUTOMATIC_STATUS": "1",
 "IS_SYSTEM": "",
 "IT_CORRESPONDENT": "0",
 "JID": "",
 "LAST_INTEGRATION": "2013-03-25T10:25:55.203Z",
 "LAST_NAME": "Talma, Bart",
 "LAST_UPDATE": "2016-10-03T16:10:56.600Z",
 "LOCATION_PATH": "Europe/Spain/Madrid/Calle Major/Floor 2/105",
 "LOGIN": "BTALMA",
 "MAIL_ALERT": "",
 "MESSENGER_SIGN_NAME": "",
 "PASSWD_LAST_UPDATE_UT": "2012-02-14T14:08:10.173Z",
 "PERSON_IN_CHARGE": "",
 "PHONE_NUMBER": "919191919191",
 "PICTURE_PATH": "",
 "STYLE_ID": "",
 "SUPPLIER_PATH": "",
 "TRIAL_END": "",
 "VALIDATION_LEVEL": "",
 "VIP": "",
 "WAVE_ADDRESS": "",
 "LOCATION": {
   "HREF": "https://{your_server}/api/v1/{your_account}/locations/257",
   "CITY": "",
   "LOCATION_CODE": "",
   "LOCATION_EN": "105",
   "LOCATION_PATH": "Europe/Spain/Madrid/Calle Major/Floor 2/105"
  },
 "DEPARTMENT": {
   "HREF": "https://{your_server}/api/v1/{your_account}/departments/25",
   "DEPARTMENT_CODE": "",
   "DEPARTMENT_EN": "Education",
   "DEPARTMENT_PATH": "National Sales/Direct/Education",
   "DEPARTMENT_LABEL": ""
  }
}
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/2016 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:
Powered by XWiki © EasyVista 2022