REST API - View a list of suppliers

Last modified on 2023/01/23 11:06

Minimum version Service Manager: Oxygen 2022 - Build 2022.1.133.0.01

GET  /suppliers

  • This method allows a list of suppliers to be obtained.
  • To obtain detailed information for a specified supplier: GET /suppliers/{supplier_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.
    • 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 /suppliers?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /suppliers?sort=supplier+asc
fields string Select fields to display.
  • example /suppliers?fields=supplier
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /suppliers?search=supplier"*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
    • /suppliers?search=supplier:HP,supplier:DELL ==> all the suppliers in which the supplier field is equal to HP or DELL
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
    • /suppliers?search=supplier~"lat*" ==> all the suppliers in which the supplier field begins with lat
    • /suppliers?search=supplier~"*lat*" ==> all the suppliers in which the supplier 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
    • /suppliers?search=supplier!~"lat* ==> all the suppliers by excluding those in which the supplier field begins with lat
    • /suppliers?search=supplier!~"lat*" ==> all the suppliers by excluding those in which the supplier 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 /suppliers?search=supplier!"HP" ==> all the suppliers by excluding those in which the supplier field is equal to HP
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
    • /suppliers?search=supplier:"is_null" ==> all the suppliers in which the supplier field 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
    • /suppliers?search=supplier:"is_not_null" ==> all the suppliers in which the supplier field has a value
Oxygen 1.7 - Build 2018.1.131.0 formatDate string Format display of Date fields in the HTTP request result.   Open url.png See Description of the options.
  • example
    • /suppliers?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /suppliers?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"

HTTP status codes for the method

StatusHeader

Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).

Code Error Description
Status400
400 Bad Request Request formulated incorrectly and cannot be executed correctly.

example

{
 "error": "Nothing to update (check fieldnames)"
}

or for the REST call "Suspend a ticket" with the Response Content: { "error": "The request is already suspended. Operation aborted."} when a ticket is already suspended.

or for the REST call "Reopen a ticket" with the Response Content: { "error": "The request is not suspended. Operation aborted."} when a ticket is not suspended.

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

{
   "HREF": "https://{your_server}/api/v1/{your_account}/suppliers?max_rows=5",
   "record_count": "5",
   "total_record_count": "54",
   "records": [
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/suppliers/1",
           "SUPPLIER": "HP",
           "SUPPLIER_PATH": "HP",
           "SUPPLIER_ID": "1"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/suppliers/2",
           "SUPPLIER": "GE Capital",
           "SUPPLIER_PATH": "GE Capital",
           "SUPPLIER_ID": "2"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/suppliers/3",
           "SUPPLIER": "AT&T",
           "SUPPLIER_PATH": "AT&T",
           "SUPPLIER_ID": "3"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/suppliers/4",
           "SUPPLIER": "Verizon",
           "SUPPLIER_PATH": "Verizon",
           "SUPPLIER_ID": "4"
        },
        {
           "HREF": "https://{your_server}/api/v1/{your_account}/suppliers/5",
           "SUPPLIER": "Webex",
           "SUPPLIER_PATH": "Cisco/Webex",
           "SUPPLIER_ID": "5"
        }
    ]
}
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/2016 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:
Powered by XWiki © EasyVista 2022