REST API - View a list of employees

Last modified on 2023/01/20 15:11
Contents

GET  /employees

  • This method allows a list of employees to be obtained.
  • To obtain detailed information for a specified employee: GET /employees/{employee_id}. Open url.png See the method.

Notes

       Open url.png  See Service Manager REST API Conventions.

  • If successful, an HTTP status code 200 is returned.
    • By default, if the optional parameter fields is not used, only an extract of the most useful fields selected by EasyVista is displayed for each record provided.
    • A URL link (HREF) to each resource is provided so that the complete list of fields for a record can be obtained.

List of parameters / fields

Mandatory parameters

None

Optional parameters

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

Minimum version Parameter Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • example /employees?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /employees?sort=begin_of_contract+desc
fields string Select fields to display.
  • example /employees?fields=last_name, begin_of_contract,department_id, e_mail,location_id
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /employees?search=e_mail:"FSDM@itassetservice.com"

A search on the Date field is also possible.

  • example /employees?search=begin_of_contract:last_week
Oxygen 2.1.2 - Build 2018.1.183.0 search

(logical OR operator)

 string Search/filter to several values from a same field
  • Syntax: search=field:value1,field:value2
  • example
    • /employees?search=department_id:47,department_id:48 ==> all the employees in which the department_id field is equal to 47 or 48
Oxygène 1.7 - Build 2018.1.131.0 ~

(equivalent to like)

 string Include the results which begin with or contain a given character string.
  • Syntax: ~ following by the string to include enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = include what begins with < string >.
    • *< string >* = include what contains < string >.
  • example
    • /employees?search=last_name~"Lewis*" ==> all the employees in which the last_name field begins with Lewis
    • /employees?search=last_name~"*Lewis*" ==> all the employees in which the last_name field contains Lewis
Oxygen 1.7 - Build 2018.1.131.0 !~

(equivalent to not like)

 string Exclude the results which begin with or contain a given character string.
  • Syntax: !~ following by the string to exclude enclosed in quotation marks.
  • You should use the wildcard character *.
    • < string >* = exclude what begins with < string >.
    • *< string >* = exclude what contains < string >.
  • example
    • /employees?search=last_name!~"Lewis*" ==> all the employees by excluding those in which the last_name field begins with Lewis
    • /employees?search=last_name!~"*Lewis*" ==> all the employees by excluding those in which the last_name field contains Lewis
Oxygen 1.7 - Build 2018.1.131.0 !

(equivalent to not)

 string Exclude all results equal to a given character string.
  • Syntax: ! following by the string to exclude enclosed in quotation marks.
  • example /employees?search=last_name!"Lewis, Fabienne" ==> all the employees by excluding those in which the last_name field is equal to Lewis, Fabienne
Oxygen 2.1.2 - Build 2018.1.183.0 is_null string Retrieve all results in which the field has no value (field value = null)
  • Syntax: Field name following by "is_null"
  • example
    • /employees?search=end_of_contract:"is_null"&sort=employee_id+asc ==> all the employees in which the end of contract date has no value, sorted in ascending identifier
Oxygen 2.1.2 - Build 2018.1.183.0 is_not_null string Retrieve all results in which the field has a value (field value = not null)
  • Syntax: Field name following by "is_not_null"
  • example
    • /employees?search=end_of_contract:"is_not_null"&sort=employee_id+asc ==> all the employees in which the end of contract date has a value, sorted in ascending identifier
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?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /employees?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 
    • jid 
    • location_code ; location_path
    • department_code ; department_path

HTTP status codes for the method

StatusHeader

Note: 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 (Success) Request processed successfully.
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"
}

Example

Result for 3 employees (status code 200)

