REST API - View all the links impacted by a CI


Minimum version: Service Manager 2016* - Build 2016.1.321.0.

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

  • This method allows all the links impacted by of a specified configuration item (CI) to be obtained (CIs whose unavailability is due to the unavailability of the current CI).
           example   /configuration-items/123/item-links/impacted
  • To obtain:
    • All the links that have an impact on a specified CI (CIs whose unavailability will lead to the unavailability of the current CI): GET  /configuration-items/{ci_id}/item-links/impacting. Open url.png See the method.
    • All the links of a specified CI (impacting / impacted) : GET  /configuration-items/{ci_id}/item-links. Open url.png See the method.

Notes

     Open url.png  See Service Manager 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 EasyVista 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.

List of parameters / fields

Mandatory parameters

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

Parameter Type Description / Example
ci_id integer CI identifier

Optional parameters

Parameter Type Description / Example
linked_ci integer CI identifier

example /configuration_items/123/items_links/impacted?linked_ci=456

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 Service Manager account.

example

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

{
 "error": "Resource not found"
}

Example

Result with a status code 200 returned

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


ConventionsAPI

REST API Conventions

Convention Meaning
Orange Parameters used in an HTTP request string which do not correspond to Service Manager database fields.

example   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 Service Manager database fields.

example   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 Service Manager database fields; they allow the value of a database field to be assigned or modified.

example   Method Close an incident/request

{  "closed": {  "end_date": "11/20/2019 12:12:12",  }  }
Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.

example   Method Reopen an incident/request

{  "restarted": {  "comment": "string (required)"  }  }

Tags:
Last modified by Unknown User on 2020/03/30 11:54
Created by Administrator XWiki on 2019/06/28 09:31

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020