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 parameter below in the URL.

Objet Type Description / Example
ci_id integer CI identifier

Optional parameters

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

REST_OptionalParametersGetList_Oxygen1.7_Build131.0

Note: not like, not, formatDate parameters: Specific to Product name - ev itsm.png Oxygen version 1.7 - Build 2018.1.131.0 - and later.

Objet Type Description / Example
max_rows integer Maximum number of records to display.
  • Default value: 100
  • Example documentation icon EN.png /configuration-items/18782/item-links?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 /configuration-items/18782/item-links?sort=child_ci_id+asc
fields string SSelect fields to display.
  • Example documentation icon EN.png /configuration-items/18782/item-links?fields=child_ci_id
search string Search/filter the specified fields.   Open url.png See Description of the options.
  • Example documentation icon EN.png /configuration-items/18782/item-links?search=employee.e_mail:btalma@itassetservices.com

A search on a Date field is also possible.

  • Example documentation icon EN.png /configuration-items/18782/item-links?search=employee.begin_of_contract:last_week
~

(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 documentation icon EN.png
    • /configuration-items?search=parent_ci_id~"187*" ==> all links of a CI in which the parent_ci_id field begins with 18782
    • /configuration-items?search=parent_ci_id~"*187*" ==> all links of a CI in which the parent_ci_id field contains 18782
!~

(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 documentation icon EN.png
    • /configuration-items?search=parent_ci_id!~"187*" ==> all links of a CI by excluding those in which the parent_ci_id field begins with 18782
    • /configuration-items?search=parent_ci_id!~"*187*" ==> all links of a CI by excluding those in which the parent_ci_id field contains 18782
!

(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 documentation icon EN.png /configuration-items?search=parent_ci_id!"18782" ==> all links of a CI by excluding those in which the parent_ci_id field is equal to 18782
formatDate string Specification of the date.   Open url.png See Description of the options
  • Example documentation icon EN.png
    • /requests?formatDate=l/M/Y ==> Friday/Nov/2018
    • /requests?formatDate=l jS \of F Y h:i:s A ==> Friday 16th of November 2018 12:00:00 AM

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 2019/03/19 15:35
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 2019