REST API - View a list of employees


GET  /employees

  • This method allows a list of employees to be obtained.
  • To obtain detailed information about a specified employee: GET /employees/{id}  -  Open url.png method View an employee

Notes

      Open url.png  see Product name - ev itsm.png 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 Logo - EasyVista.png 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 if required.

List of parameters / objects

Mandatory parameters

None

Optional parameters

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

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

A search on the Date field is also possible.

  • Example documentation icon EN.png /employees?search=begin_of_contract:last_week

Fields that could be used in optional parameters

You can use all the JSON fields from the AM_EMPLOYEE table except those mentioned below.

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

HTTP status codes for the method

StatusHeader
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 Product name - ev itsm.png account.
Example documentation icon EN.png
{
 "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 (URL) which do not correspond to Product name - ev itsm.png database fields.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields; they allow the value of a database field to be assigned or modified.
Example documentation icon EN.png   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 Product name - ev itsm.png database fields.
Example documentation icon EN.png   Method Reopen an incident/request

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

Tags:
Last modified by Unknown User on 2018/10/29 11:34
Created by Administrator XWiki on 2017/04/07 12:00

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018