REST API - View the list of the links of a CI


GET  /configuration-items/{ci_id}/item-links

  • This method allows the list of the links of a specified configuration item (CI) to be obtained.
             Example documentation icon EN.png  /configuration-items/18782/item-links
  • To obtain detailed information about a specified CI link: GET  /configuration-items/{parent_ci_id}/item-links/{child_ci_id}  -  Open url.png method View a CI link

Notes

      Open url.png  see 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
ci_id integer CI identifier

Optional parameters

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

Objet 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 /configuration-items/{ci_id}/item-links?sort=child_ci_id+asc
fields string SSelect fields to display.
  • Example documentation icon EN.png /configuration-items/{ci_id}/item-links?fields=child_ci_id

Fields that could be used in optional parameters

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

Example

Result for 4 links of a CI (status code 200)

{
   "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782/item-links",
   "record_count": "4",
   "total_record_count": "4",
   "records": [
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "hhttps://{your_server}/api/v1/{your_account}/configuration-items/48716",
           "BLOCKING": "1",
           "CHILD_CI_ID": "48716",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/48718",
           "BLOCKING": "1",
           "CHILD_CI_ID": "48718",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/48723",
           "BLOCKING": "1",
           "CHILD_CI_ID": "48723",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/49182",
           "BLOCKING": "1",
           "CHILD_CI_ID": "49182",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        }
    ]
}


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

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