{
   "HREF": "https://{your_server}/api/v1/{your_account}/employees?max_rows=3",
   "record_count": "3",
   "total_record_count": "765",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/employees/10105",
           "BEGIN_OF_CONTRACT": "1997-09-21",
           "CELLULAR_NUMBER": "787-760-337",
           "DEPARTMENT_PATH": "DSI/Support",
           "DEPARTMENT_ID": "47",
           "E_MAIL": "lewis@evtry.com",
           "EMPLOYEE_ID": "10105",
           "LAST_NAME": "Lewis, Fabienne",
           "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/111",
           "LOCATION_ID": "1530",
           "PHONE_NUMBER": "+33155859638",
           "LOCATION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/locations/1530",
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "111",
               "LOCATION_PATH": "Europe/France/Paris/Champs Elysées/111",
               "LOCATION_ID": "1530"
            },
           "DEPARTMENT": {
               "HREF": "https://{your_server}/api/v1/{your_account}/departments/47",
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Support",
               "DEPARTMENT_PATH": "DSI/Support",
               "DEPARTMENT_ID": "47",
               "DEPARTMENT_LABEL": ""
            },
           "MANAGER": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            }
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/employees80/10269",
           "BEGIN_OF_CONTRACT": "1985-04-06",
           "CELLULAR_NUMBER": "781-164-091",
           "DEPARTMENT_PATH": "Ventes/Direct/Agriculture",
           "DEPARTMENT_ID": "18",
           "E_MAIL": "narp@evtry.com",
           "EMPLOYEE_ID": "10269",
           "LAST_NAME": "Arp, Naomi",
           "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1706",
           "LOCATION_ID": "2203",
           "PHONE_NUMBER": "+33155859738",
           "LOCATION": {
               "HREF": "https://{your_server}/api/v1/{your_account}/locations/2203",
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "1706",
               "LOCATION_PATH": "Europe/France/Strasbourg/Bat.1/Etage 17/1706",
               "LOCATION_ID": "2203"
            },
           "DEPARTMENT": {
               "HREF": "https://{your_server}/api/v1/{your_account}/departments/18",
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Agriculture",
               "DEPARTMENT_PATH": "Ventes/Direct/Agriculture",
               "DEPARTMENT_ID": "18",
               "DEPARTMENT_LABEL": ""
            },
           "MANAGER": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            }
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/employees/10270",
           "BEGIN_OF_CONTRACT": "1985-03-09",
           "CELLULAR_NUMBER": "787-720-447",
           "DEPARTMENT_PATH": "Ventes/Direct/Support client",
           "DEPARTMENT_ID": "22",
           "E_MAIL": "oarrieu@evtry.com",
           "EMPLOYEE_ID": "10270",
           "LAST_NAME": "Arrieu, Oscar",
           "LOCATION_PATH": "Europe/France/Limoges/Bat.1/Etage 16/1642",
           "LOCATION_ID": "2194",
           "PHONE_NUMBER": "+33155859356",
           "LOCATION": {
               "HREF": "https:// {your_server}/api/v1/{your_account}/locations/2194",
               "CITY": "",
               "LOCATION_CODE": "",
               "LOCATION_FR": "1642",
               "LOCATION_PATH": "Europe/France/Limoges/Bat.1/Etage 16/1642",
               "LOCATION_ID": "2194"
            },
           "DEPARTMENT": {
               "HREF": "https://{your_server}/api/v1/{your_account}/departments/22",
               "DEPARTMENT_CODE": "",
               "DEPARTMENT_FR": "Support client",
               "DEPARTMENT_PATH": "Ventes/Direct/Support client",
               "DEPARTMENT_ID": "22",
               "DEPARTMENT_LABEL": ""
            },
           "MANAGER": {
               "BEGIN_OF_CONTRACT": "",
               "CELLULAR_NUMBER": "",
               "DEPARTMENT_PATH": "",
               "E_MAIL": "",
               "EMPLOYEE_ID": "",
               "LAST_NAME": "",
               "LOCATION_PATH": "",
               "PHONE_NUMBER": ""
            }
        }
    ]
}
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