REST API - View a list of asset catalog entries


GET  /catalog-assets

  • To obtain detailed information about a specified entry catalog: GET /catalog-assets/{catalog_id}  -  Open url.png method View an asset catalog entry

Notes

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

List of parameters / objects

Mandatory parameters

None

Optional parameters

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

Objet Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • Example documentation icon EN.png /catalog-assets?max_rows=5
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • Example documentation icon EN.png /catalog-assets?sort=net_price+desc
fields string Select fields to display.
  • Example documentation icon EN.png /catalog-assets?fields=article_model,manufacturer.manufacturer
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • Example documentation icon EN.png /catalog-assets?search=manufacturer.manufacturer"*Pack*"

Fields that could be used in optional parameters

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

  • support_staff_id ; support_level_id 
  • software_catalog_id 
  • category_id
  • action_table_name ; action_field_name ; action_duration 
  • lookup_table_name ; lookup_field_name 
  • formula 
  • associated_block 
  • suppress 
  • comment_catalog 
  • minimal_version 
  • depreciation_rule_id 
  • picture_path ; big_picture_path 
  • language_id 
  • global_license_asset_id 
  • usual_supplier_id 
  • unit_parent_catalog_id 
  • default_request_bo ; default_request_fo ; default_urgency_id ; default_root_cause_id 
  • forms_id 
  • workflow_id 
  • un_classification_id 
  • license_type_id ; license_model_id 
  • default_request_ta 
  • no_logistic 
  • software_catalog_pk 

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"
}

Example

Result for 2 equipment catalog entries (status code 200)

{
"HREF": "http://{your_server}/api/v1/{your_account}/catalog-assets?search=manufacturer.manufacturer~%22*Pack*%22&max_rows=2",
"record_count": "2",
"total_record_count": "108",
"records": [
{
"HREF": "http://{your_server}/api/v1/{your_account}/catalog-assets/2576",
"ARTICLE_MODEL": "HP Elite 7100 Microtower PC",
"CATALOG_ID": "2576",
"NET_PRICE": "1,779.00",
"SMBIOS_NAME": "HP Elite 7100 Microtower PC",
"TITLE_EN": "",
"MANUFACTURER": {
 "HREF": "http://{your_server}/api/v1/{your_account}/manufacturers/197",
 "DISCOVERY_NAME": "",
 "MANUFACTURER": "Hewlett-Packard",
 "MANUFACTURER_ID": "197"
  }
},
{
"HREF": "http://{your_server}/api/v1/{your_account}/catalog-assets/2580",
"ARTICLE_MODEL": "Evo D510 USDT",
"CATALOG_ID": "2580",
"NET_PRICE": "1,791.00",
"SMBIOS_NAME": "Evo D510 USDT",
"TITLE_EN": "",
"MANUFACTURER": {
 "HREF": "http://{your_server}/api/v1/{your_account}/manufacturers/197",
 "DISCOVERY_NAME": "",
 "MANUFACTURER": "Hewlett-Packard",
 "MANUFACTURER_ID": "197"
  }
}
]}


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:48
Created by Administrator XWiki on 2017/12/21 08:47

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