Run Impact Analysis

This call runs an impact analysis with a given definition.

URL

/impactAnalysis

Method

POST

Headers

Required:

Authorization: Bearer <token>

Example:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njc5ODQ5MTcsImN1c3RvbWVyIjoxLCJ1c2VybmFtZSI6InN5c2FkbWluIn0.Ph8WHtzvpvfuH1j0CtwHqyBhX1uLlfhr0eQQ7m0_gT0

Request type

JSON

Response type

JSON

URL Parameters

Required: None

Optional: None

Payload

{
  "triggerCIs": [
    {
      "triggerId": [ucmdb_id],
      "severity": [severity]
    },
    ...
  ],
  "properties": ["name","label',...],
  "bundles": ["bundle1","bundle2",...]
}

Configure the payload's parameters as follows:

• "bundles". (Optional) Specify the bundles of rules used to run the analysis. If you do not specify a list of bundles, all bundles are used by default.

• "properties". (Optional) Specify the properties to be fetched for each affected CI that is identified by the impact analysis (as an array of strings - names). If not specified, no extra property will be fetched. The CI type and the UCMDB ID are fetched by default.

• "triggerCIs". Specify the CIs that are triggered for this impact analysis (as an array of trigger CIs). At least one trigger CI should be specified. Each trigger CI has two fields:

  • "triggerId". [ucmdb_id]

    The string that represents the CI's ID in UCMDB.

  • "severity". [severity]

    The string that represents the severity at which the trigger CI is affected.

Success response

Code: 200

Content:

{
  "affectedCIs": [
    {
      "ucmdbId" : [ucmdb_id],
      "severity": [severity],
      "type": [type],
      "properties": {
          "property1": "value",
          "property2": "value",
          ...
      }
    },
    ...
  ]
}

The above parameters are described below:

• "affectedCIs". The list of affected CIs identified by the impact analysis. Each affected CI contains the following fields:

  • "ucmdbId" - [ucmdb_id]. The string that represents the ID of an object.
  • "severity" - [severity]. The string that represents the severity at which the CI is affected.
  • "type" - [type]. The string that specifies the CI type of the affected CI.

  • "properties". The properties that were requested in the Payload.

Error response

Code: 400

Content:

{
  error: [string]
}