REST API - View a list of locations

Contents

Notes
List of parameters / fields
HTTP status codes for the method
Example
- Result for 3 locations (status code 200)
REST API Conventions

GET /locations

This method allows a list of locations to be obtained.

To obtain detailed information about a specified location: GET /locations/{location_id}. 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 /locations?max_rows=5
	sort	string	Sort in ascending or descending order. Syntax: field1[+asc\|+desc],field2[+asc\|+desc],fieldn[+asc\|+desc] example /locations?sort=location_fr+desc
	fields	string	SSelect fields to display. example /locations?fields=location_en,g_map_lat,g_map_lng
	search	string	Search/filter the specified fields. See Description of the options. example /locations?search=level:"3" A search on a Date field is also possible. example /locations?search=last_integration:this_month
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 /locations?search=status_id:1,status_id:2 ==> all the locations in which the status is equal to 1 or 2
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 >. /locations?search=location_en~"Bos" ==> all the locations in which the location_en* field begins with Bos /locations?search=location_en~"Bos" ==> all the locations in which the location_en field contains Bos
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 /locations?search=location_en!~"Bos" ==> all the locations by excluding those in which the location_en* field begins with Bos /locations?search=location_en!~"Bos" ==> all the locations by excluding those in which the location_en field contains Bos
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 /locations?search=location_en!"Boston" ==> all the locations by excluding those in which the location_en field is equal to Boston
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 /locations?search=city:"is_null" ==> all the locations in which the city has no value
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 /locations?search=city:"is_not_null" ==> all the locations in which the city has a value
Oxygen 1.7 - Build 2018.1.131.0	formatDate	string	Format display of Date fields in the HTTP request result. See Description of the options. example /locations?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018" /locations?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"

Optional fields

You can use all the fields from the AM_LOCATION table in the body of the HTTP request except those mentioned below.

NotAuthorizedOptionalFields_Location

label_color ; label_font ; label_size
property_color ; property_font ; property_size
date_format_id
xpos ; ypos ; zpos
lft ; rgt ; level
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 Service Manager account.

example

{
"error": "Invalid Login / Password"
}

Example

Result for 3 locations (status code 200)

"HREF": "https://{your_server}/api/v1/{your_account}/locations?max_rows=3",
   "record_count": "3",
   "total_record_count": "805",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/locations/63",
           "CITY": "",
           "LOCATION_CODE": "",
           "LOCATION_FR": "France",
           "LOCATION_PATH": "Europe/France",
           "LOCATION_ID": "63"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/locations/65",
           "CITY": "Nice",
           "LOCATION_CODE": "",
           "LOCATION_FR": "Nice",
           "LOCATION_PATH": "Europe/France/Nice",
           "LOCATION_ID": "65"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/locations/66",
           "CITY": "Paris",
           "LOCATION_CODE": "",
           "LOCATION_FR": "Paris",
           "LOCATION_PATH": "Europe/France/Paris",
           "LOCATION_ID": "66"
        }
    ]

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/2019 12:12:12", } }
Green		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:

Last modified by Unknown User on 2021/04/20 15:36

Created by Administrator XWiki on 2017/12/21 08:52