REST API - View a list of departments


GET  /departments

  • This method allows a list of departments to be obtained.
  • To obtain detailed information about a specified department: GET /departments/{department_id}  -  Open url.png method View a department

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.
 

Objet Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • Example documentation icon EN.png /departments?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 /departments?sort=start_date+desc
fields string SSelect fields to display.
  • Example documentation icon EN.png /departments?fields=department_en,department_label,start_date,end_date
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • Example documentation icon EN.png /departments?search=parent_department_path:"IT"

A search on a Date field is also possible.

  • Example documentation icon EN.png /departments?search=end_date:this_month

Fields that could be used in optional parameters

You can use all the JSON fields from the AM_DEPARTMENT.

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 departments (status code 200)

{
   "HREF": "http://{your_server}/api/v1/{your_account}/departments?max_rows=3",
   "record_count": "3",
   "total_record_count": "69",
   "records": [
        {
           "HREF": "http://{your_server}/api/v1/{your_account}/departments/5",
           "DEPARTMENT_CODE": "",
           "DEPARTMENT_EN": "-",
           "DEPARTMENT_PATH": "",
           "DEPARTMENT_ID": "5",
           "DEPARTMENT_LABEL": ""
        },
        {
           "HREF": "http://{your_server}/api/v1/{your_account}/departments/6",
           "DEPARTMENT_CODE": "",
           "DEPARTMENT_EN": "Sales",
           "DEPARTMENT_PATH": "Sales",
           "DEPARTMENT_ID": "6",
           "DEPARTMENT_LABEL": ""
        },
        {
           "HREF": "http://{your_server}/api/v1/{your_account}/departments/7",
           "DEPARTMENT_CODE": "",
           "DEPARTMENT_EN": "International USA",
           "DEPARTMENT_PATH": "Sales/Export",
           "DEPARTMENT_ID": "7",
           "DEPARTMENT_LABEL": ""
      }
    ]
}


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/24 14:49
Created by Administrator XWiki on 2017/12/21 08:52

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