REST API - View the list of links of an asset


GET  /assets/{asset_id}/asset-links

  • This method allows the list of the links of a specified asset (equipment / license / contract) to be obtained.
             Example documentation icon EN.png  /assets/10106/asset-links
  • To obtain detailed information about a specified asset link: GET  /assets/{parent_asset_id}/asset-links/{child_asset_id}  -  Open url.png method View an asset link

Notes

      Open url.png  vsee Product name - ev itsm.png REST API Conventions

  • If successful, an HTTP status code 200 is returned.
    • 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

You must use the JSON object below in the body of the HTTP request.

Objet Type Description / Example
asset_id integer Asset identifier

Optional parameters

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

Object Type Description / Example
sort string Sort in ascending or descending order.
  • Syntax: field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • Example documentation icon EN.png /assets/{asset_id}/asset-links?sort=parent_asset_id +asc
fields string Select fields to display.
  • Example documentation icon EN.png /assets/{asset_id}/asset-links?fields=parent_asset_id

Fields that could be used in optional parameters

You can use all the JSON fields from the AM_ASSET 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 Product name - ev itsm.png account.
Example documentation icon EN.png
{
 "error": "Invalid Login / Password"
}
Status404
404 Not Found Resource not found: Incorrect URI, Missing resource, Incorrect communication with the server, rfc_number not found.
Example documentation icon EN.png
{
 "error": "Resource not found"
}

Example

Result for 3 links of an asset (status code 200)

{
   "HREF": "https://{your_server} /api/v1/{your_account}/assets/9505/asset-links",
   "record_count": "3",
   "total_record_count": "3",
   "records": [
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/assets/48996",
           "HREF": "https://{your_server}/api/v1/{your_account}/assets/9505",
           "ASSET_ID": "9505",
           "CONTRACT_ROW": "",
           "MONTHLY_PAYMENT": "11,00",
           "PARENT_ASSET_ID": "48996"
        },
        {
           "PARENT_HREF": "https://{your_server}/api/{your_account}/assets/49001",
           "HREF": "https://{your_server}/api/v1/{your_account}/assets/9505",
           "ASSET_ID": "9505",
           "CONTRACT_ROW": "",
           "MONTHLY_PAYMENT": "24,00",
           "PARENT_ASSET_ID": "49001"
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/assets/49002",
           "HREF": "https://{your_server}/api/v1/{your_account}/assets/9505",
           "ASSET_ID": "9505",
           "CONTRACT_ROW": "1",
           "MONTHLY_PAYMENT": "25,00",
           "PARENT_ASSET_ID": "49002"
        }
    ]
}


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:49

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