REST API - View an asset link


GET  /assets/{asset_id}/asset-links/{parent_asset_id}

  • This method allows information about a specified asset link (equipment / license / contract) to be obtained.
           Example documentation icon EN.png  /assets/10106/asset-links/18713

Notes

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

  • If successful, an HTTP status code 200 is returned.
    • A URL link (HREF) to the resource is provided.
       

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
parent_asset_id integer Link identifier to be searched

Optional parameters

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

Objet Type Description / Example
fields string Select fields to display.
  • Example documentation icon EN.png /assets/{asset_id}/asset-links/{parent_asset_id}?fields=asset_id,contract_row

Fields that could be used in filters

You can use all the JSON objects 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 with a status code 200 returned

{
"HREF": "http://{your_server}/api/v1/{your_account}/assets/10106",
 "ASSET_ID": "10106",
 "CONTRACT_ROW": "1",
 "MONTHLY_PAYMENT": "15.00",
 "PARENT_ASSET_ID": "18713"
}


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