JSON format keys for model definitions

required

Name of the model

required but generated if necessary

Unique key identifying the model

optional

Temporary key that can be used for relationship references when creating multiple models. The key is only valid for the duration of the API request.

required except for rules_template 

Node kind constructed by the model. One of:

• BusinessService
• TechnicalService
• BusinessApplicationInstance

required

The type of model. One of the following. These types can be directly manipulated by the user in a UI:

• rules_template – blueprint / template set of rules with parameters the user must provide
• rules – instantiation of a blueprint / template, or stand-alone rules unique to this model
• sam – start anywhere model – user defined contents, AI updates
• static – user defined contents, no automatic updates

These cannot be directly manipulated by the user at a model definition level:

• instance – instance of a multi-instance rules model (or multi-instance SAM in future)
• imported – contents from an import source; updates by import

optional

Version of the model (not version of the created service), as a single integer

optional

Description of the model

optional

User-entered notes

optional

String indicating the client that created the model definition, allowing that client to get back models that are compatible with the subset of features it supports. If the model is edited in DSM (or elsewhere than the specified client), compatibility is cleared, meaning that it is no longer necessarily restricted to features supported by the client.

Expected values: "aiops", "bhom"

optional

Object containing key/value pairs of static attributes to store on the constructed BusinessService node (dynamic attributes can be set with named values in the conditions)

optional

Object containing arbitrary key/value pairs that are stored on the model definition

required if type=rules_template 

if type=rules , one of conditions or templates is required

Conditions specified in JSON format for conditions, rules and queries

read only

If type=rules_template, parameters is set to a flat array of all the parameters defined in conditions (to avoid the UI having to recurse into the conditions to extract them)

if type=rules, one of conditions or templates is required

Object where the key is the key of the template model definition and the value is an object containing the parameters required by the template. For example:

{
  "key_of_template_1": { "param1": "value1", "param2": "value2" },
  "key_of_template_2": { "param1": "value3" }
}

If the user has overridden the operator from the template, the value contains a partial expression including the operator, but only including the right side of the expression,

e.g. { "type": "operator", "right": literal }

Normally, each template is only instantiated once. If the same template is instantiated multiple times with different parameters, the value in the templates object can be an array of objects rather than a single object:

{
  "key_of_template": [ { "param": "value1" }, { "param": "value2" } ]
}