Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Reference
- Authenticate
- Availability Information
- Sample Data Model
- Insert Topology
- Get CI
- Update CI
- Delete CI
- Generate Change Report
- Get Related CIs
- Get Relation
- Update Relation
- Delete Relation
- Get Protocol
- Sample Topology Query
- Execute Query By Name
- Execute Query By Definition
- Expose CI Information
- Get Chunked Query Result
- Delete Chunked Query Result
- Run Impact Analysis
- Multiple CMDB Calls
- History Changes
Run Impact Analysis
This call runs an impact analysis with a given definition.
URL
/impactAnalysis
Method
POST
Headers
Required:
Authorization: Bearer <token>
Note <token>
is the token that is returned by the Authentication call.
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.
-
Note
- To check the available [severity] levels, see the output of GET /impactAnalysis/severities.
- The
…
(three dots) denotes that there can be more values in the array.
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.
Note The …
(three dots) denotes that there can be 0 or more values.
Error response
Code: 400
Content:
{ error: [string] }
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to cms-doc@microfocus.com.
Help Topic ID:
Product:
Topic Title:
Feedback: