REST API - View a list of manufacturers


GET  /manufacturers

  • To obtain detailed information about a specified manufacturer: GET /manufacturers/{manufacturer_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.
    • 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 /manufacturers?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /manufacturers?sort=manufacturer+asc
fields string Select fields to display.
  • example /manufacturers?fields=manufacturer
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /manufacturers?search=manufacturer"*lat*"
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
    • /manufacturers?search=manufacturer:Kalatel,manufacturer:Latitude ==> all the manufacturers in which the manufacturer field is equal to Kalatel or Latitude
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
    • /manufacturers?search=manufacturer~"lat*" ==> all the manufacturers in which the manufacturer field begins with lat
    • /manufacturers?search=manufacturer~"*lat*" ==> all the manufacturers in which the manufacturer field contains lat
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
    • /manufacturers?search=manufacturer!~"lat*" ==> all the manufacturers by excluding those in which the manufacturer field begins with lat
    • /manufacturers?search=manufacturer!~"*lat*" ==> all the manufacturers by excluding those in which the manufacturer field contains lat
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 /manufacturers?search=manufacturer!"Kalatel" ==> all the manufacturers by excluding those in which the manufacturer field is equal to Kalatel
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
    • /manufacturers?search=discovery_name:"is_null" ==> all the manufacturers in which discovery_name 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
    • /manufacturers?search=discovery_name:"is_not_null" ==> all the manufacturers in which discovery_name has a value

Fields that could be used in optional parameters

You can use all the fields from the AM_MANUFACTURER table.

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

{
 "HREF": "https://{your_server}/api/v1/{your_account}/manufacturers?search=manufacturer~%22%2Alat%2A%22",
 "record_count": "2",
 "total_record_count": "2",
 "records": [
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/manufacturers/401",
     "DISCOVERY_NAME": "",
     "MANUFACTURER": "Platinum Technology "
    },
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/manufacturers/786",
     "DISCOVERY_NAME": "",
     "MANUFACTURER": "Kalatel"
    }
  ]
}


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",  }  }
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/02/05 15:54
Created by Administrator XWiki on 2017/12/21 08:49

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021