REST API - View a location


GET  /locations/{location_id}

  • This method allows information about a specified location to be obtained.
           Example documentation icon EN.png  /locations/7

Notes

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

List of parameters / objects

Mandatory parameters

You must use the JSON object below in the body of the HTTP request.
 

Objet Type Description / Example
location_id integer location identifier

Optional parameters

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

Objet Type Description / Example
fields string Select fields to display.
  • Example documentation icon EN.png /locations/7?fields=location_en,g_map_lat,g_map_lng

Fields that could be used in optional parameters

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

NotAuthorized_OptionalParametersFields_Location
  • label_color ; label_font ; label_size 
  • property_color ; property_font ; property_size 
  • date_format_id 
  • xpos ; ypos ; zpos 
  • lft ; rgt 
  • path_to_compute

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"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.
Example documentation icon EN.png
{
 "error": "Resource not found"
}

Example

Result with a status code 200 returned

{
   "HREF": "http://{your_server}/api/v1/{your_account}/locations/7",
   "AVAILABLE_FIELD_1": "",
   "AVAILABLE_FIELD_2": "",
   "AVAILABLE_FIELD_3": "",
   "AVAILABLE_FIELD_4": "",
   "AVAILABLE_FIELD_5": "",
   "AVAILABLE_FIELD_6": "",
   "CITY": "",
   "COMMENT_LOCATION": {
       "HREF": "http://{your_server}/api/v1/{your_account}/locations/7/"
    },
   "COUNTRY_ID": "1",
   "DISCOVERY_NAME": "",
   "E_CAPACITY": "",
   "E_IS_MEETING_ROOM": "",
   "E_WIFI_LOGIN": "",
   "END_DATE": "",
   "FAX": "",
   "G_MAP_LAT": "37.09024",
   "G_MAP_LNG": "-95.712891",
   "IS_DELIVERY_ADDRESS": "0",
   "LAST_INTEGRATION": "2015-02-26",
   "LAST_UPDATE": "2017-03-21",
   "LEVEL": "3",
   "LOCATION_CODE": "",
   "LOCATION_EN": "USA",
   "LOCATION_FR": "USA",
   "LOCATION_GE": "USA",
   "LOCATION_PATH": "North America/USA",
   "LOCATION_ID": "7",
   "LOCATION_IT": "USA",
   "LOCATION_L1": "",
   "LOCATION_L2": "",
   "LOCATION_L3": "",
   "LOCATION_L4": "",
   "LOCATION_L5": "",
   "LOCATION_L6": "",
   "LOCATION_PO": "USA",
   "LOCATION_SP": "USA",
   "MANAGER_ID": "",
   "PARENT_LOCATION_PATH": "",
   "PARENT_LOCATION_ID": "6",
   "PHONE": "",
   "REGION_ZONE_ID": "",
   "SLA_ID": "",
   "START_DATE": "",
   "STATE_ID": "",
   "STATUS_ID": "",
   "STREET_ADDRESS_1": "",
   "STREET_ADDRESS_2": "",
   "TIME_ZONE_ID": "14",
   "URL_MAP": "/public/MapLib/Countries/USA.jpg",
   "ZIP_CODE": ""
}


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:50
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