REST API - View a list of assets

Last modified on 2023/02/21 09:59
Contents

GET  /assets

  • To obtain detailed information for a specified asset: GET /assets/{asset_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 /assets?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • example /assets?sort=employee.last_name+desc
fields string Select fields to display.
  • example /assets?fields=asset_tag,serial_number,location.location_path,employee.last_name
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • example /assets?search=employee.e_mail:btalma@itassetservices.com

A search on a Date field is also possible.

  • example /assets?search=last_integration:last_week
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
    • /assets?search=employee.e_mail:morley@evtry.com,employee.e_mail:leblanc@evtry.com ==> all the assets attached to the users morley or leblanc
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
    • /assets?search=asset_tag~"Pho*" ==> all the assets in which the asset_tag field begins with Pho
    • /assets?search=asset_tag~"*Pho*" ==> all the assets in which the asset_tag field contains Pho
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
    • /assets?search=asset_tag!~"Pho*" ==> all the assets by excluding those in which the asset_tag field begins with Pho
    • /assets?search=asset_tag!~"*Pho*" ==> all the assets by excluding those in which the asset_tag field contains Pho
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 /assets?search=asset_tag!"Phoebe" ==> all the assets by excluding those in which the asset_tag field is equal to Phoebe
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
    • /assets?search=asset_tag:"is_null" ==> all the assets in which the asset_tag field has no value
    • /assets?search=asset_tag:"is_null",employee.e_mail:morley@evtry.com,&sort=asset_id+asc ==> only the assets attached to the user morley in which the asset_tag field has no value, sorted in ascending identifier
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
    • /assets?search=asset_tag:"is_not_null" ==> all the assets in which the asset_tag field has a value
    • /assets?search=asset_tag:"is_not_null",employee.e_mail:morley@evtry.com,&sort=asset_id+asc ==> only the assets attached to the user morley in which the asset_tag field has a value, sorted in ascending identifier
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
    • /assets?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /assets?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"

Fields that could be used in optional parameters

You can use all the fields from the AM_ASSET table.

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
Status200
200 OK (Successful) Request successfully processed.
Status401
401 Unauthorized Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.

example

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

Example

Result for 3 assets (status code 200)

{
 "HREF": "https://{your_server}/api/v1/{your_account}/assets?max_rows=3",
 "record_count": "3",
 "total_record_count": "39716",
 "records": [
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/assets/9478",
     "ASSET_LABEL": "",
     "ASSET_TAG": "PHOEBE_4",
     "END_OF_WARANTY": "2010-09-29T00:00:00.000Z",
     "ENTRY_DATE": "",
     "INSTALLATION_DATE": "2007-10-15T00:00:00.000Z",
     "PURCHASE_DATE": "2007-09-30T00:00:00.000Z",
     "SERIAL_NUMBER": "7 QSS- 15727- 7 UR",
     "LOCATION": {
       "HREF": "https://{your_server}/api/v1/{your_account}/locations/257",
       "CITY": "",
       "LOCATION_CODE": "",
       "LOCATION_EN": "105",
       "LOCATION_PATH": "Europe/Spain/Madrid/Calle Major/Floor 2/105"
      },
     "DEPARTMENT": {
       "HREF": "https://{your_server}/api/v1/{your_account}/departments/22",
       "DEPARTMENT_CODE": "",
       "DEPARTMENT_EN": "Customer Support",
       "DEPARTMENT_PATH": "National Sales/Direct/Customer Support",
       "DEPARTMENT_LABEL": ""
      },
     "EMPLOYEE": {
       "HREF": "https://{your_server}/api/v1/{your_account}/employees/9477",
       "BEGIN_OF_CONTRACT": "1998-01-13T00:00:00.000Z",
       "CELLULAR_NUMBER": "780-064-340",
       "DEPARTMENT_PATH": "National Sales/Direct/Education",
       "E_MAIL": "test@aef.com",
       "LAST_NAME": "Talma, Bart",
       "LOCATION_PATH": "Europe/Spain/Madrid/Calle Major/Floor 2/105",
       "PHONE_NUMBER": "919191919191"
      }
    },
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/assets/9479",
     "ASSET_LABEL": "",
     "ASSET_TAG": "HYPERION_5",
     "END_OF_WARANTY": "2010-08-30T00:00:00.000Z",
     "ENTRY_DATE": "",
     "INSTALLATION_DATE": "2007-09-15T00:00:00.000Z",
     "PURCHASE_DATE": "2007-08-31T00:00:00.000Z",
     "SERIAL_NUMBER": "5 PTD- 15728- 8 OP",
     "LOCATION": {
       "HREF": "https://{your_server}/api/v1/{your_account}/locations/380",
       "CITY": "",
       "LOCATION_CODE": "",
       "LOCATION_EN": "336",
       "LOCATION_PATH": "Europe/Spain/Sevilla/Bldg 1/Floor 03/336"
      },
     "DEPARTMENT": {
       "HREF": "https://{your_server}/api/v1/{your_account}/departments/29",
       "DEPARTMENT_CODE": "",
       "DEPARTMENT_EN": "Healthcare",
       "DEPARTMENT_PATH": "National Sales/Direct/Healthcare",
       "DEPARTMENT_LABEL": ""
      },
     "EMPLOYEE": {
       "HREF": "https://{your_server}/api/v1/{your_account}/employees/9478",
       "BEGIN_OF_CONTRACT": "1997-12-13T00:00:00.000Z",
       "CELLULAR_NUMBER": "785-533-485",
       "DEPARTMENT_PATH": "National Sales/Direct/Finance",
       "E_MAIL": "ctanner@itassetservices.com",
       "LAST_NAME": "Tanner, Carol",
       "LOCATION_PATH": "Europe/Spain/Sevilla/Bldg 1/Floor 03/336",
       "PHONE_NUMBER": "+34902430820"
      }
    },
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/assets/9480",
     "ASSET_LABEL": "",
     "ASSET_TAG": "JAPET_6",
     "END_OF_WARANTY": "2010-06-29T00:00:00.000Z",
     "ENTRY_DATE": "",
     "INSTALLATION_DATE": "2007-07-15T00:00:00.000Z",
     "PURCHASE_DATE": "2007-06-30T00:00:00.000Z",
     "SERIAL_NUMBER": "4 QRC- 15729- 5 Q7",
     "LOCATION": {
       "HREF": "https://{your_server}/api/v1/{your_account}/locations/916",
       "CITY": "",
       "LOCATION_CODE": "",
       "LOCATION_EN": "1632",
       "LOCATION_PATH": "Europe/Spain/Valladolid/Bldg 1/Floor 16/1632"
      },
     "DEPARTMENT": {
       "HREF": "https://{your_server}/api/v1/{your_account}/departments/28",
       "DEPARTMENT_CODE": "",
       "DEPARTMENT_EN": "Government",
       "DEPARTMENT_PATH": "National Sales/Direct/Government",
       "DEPARTMENT_LABEL": ""
      },
     "EMPLOYEE": {
       "HREF": "https://{your_server}/api/v1/{your_account}/employees/9479",
       "BEGIN_OF_CONTRACT": "1997-11-12T00:00:00.000Z",
       "CELLULAR_NUMBER": "786-660-556",
       "DEPARTMENT_PATH": "National Sales/Direct/Government",
       "E_MAIL": "dtaverner@itassetservices.com",
       "LAST_NAME": "Taverner, David",
       "LOCATION_PATH": "Europe/Spain/Valladolid/Bldg 1/Floor 16/1632",
       "PHONE_NUMBER": "+34902431162"
      }
    }
  ]
}
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