REST API - View links impacted by a CI

Last modified on 2023/02/21 14:23

Contents

Notes
List of parameters / fields
- Mandatory parameters
- Optional parameters
HTTP status codes for the method
Example
- Result with a status code 200 returned
REST API Conventions

Minimum version Service Manager: 2016 - Build 2016.1.321.0

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

This method allows 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:
- Links impacting a specified CI (CIs whose unavailability will lead to the unavailability of the current CI): GET /configuration-items/{ci_id}/item-links/impacting. See the method.
- All the links of a specified CI (impacting / impacted) : GET /configuration-items/{ci_id}/item-links. 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

Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).

Code	Error		Description

Status200

200

OK (Successful)

Request successfully processed.

Status401

401

Unauthorized

Incorrect authentication process for accessing the resource: Incorrect login/password, 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/2016 12:12:12", } }
Green		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: