Service Health Heuristic Packages APIs

Version 7.1.0

v7.0.0 - 2024-08-24

Changed

POST /createPlugin

Request:

Changed content type : application/json

• Changed property id (string)

  Generated ID of the plugin

• Changed property name (string)

  Name of the plugin

• Changed property namespace (string)

  Namespace to which this plugin belongs

• Changed property content (string)

  Content of the plugin file in byte format

• Changed property create_timestamp (string)

  Create timestamp for the plugin

• Changed property update_timestamp (string)

  Update timestamp for the plugin

• Changed property version (string)

  current version of the plugin

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

DELETE /deletePlugin

Request:

Changed content type : application/json

• Changed property id (string)

  Generated ID of the plugin

• Changed property name (string)

  Name of the plugin

• Changed property namespace (string)

  Namespace to which this plugin belongs

• Changed property content (string)

  Content of the plugin file in byte format

• Changed property create_timestamp (string)

  Create timestamp for the plugin

• Changed property update_timestamp (string)

  Update timestamp for the plugin

• Changed property version (string)

  current version of the plugin

Return Type:

Changed response : 204 No Content

No Content. The request was successful and there is no additional content in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /hpExport

Request:

Changed content type : application/json

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    Error reason of the Export Heuristic Package Element response.

  • Changed property file (string)

    File of the Export Heuristic Package Element response.

  • Changed property status (string)

    The Response status of the Export Heuristic Package Element.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

PUT /updatePlugin

Request:

Changed content type : application/json

• Changed property id (string)

  Generated ID of the plugin

• Changed property name (string)

  Name of the plugin

• Changed property namespace (string)

  Namespace to which this plugin belongs

• Changed property content (string)

  Content of the plugin file in byte format

• Changed property create_timestamp (string)

  Create timestamp for the plugin

• Changed property update_timestamp (string)

  Update timestamp for the plugin

• Changed property version (string)

  current version of the plugin

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /createSubServiceClass

Request:

Changed content type : application/json

• Changed property id (string)

  The subservice class to be monitored (such as LinkHealth, IP-Reachability, etc.)

• Changed property namespace (string)

  The namespace to which the subservice class belongs

• Changed property description (string)

  Description of the SubserviceClass.

• Changed property expr_cid (string)

  ID allocated by HP for subservice expression

• Changed property create_timestamp (string)

  The time when this SubserviceClass definition was created or last updated

• Changed property update_timestamp (string)

  Update Timestamp

• Changed property tags (array)

  The tags associate to the list of badges displayed in the UI. For example: To display the 'degraded' badge against the device icon when either the device or its service-related VPN-interface degrades, you can assign tags to those classes. The UI will leverage these tags to determine which of the subservices must be displayed with badges against the device.

• Changed property version (string)

  The current version of the subServiceClass

• Changed property root_expressions (array)

  Root expressions

  Changed items (object): > Each SubserviceClass can contain a list of root expressions. The 'activate_condition' defined for each element will determine whether the computation, represented by 'eval_expression', will be made part of the overall compute expression tree of that Subservice instance. The 'activate_condition' should either be left empty or, if non-empty, should evaluate to 'true' to be part of the compute expression tree. When an element is part of the compute expression tree, then all corresponding metrics will be scheduled for collection. This conditional logic is handy when a network feature has multiple parts to be monitored and each of these parts can be selectively enabled or disabled by the Operator using service configuration. For example: Y.1731 monitoring for Latency, Jittter and Loss. Each of these can be selectively enabled or disabled via Y.1731 configuration. If only Latency probes are configured, then Y.1731-Subservice should only be scheduling jobs for latency and none for jitter or loss.

  • Changed property eval_expression (string)

    Eval Expression

  • Changed property activate_condition (string)

    Activate Condition

• Changed property params (array)

  Contains the list of parameter keys that this subservice class uses. These need to be passed as arguments when instantiating the respective subservices.

  Changed items (object): > The Heuristic Package Element parameter.

  • Changed property description (string)

    The description of the Heuristic Package Element parameter.

• Changed property live_metrics (object)

  Live metrics

• Changed property dynamic_config (object)

  Sample payload for dynamic_dependencies: "dynamicConfig": { "ruleID": "rule.dynamic.l2vpn.sr.policy.subgraph system", "ruleParams": [ { "serviceId": "vpn-id" }, { "srpolicies": "srpolicy_list" } ], "ruleTriggerConditions": { "description": "Activate when at least one dynamic SR Policy gets instantiated. Deactivate (sample for now) when a certain condition is met (3 policies). Update as long as the number of discovered policies is less than 20.", "activate": "Len(srpolicy_list) > 0", "deactivate": "Len(srpolicy_list) > 2", "update": "Delta(srpolicy_list) and Len(srpolicy_list) <= 20" } },

  • Changed property rule_params (object)

    The map of parameters needed to build the dynamic subservice. The key corresponds to ruleClass parameters and the value corresponds to SSClass parameters.

  • Changed property rule_trigger_conditions (object)

    Dynamic Config Rule Trigger Conditions.

    • Changed property description (string)

      Description

• Changed property symptom (object)

  The symptom text and the failed subexpressions.

  • Changed property format_string (string)

    Format-string

  • Changed property priority (integer)

    The lower the value, higher the priority. The lowest valid value is 1, so the highest priority is represented by '1'. When this value is not explicitly defined in the SubserviceClass, the value defaults to '255' in the backend. This is the behavior even in cases where the priority in the SubserviceClass is explicitly defined as '0'.

  • Changed property preempt_group (string)

    preempt_group

  • Changed property level (string)

    Symptom level

• Changed property dependencies (array)

  Dependencies

  Changed items (object): > Subservice Class Dependency

  • Changed property eval_expression (string)

    The compute-expression to be evaluated by this dependency. Note that this property is currently overloaded in order to provide ClassNames for Subservice or Metric types of dependencies. It may be better to have separate fields for this purpose.

  • Changed property param_map (object)

    Map of dependency Subservice/Metric parameters to current Subservice Class parameters

  • Changed property id (string)

    Unique ID allocated by Service Health

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

DELETE /deleteSubserviceClass

Request:

Changed content type : application/json

• Changed property id (string)

  The subservice class to be monitored (such as LinkHealth, IP-Reachability, etc.)

• Changed property namespace (string)

  The namespace to which the subservice class belongs

• Changed property description (string)

  Description of the SubserviceClass.

• Changed property expr_cid (string)

  ID allocated by HP for subservice expression

• Changed property create_timestamp (string)

  The time when this SubserviceClass definition was created or last updated

• Changed property update_timestamp (string)

  Update Timestamp

• Changed property tags (array)

  The tags associate to the list of badges displayed in the UI. For example: To display the 'degraded' badge against the device icon when either the device or its service-related VPN-interface degrades, you can assign tags to those classes. The UI will leverage these tags to determine which of the subservices must be displayed with badges against the device.

• Changed property version (string)

  The current version of the subServiceClass

• Changed property root_expressions (array)

  Root expressions

  Changed items (object): > Each SubserviceClass can contain a list of root expressions. The 'activate_condition' defined for each element will determine whether the computation, represented by 'eval_expression', will be made part of the overall compute expression tree of that Subservice instance. The 'activate_condition' should either be left empty or, if non-empty, should evaluate to 'true' to be part of the compute expression tree. When an element is part of the compute expression tree, then all corresponding metrics will be scheduled for collection. This conditional logic is handy when a network feature has multiple parts to be monitored and each of these parts can be selectively enabled or disabled by the Operator using service configuration. For example: Y.1731 monitoring for Latency, Jittter and Loss. Each of these can be selectively enabled or disabled via Y.1731 configuration. If only Latency probes are configured, then Y.1731-Subservice should only be scheduling jobs for latency and none for jitter or loss.

  • Changed property eval_expression (string)

    Eval Expression

  • Changed property activate_condition (string)

    Activate Condition

• Changed property params (array)

  Contains the list of parameter keys that this subservice class uses. These need to be passed as arguments when instantiating the respective subservices.

  Changed items (object): > The Heuristic Package Element parameter.

  • Changed property description (string)

    The description of the Heuristic Package Element parameter.

• Changed property live_metrics (object)

  Live metrics

• Changed property dynamic_config (object)

  Sample payload for dynamic_dependencies: "dynamicConfig": { "ruleID": "rule.dynamic.l2vpn.sr.policy.subgraph system", "ruleParams": [ { "serviceId": "vpn-id" }, { "srpolicies": "srpolicy_list" } ], "ruleTriggerConditions": { "description": "Activate when at least one dynamic SR Policy gets instantiated. Deactivate (sample for now) when a certain condition is met (3 policies). Update as long as the number of discovered policies is less than 20.", "activate": "Len(srpolicy_list) > 0", "deactivate": "Len(srpolicy_list) > 2", "update": "Delta(srpolicy_list) and Len(srpolicy_list) <= 20" } },

  • Changed property rule_params (object)

    The map of parameters needed to build the dynamic subservice. The key corresponds to ruleClass parameters and the value corresponds to SSClass parameters.

  • Changed property rule_trigger_conditions (object)

    Dynamic Config Rule Trigger Conditions.

    • Changed property description (string)

      Description

• Changed property symptom (object)

  The symptom text and the failed subexpressions.

  • Changed property format_string (string)

    Format-string

  • Changed property priority (integer)

    The lower the value, higher the priority. The lowest valid value is 1, so the highest priority is represented by '1'. When this value is not explicitly defined in the SubserviceClass, the value defaults to '255' in the backend. This is the behavior even in cases where the priority in the SubserviceClass is explicitly defined as '0'.

  • Changed property preempt_group (string)

    preempt_group

  • Changed property level (string)

    Symptom level

• Changed property dependencies (array)

  Dependencies

  Changed items (object): > Subservice Class Dependency

  • Changed property eval_expression (string)

    The compute-expression to be evaluated by this dependency. Note that this property is currently overloaded in order to provide ClassNames for Subservice or Metric types of dependencies. It may be better to have separate fields for this purpose.

  • Changed property param_map (object)

    Map of dependency Subservice/Metric parameters to current Subservice Class parameters

  • Changed property id (string)

    Unique ID allocated by Service Health

Return Type:

Changed response : 204 No Content

No Content. The request was successful and there is no additional content in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /hpImport

Request:

Changed content type : application/json

• Changed property namespace (string)

  Allows the user to import custom Heuristic Package definitions into Crosswork Namespace to which the files in the current archive belong.

• Changed property b64Content (string)

  The base64 encoded string of the TAR file containing the Heuristic Package elements.

Return Type:

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property namespace (string)

    Namespace to which ImportHP belongs.

  • Changed property error (string)

    Error encountered while processing the request.

  • Changed property pkg_warnings (object)

    The warnings enumerated for each heuristics package. String represents the name of HpElem which encountered warning Eg: "pkgWarnings":{ "metricclass":{ "files":{ "ImportAPI/MetricClass/metricSystem.json":{ "fileWarnings":[ "MetricClass withid: metric.device.cpu.load.neg custom is already present in Import heuristic package. Ignoring the duplicate MetricClass" ] } } } },

  • Changed property pkg_errors (object)

    Errors enumerated for each heuristics package. String represents the name of HpElem which encountered error Eg: "pkgErrors":{ "configprofile":{ "files":{ "readFromFS/ConfigProfile/configProfL2VpnGold.json":{ "fileErrors":[ "invalid namespace: system. Ignoring the given file. Valid Namespace is: custom" ] } } },

PUT /updateSubserviceClass

Request:

Changed content type : application/json

• Changed property id (string)

  The subservice class to be monitored (such as LinkHealth, IP-Reachability, etc.)

• Changed property namespace (string)

  The namespace to which the subservice class belongs

• Changed property description (string)

  Description of the SubserviceClass.

• Changed property expr_cid (string)

  ID allocated by HP for subservice expression

• Changed property create_timestamp (string)

  The time when this SubserviceClass definition was created or last updated

• Changed property update_timestamp (string)

  Update Timestamp

• Changed property tags (array)

  The tags associate to the list of badges displayed in the UI. For example: To display the 'degraded' badge against the device icon when either the device or its service-related VPN-interface degrades, you can assign tags to those classes. The UI will leverage these tags to determine which of the subservices must be displayed with badges against the device.

• Changed property version (string)

  The current version of the subServiceClass

• Changed property root_expressions (array)

  Root expressions

  Changed items (object): > Each SubserviceClass can contain a list of root expressions. The 'activate_condition' defined for each element will determine whether the computation, represented by 'eval_expression', will be made part of the overall compute expression tree of that Subservice instance. The 'activate_condition' should either be left empty or, if non-empty, should evaluate to 'true' to be part of the compute expression tree. When an element is part of the compute expression tree, then all corresponding metrics will be scheduled for collection. This conditional logic is handy when a network feature has multiple parts to be monitored and each of these parts can be selectively enabled or disabled by the Operator using service configuration. For example: Y.1731 monitoring for Latency, Jittter and Loss. Each of these can be selectively enabled or disabled via Y.1731 configuration. If only Latency probes are configured, then Y.1731-Subservice should only be scheduling jobs for latency and none for jitter or loss.

  • Changed property eval_expression (string)

    Eval Expression

  • Changed property activate_condition (string)

    Activate Condition

• Changed property params (array)

  Contains the list of parameter keys that this subservice class uses. These need to be passed as arguments when instantiating the respective subservices.

  Changed items (object): > The Heuristic Package Element parameter.

  • Changed property description (string)

    The description of the Heuristic Package Element parameter.

• Changed property live_metrics (object)

  Live metrics

• Changed property dynamic_config (object)

  Sample payload for dynamic_dependencies: "dynamicConfig": { "ruleID": "rule.dynamic.l2vpn.sr.policy.subgraph system", "ruleParams": [ { "serviceId": "vpn-id" }, { "srpolicies": "srpolicy_list" } ], "ruleTriggerConditions": { "description": "Activate when at least one dynamic SR Policy gets instantiated. Deactivate (sample for now) when a certain condition is met (3 policies). Update as long as the number of discovered policies is less than 20.", "activate": "Len(srpolicy_list) > 0", "deactivate": "Len(srpolicy_list) > 2", "update": "Delta(srpolicy_list) and Len(srpolicy_list) <= 20" } },

  • Changed property rule_params (object)

    The map of parameters needed to build the dynamic subservice. The key corresponds to ruleClass parameters and the value corresponds to SSClass parameters.

  • Changed property rule_trigger_conditions (object)

    Dynamic Config Rule Trigger Conditions.

    • Changed property description (string)

      Description

• Changed property symptom (object)

  The symptom text and the failed subexpressions.

  • Changed property format_string (string)

    Format-string

  • Changed property priority (integer)

    The lower the value, higher the priority. The lowest valid value is 1, so the highest priority is represented by '1'. When this value is not explicitly defined in the SubserviceClass, the value defaults to '255' in the backend. This is the behavior even in cases where the priority in the SubserviceClass is explicitly defined as '0'.

  • Changed property preempt_group (string)

    preempt_group

  • Changed property level (string)

    Symptom level

• Changed property dependencies (array)

  Dependencies

  Changed items (object): > Subservice Class Dependency

  • Changed property eval_expression (string)

    The compute-expression to be evaluated by this dependency. Note that this property is currently overloaded in order to provide ClassNames for Subservice or Metric types of dependencies. It may be better to have separate fields for this purpose.

  • Changed property param_map (object)

    Map of dependency Subservice/Metric parameters to current Subservice Class parameters

  • Changed property id (string)

    Unique ID allocated by Service Health

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /createConfigProfile

Request:

Changed content type : application/json

• Changed property id (string)

  ID of ConfigProfile

• Changed property name (string)

  Name of ConfigProfile

• Changed property namespace (string)

  Namespace of ConfigProfile

• Changed property description (string)

  Description of ConfigProfile

• Changed property create_timestamp (string)

  Create timestamp for ConfigProfile

• Changed property update_timestamp (string)

  Update timestamp for ConfigProfile

• Changed property version (string)

  Current version of the configProfile

• Changed property rules (array)

  Rules of ConfigProfile

  Changed items (object): > RuleConfig Profile Candidate Rule

  • Changed property name (string)

    Name of RuleConfigProfileCandidateRule

  • Changed property namespace (string)

    Namespace of RuleConfigProfileCandidateRule

• Changed property values (object)

  Subservices can potentially inherit multiple profiles when they are shared across different services. 'Precedence' determines which profile should be adopted by the Subservice. The key is the name of the config parameter (for example: the name of the Threshold constant). The key should be given in ALL CAPS.

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /createMetricClass

Request:

Changed content type : application/json

• Changed property id (string)

  ID of the MetricClass

• Changed property name (string)

  Name of the MetricClass

• Changed property namespace (string)

  Namespace to which MetricClass belongs

• Changed property description (string)

  Description of the MetricClass

• Changed property display_label (string)

  This display label shall be used as the 24hr Metric Chart label

• Changed property m_list (boolean)

  MList for MetricClass.

• Changed property cadence (integer)

  Polling frequency (in seconds) for this metric. The default cadence is 30sec. Any value less than or equal to 30 shall be defaulted to 30sec.

• Changed property create_timestamp (string)

  Create timestamp for MetricClass.

• Changed property update_timestamp (string)

  Update timestamp for MetricClass.

• Changed property version (string)

  Current version of the metricClass.

• Changed property parameters (object)

  Parameter defines the param and the corresponding description.

• Changed property m_type (object)

  The given metric can be of list (or non-list) of type bool, string, integer or float.

  • Changed property float_t (number)

    Float types are used by counters. Hence they don't require constructs like 'if_empty' and 'output_values'.

  • Changed property bool_t (object)

    Metric calls Bool type

  • Changed property int_t (object)

    Metric calls Int type

• Changed property matcher (array)

  Matcher defines different implementation conditions.

  Changed items (object): > Metric class matcher

  • Changed property implementation (string)

    Implementation of Metric class matcher

  • Changed property not_supported (boolean)

    Set this flag to true when a given model/version is not supported for this metric. All unsupported metrics will be treated as a no-op equivalent value in their participating eval expressions.

  • Changed property address_family (string)

    Address family will indicate if the IP address is ipv4 or ipv6. If absent, the IP address should be considered ipv4. "address_family": "AddressFamily(ipAddress) == ipv4" "address_family": "AddressFamily(ipAddress) == ipv6".

  • Changed property conditions (object)

    Map key can be os_model, os_version

• Changed property implementations (object)

  The metric mplementation can be CLI, SNMP or MDT, along with their precedence.

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /createRule

Request:

Changed content type : application/json

• Changed property namespace (string)

  Namespace to which this rule belongs

• Changed property id (string)

  Rule-id: UUID

• Changed property description (string)

  Description of the rule class.

• Changed property soft_root_dependencies (array)

  The fashion (graph of dependencies). The relationship between the dependencies can be hard or soft.

  Changed items (string): > Items of the soft_root_dependencies

• Changed property create_timestamp (string)

  Create timestamp of the ruleClass

• Changed property update_timestamp (string)

  Update timestamp of the ruleClass

• Changed property version (string)

  Current version of the ruleClass

• Changed property monitoring_type (string)

  Monitoring Type

• Changed property match_criteria (array)

  Match criteria of the ruleClass

  Changed items (object): > The ruleClass services to match.

  • Changed property match_expression (string)

    Match Expression

  • Changed property match_prefix (string)

    Use match_prefix to identify the root for generating the xmlBlob for the ruleParams in Dynamic SubserviceClass

  • Changed property match_params (array)

    This is an optional field, verified against the dynamic SubserviceClass ruleparams.

    Changed items (string): > Items of match_params

  • Changed property configSource (string)

    Match Criterion config source type

  • Changed property configSubSource (array)

    ConfigSubSource - defines the list of config subSources. ConfigSubSource for the dynamic rule is not allowed to be explicitly mentioned as it gets inherited from the parent service Rule.

    Changed items (string): > Match Criterion config subsource

  • Changed property matchType (string)

    Match Criterion match type

  • Changed property service_element_config (array)

    Service element config

    Changed items (object): > Match Criterion Service Element configuration

    • Changed property service_element_id (string)

      ID for the Service Element rule

    • Changed property service_element_rule (string)

      Service Element rule

    • Changed property namespace (string)

      Namespace to which this Service Element rule belongs

• Changed property dependencies (array)

  Dependencies of the ruleClass

  Changed items (object): > Rule Class Dependency

  • Changed property name (string)

    Name of RuleClassDependency

  • Changed property id (string)

    ID of RuleClassDependency

  • Changed property ss_class (string)

    Subservice Class of RuleClassDependency

  • Changed property namespace (string)

    Namespace of RuleClassDependency

  • Changed property optional (boolean)

    By default, all dependencies are treated as mandatory, so errors are thrown when a given dependency's parameters cannot be resolved. On the other hand, certain dependencies are conditional upon certain service config or oper data. In these cases, the dependencies should be set as optional, so they can be ignored silently when their respective parameters do not resolve.

  • Changed property sub_dependencies (array)

    Subservice dependencies

  • Changed property soft_sub_dependencies (array)

    The health of these dependencies does not affect the health of its parent subservice

  • Changed property type (string)

    Rule Class Dependency Type

  • Changed property param_extraction_mechanism (object)

    Dependency Param Extraction Mechanism

    • Changed property name (string)

      Name

    • Changed property namespace (string)

      Namespace

    • Changed property version (string)

      Version

    • Changed property validation_hash (string)

      Validation hash

    • Changed property plugin_method (string)

      Plugin method

    • Changed property extracted_params (array)

      Extracted parameters

      Changed items (string): > Items of Extracted parameters

    • Changed property native_method (string)

      Native method

    • Changed property mode (string)

      Parameter Extraction mechanism mode

  • Changed property parameters (array)

    Parameters of RuleClassDependency

    Changed items (object): > Dependency parameter

    • Changed property name (string)

      Name of the Dependency parameter

    • Changed property extraction_method (string)

      Dependency Parameter Type

    • Changed property extraction_details (array)

      Extraction details

      Changed items (object): > Parameter Extraction Detail

      • Changed property description (string)

        Description

      • Changed property extract_value (string)

        Extract value

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

DELETE /deleteConfigProfile

Request:

Changed content type : application/json

• Changed property id (string)

  ID of ConfigProfile

• Changed property name (string)

  Name of ConfigProfile

• Changed property namespace (string)

  Namespace of ConfigProfile

• Changed property description (string)

  Description of ConfigProfile

• Changed property create_timestamp (string)

  Create timestamp for ConfigProfile

• Changed property update_timestamp (string)

  Update timestamp for ConfigProfile

• Changed property version (string)

  Current version of the configProfile

• Changed property rules (array)

  Rules of ConfigProfile

  Changed items (object): > RuleConfig Profile Candidate Rule

  • Changed property name (string)

    Name of RuleConfigProfileCandidateRule

  • Changed property namespace (string)

    Namespace of RuleConfigProfileCandidateRule

• Changed property values (object)

  Subservices can potentially inherit multiple profiles when they are shared across different services. 'Precedence' determines which profile should be adopted by the Subservice. The key is the name of the config parameter (for example: the name of the Threshold constant). The key should be given in ALL CAPS.

Return Type:

Changed response : 204 No Content

No Content. The request was successful and there is no additional content in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

DELETE /deleteMetricClass

Request:

Changed content type : application/json

• Changed property id (string)

  ID of the MetricClass

• Changed property name (string)

  Name of the MetricClass

• Changed property namespace (string)

  Namespace to which MetricClass belongs

• Changed property description (string)

  Description of the MetricClass

• Changed property display_label (string)

  This display label shall be used as the 24hr Metric Chart label

• Changed property m_list (boolean)

  MList for MetricClass.

• Changed property cadence (integer)

  Polling frequency (in seconds) for this metric. The default cadence is 30sec. Any value less than or equal to 30 shall be defaulted to 30sec.

• Changed property create_timestamp (string)

  Create timestamp for MetricClass.

• Changed property update_timestamp (string)

  Update timestamp for MetricClass.

• Changed property version (string)

  Current version of the metricClass.

• Changed property parameters (object)

  Parameter defines the param and the corresponding description.

• Changed property m_type (object)

  The given metric can be of list (or non-list) of type bool, string, integer or float.

  • Changed property float_t (number)

    Float types are used by counters. Hence they don't require constructs like 'if_empty' and 'output_values'.

  • Changed property bool_t (object)

    Metric calls Bool type

  • Changed property int_t (object)

    Metric calls Int type

• Changed property matcher (array)

  Matcher defines different implementation conditions.

  Changed items (object): > Metric class matcher

  • Changed property implementation (string)

    Implementation of Metric class matcher

  • Changed property not_supported (boolean)

    Set this flag to true when a given model/version is not supported for this metric. All unsupported metrics will be treated as a no-op equivalent value in their participating eval expressions.

  • Changed property address_family (string)

    Address family will indicate if the IP address is ipv4 or ipv6. If absent, the IP address should be considered ipv4. "address_family": "AddressFamily(ipAddress) == ipv4" "address_family": "AddressFamily(ipAddress) == ipv6".

  • Changed property conditions (object)

    Map key can be os_model, os_version

• Changed property implementations (object)

  The metric mplementation can be CLI, SNMP or MDT, along with their precedence.

Return Type:

Changed response : 204 No Content

No Content. The request was successful and there is no additional content in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

DELETE /deleteRuleClass

Request:

Changed content type : application/json

• Changed property namespace (string)

  Namespace to which this rule belongs

• Changed property id (string)

  Rule-id: UUID

• Changed property description (string)

  Description of the rule class.

• Changed property soft_root_dependencies (array)

  The fashion (graph of dependencies). The relationship between the dependencies can be hard or soft.

  Changed items (string): > Items of the soft_root_dependencies

• Changed property create_timestamp (string)

  Create timestamp of the ruleClass

• Changed property update_timestamp (string)

  Update timestamp of the ruleClass

• Changed property version (string)

  Current version of the ruleClass

• Changed property monitoring_type (string)

  Monitoring Type

• Changed property match_criteria (array)

  Match criteria of the ruleClass

  Changed items (object): > The ruleClass services to match.

  • Changed property match_expression (string)

    Match Expression

  • Changed property match_prefix (string)

    Use match_prefix to identify the root for generating the xmlBlob for the ruleParams in Dynamic SubserviceClass

  • Changed property match_params (array)

    This is an optional field, verified against the dynamic SubserviceClass ruleparams.

    Changed items (string): > Items of match_params

  • Changed property configSource (string)

    Match Criterion config source type

  • Changed property configSubSource (array)

    ConfigSubSource - defines the list of config subSources. ConfigSubSource for the dynamic rule is not allowed to be explicitly mentioned as it gets inherited from the parent service Rule.

    Changed items (string): > Match Criterion config subsource

  • Changed property matchType (string)

    Match Criterion match type

  • Changed property service_element_config (array)

    Service element config

    Changed items (object): > Match Criterion Service Element configuration

    • Changed property service_element_id (string)

      ID for the Service Element rule

    • Changed property service_element_rule (string)

      Service Element rule

    • Changed property namespace (string)

      Namespace to which this Service Element rule belongs

• Changed property dependencies (array)

  Dependencies of the ruleClass

  Changed items (object): > Rule Class Dependency

  • Changed property name (string)

    Name of RuleClassDependency

  • Changed property id (string)

    ID of RuleClassDependency

  • Changed property ss_class (string)

    Subservice Class of RuleClassDependency

  • Changed property namespace (string)

    Namespace of RuleClassDependency

  • Changed property optional (boolean)

    By default, all dependencies are treated as mandatory, so errors are thrown when a given dependency's parameters cannot be resolved. On the other hand, certain dependencies are conditional upon certain service config or oper data. In these cases, the dependencies should be set as optional, so they can be ignored silently when their respective parameters do not resolve.

  • Changed property sub_dependencies (array)

    Subservice dependencies

  • Changed property soft_sub_dependencies (array)

    The health of these dependencies does not affect the health of its parent subservice

  • Changed property type (string)

    Rule Class Dependency Type

  • Changed property param_extraction_mechanism (object)

    Dependency Param Extraction Mechanism

    • Changed property name (string)

      Name

    • Changed property namespace (string)

      Namespace

    • Changed property version (string)

      Version

    • Changed property validation_hash (string)

      Validation hash

    • Changed property plugin_method (string)

      Plugin method

    • Changed property extracted_params (array)

      Extracted parameters

      Changed items (string): > Items of Extracted parameters

    • Changed property native_method (string)

      Native method

    • Changed property mode (string)

      Parameter Extraction mechanism mode

  • Changed property parameters (array)

    Parameters of RuleClassDependency

    Changed items (object): > Dependency parameter

    • Changed property name (string)

      Name of the Dependency parameter

    • Changed property extraction_method (string)

      Dependency Parameter Type

    • Changed property extraction_details (array)

      Extraction details

      Changed items (object): > Parameter Extraction Detail

      • Changed property description (string)

        Description

      • Changed property extract_value (string)

        Extract value

Return Type:

Changed response : 204 No Content

No Content. The request was successful and there is no additional content in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

PUT /updateConfigProfile

Request:

Changed content type : application/json

• Changed property id (string)

  ID of ConfigProfile

• Changed property name (string)

  Name of ConfigProfile

• Changed property namespace (string)

  Namespace of ConfigProfile

• Changed property description (string)

  Description of ConfigProfile

• Changed property create_timestamp (string)

  Create timestamp for ConfigProfile

• Changed property update_timestamp (string)

  Update timestamp for ConfigProfile

• Changed property version (string)

  Current version of the configProfile

• Changed property rules (array)

  Rules of ConfigProfile

  Changed items (object): > RuleConfig Profile Candidate Rule

  • Changed property name (string)

    Name of RuleConfigProfileCandidateRule

  • Changed property namespace (string)

    Namespace of RuleConfigProfileCandidateRule

• Changed property values (object)

  Subservices can potentially inherit multiple profiles when they are shared across different services. 'Precedence' determines which profile should be adopted by the Subservice. The key is the name of the config parameter (for example: the name of the Threshold constant). The key should be given in ALL CAPS.

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

PUT /updateMetricClass

Request:

Changed content type : application/json

• Changed property id (string)

  ID of the MetricClass

• Changed property name (string)

  Name of the MetricClass

• Changed property namespace (string)

  Namespace to which MetricClass belongs

• Changed property description (string)

  Description of the MetricClass

• Changed property display_label (string)

  This display label shall be used as the 24hr Metric Chart label

• Changed property m_list (boolean)

  MList for MetricClass.

• Changed property cadence (integer)

  Polling frequency (in seconds) for this metric. The default cadence is 30sec. Any value less than or equal to 30 shall be defaulted to 30sec.

• Changed property create_timestamp (string)

  Create timestamp for MetricClass.

• Changed property update_timestamp (string)

  Update timestamp for MetricClass.

• Changed property version (string)

  Current version of the metricClass.

• Changed property parameters (object)

  Parameter defines the param and the corresponding description.

• Changed property m_type (object)

  The given metric can be of list (or non-list) of type bool, string, integer or float.

  • Changed property float_t (number)

    Float types are used by counters. Hence they don't require constructs like 'if_empty' and 'output_values'.

  • Changed property bool_t (object)

    Metric calls Bool type

  • Changed property int_t (object)

    Metric calls Int type

• Changed property matcher (array)

  Matcher defines different implementation conditions.

  Changed items (object): > Metric class matcher

  • Changed property implementation (string)

    Implementation of Metric class matcher

  • Changed property not_supported (boolean)

    Set this flag to true when a given model/version is not supported for this metric. All unsupported metrics will be treated as a no-op equivalent value in their participating eval expressions.

  • Changed property address_family (string)

    Address family will indicate if the IP address is ipv4 or ipv6. If absent, the IP address should be considered ipv4. "address_family": "AddressFamily(ipAddress) == ipv4" "address_family": "AddressFamily(ipAddress) == ipv6".

  • Changed property conditions (object)

    Map key can be os_model, os_version

• Changed property implementations (object)

  The metric mplementation can be CLI, SNMP or MDT, along with their precedence.

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

PUT /updateRule

Request:

Changed content type : application/json

• Changed property namespace (string)

  Namespace to which this rule belongs

• Changed property id (string)

  Rule-id: UUID

• Changed property description (string)

  Description of the rule class.

• Changed property soft_root_dependencies (array)

  The fashion (graph of dependencies). The relationship between the dependencies can be hard or soft.

  Changed items (string): > Items of the soft_root_dependencies

• Changed property create_timestamp (string)

  Create timestamp of the ruleClass

• Changed property update_timestamp (string)

  Update timestamp of the ruleClass

• Changed property version (string)

  Current version of the ruleClass

• Changed property monitoring_type (string)

  Monitoring Type

• Changed property match_criteria (array)

  Match criteria of the ruleClass

  Changed items (object): > The ruleClass services to match.

  • Changed property match_expression (string)

    Match Expression

  • Changed property match_prefix (string)

    Use match_prefix to identify the root for generating the xmlBlob for the ruleParams in Dynamic SubserviceClass

  • Changed property match_params (array)

    This is an optional field, verified against the dynamic SubserviceClass ruleparams.

    Changed items (string): > Items of match_params

  • Changed property configSource (string)

    Match Criterion config source type

  • Changed property configSubSource (array)

    ConfigSubSource - defines the list of config subSources. ConfigSubSource for the dynamic rule is not allowed to be explicitly mentioned as it gets inherited from the parent service Rule.

    Changed items (string): > Match Criterion config subsource

  • Changed property matchType (string)

    Match Criterion match type

  • Changed property service_element_config (array)

    Service element config

    Changed items (object): > Match Criterion Service Element configuration

    • Changed property service_element_id (string)

      ID for the Service Element rule

    • Changed property service_element_rule (string)

      Service Element rule

    • Changed property namespace (string)

      Namespace to which this Service Element rule belongs

• Changed property dependencies (array)

  Dependencies of the ruleClass

  Changed items (object): > Rule Class Dependency

  • Changed property name (string)

    Name of RuleClassDependency

  • Changed property id (string)

    ID of RuleClassDependency

  • Changed property ss_class (string)

    Subservice Class of RuleClassDependency

  • Changed property namespace (string)

    Namespace of RuleClassDependency

  • Changed property optional (boolean)

    By default, all dependencies are treated as mandatory, so errors are thrown when a given dependency's parameters cannot be resolved. On the other hand, certain dependencies are conditional upon certain service config or oper data. In these cases, the dependencies should be set as optional, so they can be ignored silently when their respective parameters do not resolve.

  • Changed property sub_dependencies (array)

    Subservice dependencies

  • Changed property soft_sub_dependencies (array)

    The health of these dependencies does not affect the health of its parent subservice

  • Changed property type (string)

    Rule Class Dependency Type

  • Changed property param_extraction_mechanism (object)

    Dependency Param Extraction Mechanism

    • Changed property name (string)

      Name

    • Changed property namespace (string)

      Namespace

    • Changed property version (string)

      Version

    • Changed property validation_hash (string)

      Validation hash

    • Changed property plugin_method (string)

      Plugin method

    • Changed property extracted_params (array)

      Extracted parameters

      Changed items (string): > Items of Extracted parameters

    • Changed property native_method (string)

      Native method

    • Changed property mode (string)

      Parameter Extraction mechanism mode

  • Changed property parameters (array)

    Parameters of RuleClassDependency

    Changed items (object): > Dependency parameter

    • Changed property name (string)

      Name of the Dependency parameter

    • Changed property extraction_method (string)

      Dependency Parameter Type

    • Changed property extraction_details (array)

      Extraction details

      Changed items (object): > Parameter Extraction Detail

      • Changed property description (string)

        Description

      • Changed property extract_value (string)

        Extract value

Return Type:

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error_description (string)

    The reason for the error.

  • Changed property name (string)

    The name of the Heuristic Package Element.

  • Changed property namespace (string)

    The namespace of the Heuristic Package Element.

  • Changed property status (string)

    Response status for the Heuristic Package Element CRUD.

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

POST /hpDetails/query

Request:

Changed content type : application/json

• Changed property namespace (string)

  Namespace of the Heuristic Package Element.

Return Type:

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property namespace (string)

    Namespace of the Heuristic Package Element.

  • Changed property plugins (array)

    Plugins of the Heuristic Package Element.

    Changed items (object): > Plugin information.

    • Changed property id (string)

      Generated ID of the plugin

    • Changed property name (string)

      Name of the plugin

    • Changed property namespace (string)

      Namespace to which this plugin belongs

    • Changed property content (string)

      Content of the plugin file in byte format

    • Changed property create_timestamp (string)

      Create timestamp for the plugin

    • Changed property update_timestamp (string)

      Update timestamp for the plugin

    • Changed property version (string)

      current version of the plugin

  • Changed property subservices (array)

    Subservices of the Heuristic Package Element.

    Changed items (object): > Subservice class

    • Changed property id (string)

      The subservice class to be monitored (such as LinkHealth, IP-Reachability, etc.)

    • Changed property namespace (string)

      The namespace to which the subservice class belongs

    • Changed property description (string)

      Description of the SubserviceClass.

    • Changed property expr_cid (string)

      ID allocated by HP for subservice expression

    • Changed property create_timestamp (string)

      The time when this SubserviceClass definition was created or last updated

    • Changed property update_timestamp (string)

      Update Timestamp

    • Changed property tags (array)

      The tags associate to the list of badges displayed in the UI. For example: To display the 'degraded' badge against the device icon when either the device or its service-related VPN-interface degrades, you can assign tags to those classes. The UI will leverage these tags to determine which of the subservices must be displayed with badges against the device.

    • Changed property version (string)

      The current version of the subServiceClass

    • Changed property root_expressions (array)

      Root expressions

      Changed items (object): > Each SubserviceClass can contain a list of root expressions. The 'activate_condition' defined for each element will determine whether the computation, represented by 'eval_expression', will be made part of the overall compute expression tree of that Subservice instance. The 'activate_condition' should either be left empty or, if non-empty, should evaluate to 'true' to be part of the compute expression tree. When an element is part of the compute expression tree, then all corresponding metrics will be scheduled for collection. This conditional logic is handy when a network feature has multiple parts to be monitored and each of these parts can be selectively enabled or disabled by the Operator using service configuration. For example: Y.1731 monitoring for Latency, Jittter and Loss. Each of these can be selectively enabled or disabled via Y.1731 configuration. If only Latency probes are configured, then Y.1731-Subservice should only be scheduling jobs for latency and none for jitter or loss.

      • Changed property eval_expression (string)

        Eval Expression

      • Changed property activate_condition (string)

        Activate Condition

    • Changed property params (array)

      Contains the list of parameter keys that this subservice class uses. These need to be passed as arguments when instantiating the respective subservices.

      Changed items (object): > The Heuristic Package Element parameter.

      • Changed property description (string)

        The description of the Heuristic Package Element parameter.

    • Changed property live_metrics (object)

      Live metrics

    • Changed property dynamic_config (object)

      Sample payload for dynamic_dependencies: "dynamicConfig": { "ruleID": "rule.dynamic.l2vpn.sr.policy.subgraph system", "ruleParams": [ { "serviceId": "vpn-id" }, { "srpolicies": "srpolicy_list" } ], "ruleTriggerConditions": { "description": "Activate when at least one dynamic SR Policy gets instantiated. Deactivate (sample for now) when a certain condition is met (3 policies). Update as long as the number of discovered policies is less than 20.", "activate": "Len(srpolicy_list) > 0", "deactivate": "Len(srpolicy_list) > 2", "update": "Delta(srpolicy_list) and Len(srpolicy_list) <= 20" } },

      • Changed property rule_params (object)

        The map of parameters needed to build the dynamic subservice. The key corresponds to ruleClass parameters and the value corresponds to SSClass parameters.

      • Changed property rule_trigger_conditions (object)

        Dynamic Config Rule Trigger Conditions.

        • Changed property description (string)

          Description

    • Changed property symptom (object)

      The symptom text and the failed subexpressions.

      • Changed property format_string (string)

        Format-string

      • Changed property priority (integer)

        The lower the value, higher the priority. The lowest valid value is 1, so the highest priority is represented by '1'. When this value is not explicitly defined in the SubserviceClass, the value defaults to '255' in the backend. This is the behavior even in cases where the priority in the SubserviceClass is explicitly defined as '0'.

      • Changed property preempt_group (string)

        preempt_group

      • Changed property level (string)

        Symptom level

    • Changed property dependencies (array)

      Dependencies

      Changed items (object): > Subservice Class Dependency

      • Changed property eval_expression (string)

        The compute-expression to be evaluated by this dependency. Note that this property is currently overloaded in order to provide ClassNames for Subservice or Metric types of dependencies. It may be better to have separate fields for this purpose.

      • Changed property param_map (object)

        Map of dependency Subservice/Metric parameters to current Subservice Class parameters

      • Changed property id (string)

        Unique ID allocated by Service Health

  • Changed property rules (array)

    Rules of the Heuristic Package Element.

    Changed items (object): > Rule Class definition.

    • Changed property namespace (string)

      Namespace to which this rule belongs

    • Changed property id (string)

      Rule-id: UUID

    • Changed property description (string)

      Description of the rule class.

    • Changed property soft_root_dependencies (array)

      The fashion (graph of dependencies). The relationship between the dependencies can be hard or soft.

      Changed items (string): > Items of the soft_root_dependencies

    • Changed property create_timestamp (string)

      Create timestamp of the ruleClass

    • Changed property update_timestamp (string)

      Update timestamp of the ruleClass

    • Changed property version (string)

      Current version of the ruleClass

    • Changed property monitoring_type (string)

      Monitoring Type

    • Changed property match_criteria (array)

      Match criteria of the ruleClass

      Changed items (object): > The ruleClass services to match.

      • Changed property match_expression (string)

        Match Expression

      • Changed property match_prefix (string)

        Use match_prefix to identify the root for generating the xmlBlob for the ruleParams in Dynamic SubserviceClass

      • Changed property match_params (array)

        This is an optional field, verified against the dynamic SubserviceClass ruleparams.

        Changed items (string): > Items of match_params

      • Changed property configSource (string)

        Match Criterion config source type

      • Changed property configSubSource (array)

        ConfigSubSource - defines the list of config subSources. ConfigSubSource for the dynamic rule is not allowed to be explicitly mentioned as it gets inherited from the parent service Rule.

        Changed items (string): > Match Criterion config subsource

      • Changed property matchType (string)

        Match Criterion match type

      • Changed property service_element_config (array)

        Service element config

        Changed items (object): > Match Criterion Service Element configuration

        • Changed property service_element_id (string)

          ID for the Service Element rule

        • Changed property service_element_rule (string)

          Service Element rule

        • Changed property namespace (string)

          Namespace to which this Service Element rule belongs

    • Changed property dependencies (array)

      Dependencies of the ruleClass

      Changed items (object): > Rule Class Dependency

      • Changed property name (string)

        Name of RuleClassDependency

      • Changed property id (string)

        ID of RuleClassDependency

      • Changed property ss_class (string)

        Subservice Class of RuleClassDependency

      • Changed property namespace (string)

        Namespace of RuleClassDependency

      • Changed property optional (boolean)

        By default, all dependencies are treated as mandatory, so errors are thrown when a given dependency's parameters cannot be resolved. On the other hand, certain dependencies are conditional upon certain service config or oper data. In these cases, the dependencies should be set as optional, so they can be ignored silently when their respective parameters do not resolve.

      • Changed property sub_dependencies (array)

        Subservice dependencies

      • Changed property soft_sub_dependencies (array)

        The health of these dependencies does not affect the health of its parent subservice

      • Changed property type (string)

        Rule Class Dependency Type

      • Changed property param_extraction_mechanism (object)

        Dependency Param Extraction Mechanism

        • Changed property name (string)

          Name

        • Changed property namespace (string)

          Namespace

        • Changed property version (string)

          Version

        • Changed property validation_hash (string)

          Validation hash

        • Changed property plugin_method (string)

          Plugin method

        • Changed property extracted_params (array)

          Extracted parameters

          Changed items (string): > Items of Extracted parameters

        • Changed property native_method (string)

          Native method

        • Changed property mode (string)

          Parameter Extraction mechanism mode

      • Changed property parameters (array)

        Parameters of RuleClassDependency

        Changed items (object): > Dependency parameter

        • Changed property name (string)

          Name of the Dependency parameter

        • Changed property extraction_method (string)

          Dependency Parameter Type

        • Changed property extraction_details (array)

          Extraction details

          Changed items (object): > Parameter Extraction Detail

          • Changed property description (string)

            Description

          • Changed property extract_value (string)

            Extract value

  • Changed property profiles (array)

    Profiles of the Heuristic Package Element.

    Changed items (object): > ConfigP rofile

    • Changed property id (string)

      ID of ConfigProfile

    • Changed property name (string)

      Name of ConfigProfile

    • Changed property namespace (string)

      Namespace of ConfigProfile

    • Changed property description (string)

      Description of ConfigProfile

    • Changed property create_timestamp (string)

      Create timestamp for ConfigProfile

    • Changed property update_timestamp (string)

      Update timestamp for ConfigProfile

    • Changed property version (string)

      Current version of the configProfile

    • Changed property rules (array)

      Rules of ConfigProfile

      Changed items (object): > RuleConfig Profile Candidate Rule

      • Changed property name (string)

        Name of RuleConfigProfileCandidateRule

      • Changed property namespace (string)

        Namespace of RuleConfigProfileCandidateRule

    • Changed property values (object)

      Subservices can potentially inherit multiple profiles when they are shared across different services. 'Precedence' determines which profile should be adopted by the Subservice. The key is the name of the config parameter (for example: the name of the Threshold constant). The key should be given in ALL CAPS.

  • Changed property metrics (array)

    Metrics of the Heuristic Package Element.

    Changed items (object): > MetricClass

    • Changed property id (string)

      ID of the MetricClass

    • Changed property name (string)

      Name of the MetricClass

    • Changed property namespace (string)

      Namespace to which MetricClass belongs

    • Changed property description (string)

      Description of the MetricClass

    • Changed property display_label (string)

      This display label shall be used as the 24hr Metric Chart label

    • Changed property m_list (boolean)

      MList for MetricClass.

    • Changed property cadence (integer)

      Polling frequency (in seconds) for this metric. The default cadence is 30sec. Any value less than or equal to 30 shall be defaulted to 30sec.

    • Changed property create_timestamp (string)

      Create timestamp for MetricClass.

    • Changed property update_timestamp (string)

      Update timestamp for MetricClass.

    • Changed property version (string)

      Current version of the metricClass.

    • Changed property parameters (object)

      Parameter defines the param and the corresponding description.

    • Changed property m_type (object)

      The given metric can be of list (or non-list) of type bool, string, integer or float.

      • Changed property float_t (number)

        Float types are used by counters. Hence they don't require constructs like 'if_empty' and 'output_values'.

      • Changed property bool_t (object)

        Metric calls Bool type

      • Changed property int_t (object)

        Metric calls Int type

    • Changed property matcher (array)

      Matcher defines different implementation conditions.

      Changed items (object): > Metric class matcher

      • Changed property implementation (string)

        Implementation of Metric class matcher

      • Changed property not_supported (boolean)

        Set this flag to true when a given model/version is not supported for this metric. All unsupported metrics will be treated as a no-op equivalent value in their participating eval expressions.

      • Changed property address_family (string)

        Address family will indicate if the IP address is ipv4 or ipv6. If absent, the IP address should be considered ipv4. "address_family": "AddressFamily(ipAddress) == ipv4" "address_family": "AddressFamily(ipAddress) == ipv6".

      • Changed property conditions (object)

        Map key can be os_model, os_version

    • Changed property implementations (object)

      The metric mplementation can be CLI, SNMP or MDT, along with their precedence.

POST /validate

Request:

Changed content type : application/json

• Changed property namespace (string)

  Allows the user to import custom Heuristic Package definitions into Crosswork Namespace to which the files in the current archive belong.

• Changed property b64Content (string)

  The base64 encoded string of the TAR file containing the Heuristic Package elements.

Return Type:

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error encountered while processing the request.

  • Changed property pkg_warnings (object)

    Warnings enumerated for each heuristic package. The string represents the name of the HpElem which encountered the warning. For example: "pkgWarnings":{ "metricclass":{ "files":{ "ImportAPI/MetricClass/metricSystem.json":{ "fileWarnings":[ "MetricClass withid: metric.device.cpu.load.neg custom is already present in Import heuristic package. Ignoring the duplicate MetricClass" ] } } } }

  • Changed property pkg_errors (object)

    Errors enumerated for each heuristic package. The string represents the name of the HpElem which encountered the error. For example: "pkgErrors":{ "configprofile":{ "files":{ "readFromFS/ConfigProfile/configProfL2VpnGold.json":{ "fileErrors":[ "invalid namespace: system. Ignoring the given file. Valid Namespace is: custom" ] } } },

  • Changed property subservices (array)

    List of SubserviceClass items from the files that are part of the package.

    Changed items (object): > Subservice class

    • Changed property id (string)

      The subservice class to be monitored (such as LinkHealth, IP-Reachability, etc.)

    • Changed property namespace (string)

      The namespace to which the subservice class belongs

    • Changed property description (string)

      Description of the SubserviceClass.

    • Changed property expr_cid (string)

      ID allocated by HP for subservice expression

    • Changed property create_timestamp (string)

      The time when this SubserviceClass definition was created or last updated

    • Changed property update_timestamp (string)

      Update Timestamp

    • Changed property tags (array)

      The tags associate to the list of badges displayed in the UI. For example: To display the 'degraded' badge against the device icon when either the device or its service-related VPN-interface degrades, you can assign tags to those classes. The UI will leverage these tags to determine which of the subservices must be displayed with badges against the device.

    • Changed property version (string)

      The current version of the subServiceClass

    • Changed property root_expressions (array)

      Root expressions

      Changed items (object): > Each SubserviceClass can contain a list of root expressions. The 'activate_condition' defined for each element will determine whether the computation, represented by 'eval_expression', will be made part of the overall compute expression tree of that Subservice instance. The 'activate_condition' should either be left empty or, if non-empty, should evaluate to 'true' to be part of the compute expression tree. When an element is part of the compute expression tree, then all corresponding metrics will be scheduled for collection. This conditional logic is handy when a network feature has multiple parts to be monitored and each of these parts can be selectively enabled or disabled by the Operator using service configuration. For example: Y.1731 monitoring for Latency, Jittter and Loss. Each of these can be selectively enabled or disabled via Y.1731 configuration. If only Latency probes are configured, then Y.1731-Subservice should only be scheduling jobs for latency and none for jitter or loss.

      • Changed property eval_expression (string)

        Eval Expression

      • Changed property activate_condition (string)

        Activate Condition

    • Changed property params (array)

      Contains the list of parameter keys that this subservice class uses. These need to be passed as arguments when instantiating the respective subservices.

      Changed items (object): > The Heuristic Package Element parameter.

      • Changed property description (string)

        The description of the Heuristic Package Element parameter.

    • Changed property live_metrics (object)

      Live metrics

    • Changed property dynamic_config (object)

      Sample payload for dynamic_dependencies: "dynamicConfig": { "ruleID": "rule.dynamic.l2vpn.sr.policy.subgraph system", "ruleParams": [ { "serviceId": "vpn-id" }, { "srpolicies": "srpolicy_list" } ], "ruleTriggerConditions": { "description": "Activate when at least one dynamic SR Policy gets instantiated. Deactivate (sample for now) when a certain condition is met (3 policies). Update as long as the number of discovered policies is less than 20.", "activate": "Len(srpolicy_list) > 0", "deactivate": "Len(srpolicy_list) > 2", "update": "Delta(srpolicy_list) and Len(srpolicy_list) <= 20" } },

      • Changed property rule_params (object)

        The map of parameters needed to build the dynamic subservice. The key corresponds to ruleClass parameters and the value corresponds to SSClass parameters.

      • Changed property rule_trigger_conditions (object)

        Dynamic Config Rule Trigger Conditions.

        • Changed property description (string)

          Description

    • Changed property symptom (object)

      The symptom text and the failed subexpressions.

      • Changed property format_string (string)

        Format-string

      • Changed property priority (integer)

        The lower the value, higher the priority. The lowest valid value is 1, so the highest priority is represented by '1'. When this value is not explicitly defined in the SubserviceClass, the value defaults to '255' in the backend. This is the behavior even in cases where the priority in the SubserviceClass is explicitly defined as '0'.

      • Changed property preempt_group (string)

        preempt_group

      • Changed property level (string)

        Symptom level

    • Changed property dependencies (array)

      Dependencies

      Changed items (object): > Subservice Class Dependency

      • Changed property eval_expression (string)

        The compute-expression to be evaluated by this dependency. Note that this property is currently overloaded in order to provide ClassNames for Subservice or Metric types of dependencies. It may be better to have separate fields for this purpose.

      • Changed property param_map (object)

        Map of dependency Subservice/Metric parameters to current Subservice Class parameters

      • Changed property id (string)

        Unique ID allocated by Service Health

  • Changed property metrics (array)

    List of MetricClass items from the files that areis part of the package.

    Changed items (object): > MetricClass

    • Changed property id (string)

      ID of the MetricClass

    • Changed property name (string)

      Name of the MetricClass

    • Changed property namespace (string)

      Namespace to which MetricClass belongs

    • Changed property description (string)

      Description of the MetricClass

    • Changed property display_label (string)

      This display label shall be used as the 24hr Metric Chart label

    • Changed property m_list (boolean)

      MList for MetricClass.

    • Changed property cadence (integer)

      Polling frequency (in seconds) for this metric. The default cadence is 30sec. Any value less than or equal to 30 shall be defaulted to 30sec.

    • Changed property create_timestamp (string)

      Create timestamp for MetricClass.

    • Changed property update_timestamp (string)

      Update timestamp for MetricClass.

    • Changed property version (string)

      Current version of the metricClass.

    • Changed property parameters (object)

      Parameter defines the param and the corresponding description.

    • Changed property m_type (object)

      The given metric can be of list (or non-list) of type bool, string, integer or float.

      • Changed property float_t (number)

        Float types are used by counters. Hence they don't require constructs like 'if_empty' and 'output_values'.

      • Changed property bool_t (object)

        Metric calls Bool type

      • Changed property int_t (object)

        Metric calls Int type

    • Changed property matcher (array)

      Matcher defines different implementation conditions.

      Changed items (object): > Metric class matcher

      • Changed property implementation (string)

        Implementation of Metric class matcher

      • Changed property not_supported (boolean)

        Set this flag to true when a given model/version is not supported for this metric. All unsupported metrics will be treated as a no-op equivalent value in their participating eval expressions.

      • Changed property address_family (string)

        Address family will indicate if the IP address is ipv4 or ipv6. If absent, the IP address should be considered ipv4. "address_family": "AddressFamily(ipAddress) == ipv4" "address_family": "AddressFamily(ipAddress) == ipv6".

      • Changed property conditions (object)

        Map key can be os_model, os_version

    • Changed property implementations (object)

      The metric mplementation can be CLI, SNMP or MDT, along with their precedence.

  • Changed property rules (array)

    List of RuleClass items from the files that are part of the package.

    Changed items (object): > Rule Class definition.

    • Changed property namespace (string)

      Namespace to which this rule belongs

    • Changed property id (string)

      Rule-id: UUID

    • Changed property description (string)

      Description of the rule class.

    • Changed property soft_root_dependencies (array)

      The fashion (graph of dependencies). The relationship between the dependencies can be hard or soft.

      Changed items (string): > Items of the soft_root_dependencies

    • Changed property create_timestamp (string)

      Create timestamp of the ruleClass

    • Changed property update_timestamp (string)

      Update timestamp of the ruleClass

    • Changed property version (string)

      Current version of the ruleClass

    • Changed property monitoring_type (string)

      Monitoring Type

    • Changed property match_criteria (array)

      Match criteria of the ruleClass

      Changed items (object): > The ruleClass services to match.

      • Changed property match_expression (string)

        Match Expression

      • Changed property match_prefix (string)

        Use match_prefix to identify the root for generating the xmlBlob for the ruleParams in Dynamic SubserviceClass

      • Changed property match_params (array)

        This is an optional field, verified against the dynamic SubserviceClass ruleparams.

        Changed items (string): > Items of match_params

      • Changed property configSource (string)

        Match Criterion config source type

      • Changed property configSubSource (array)

        ConfigSubSource - defines the list of config subSources. ConfigSubSource for the dynamic rule is not allowed to be explicitly mentioned as it gets inherited from the parent service Rule.

        Changed items (string): > Match Criterion config subsource

      • Changed property matchType (string)

        Match Criterion match type

      • Changed property service_element_config (array)

        Service element config

        Changed items (object): > Match Criterion Service Element configuration

        • Changed property service_element_id (string)

          ID for the Service Element rule

        • Changed property service_element_rule (string)

          Service Element rule

        • Changed property namespace (string)

          Namespace to which this Service Element rule belongs

    • Changed property dependencies (array)

      Dependencies of the ruleClass

      Changed items (object): > Rule Class Dependency

      • Changed property name (string)

        Name of RuleClassDependency

      • Changed property id (string)

        ID of RuleClassDependency

      • Changed property ss_class (string)

        Subservice Class of RuleClassDependency

      • Changed property namespace (string)

        Namespace of RuleClassDependency

      • Changed property optional (boolean)

        By default, all dependencies are treated as mandatory, so errors are thrown when a given dependency's parameters cannot be resolved. On the other hand, certain dependencies are conditional upon certain service config or oper data. In these cases, the dependencies should be set as optional, so they can be ignored silently when their respective parameters do not resolve.

      • Changed property sub_dependencies (array)

        Subservice dependencies

      • Changed property soft_sub_dependencies (array)

        The health of these dependencies does not affect the health of its parent subservice

      • Changed property type (string)

        Rule Class Dependency Type

      • Changed property param_extraction_mechanism (object)

        Dependency Param Extraction Mechanism

        • Changed property name (string)

          Name

        • Changed property namespace (string)

          Namespace

        • Changed property version (string)

          Version

        • Changed property validation_hash (string)

          Validation hash

        • Changed property plugin_method (string)

          Plugin method

        • Changed property extracted_params (array)

          Extracted parameters

          Changed items (string): > Items of Extracted parameters

        • Changed property native_method (string)

          Native method

        • Changed property mode (string)

          Parameter Extraction mechanism mode

      • Changed property parameters (array)

        Parameters of RuleClassDependency

        Changed items (object): > Dependency parameter

        • Changed property name (string)

          Name of the Dependency parameter

        • Changed property extraction_method (string)

          Dependency Parameter Type

        • Changed property extraction_details (array)

          Extraction details

          Changed items (object): > Parameter Extraction Detail

          • Changed property description (string)

            Description

          • Changed property extract_value (string)

            Extract value

  • Changed property profiles (array)

    List of RuleConfigProfile items from the files that are part of the package.

    Changed items (object): > ConfigP rofile

    • Changed property id (string)

      ID of ConfigProfile

    • Changed property name (string)

      Name of ConfigProfile

    • Changed property namespace (string)

      Namespace of ConfigProfile

    • Changed property description (string)

      Description of ConfigProfile

    • Changed property create_timestamp (string)

      Create timestamp for ConfigProfile

    • Changed property update_timestamp (string)

      Update timestamp for ConfigProfile

    • Changed property version (string)

      Current version of the configProfile

    • Changed property rules (array)

      Rules of ConfigProfile

      Changed items (object): > RuleConfig Profile Candidate Rule

      • Changed property name (string)

        Name of RuleConfigProfileCandidateRule

      • Changed property namespace (string)

        Namespace of RuleConfigProfileCandidateRule

    • Changed property values (object)

      Subservices can potentially inherit multiple profiles when they are shared across different services. 'Precedence' determines which profile should be adopted by the Subservice. The key is the name of the config parameter (for example: the name of the Threshold constant). The key should be given in ALL CAPS.

POST /assuranceOptions/query

Request:

Changed content type : application/json

• Changed property serviceKey (string)

  Service key

Return Type:

Changed response : **default **

An empty response. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property error (string)

    Error of Runtime error

  • Changed property code (integer)

    Code of Runtime error

  • Changed property message (string)

    Message of Runtime error

  • Changed property details (array)

    Details of Runtime error

    Changed items (object): > ProtobufAny

    • Changed property type_url (string)

      Type-url of ProtobufAny

    • Changed property value (string)

      Value of ProtobufAny

Changed response : 200 OK

OK. The request was successful. The result is contained in the response body. Deleted header : TrackingID

The tracking ID for the request.

Deleted header : Date

The current date and time.

• Changed content type : application/json

  • Changed property serviceKey (string)

    Service key

  • Changed property rule_profile_options (array)

    Rule profile options

    Changed items (object): > Response Assurance Options Details Rule Profile Option

    • Changed property ruleClassId (string)

      Rule Class ID

    • Changed property ruleClassName (string)

      Rule Class Name

    • Changed property ruleClassNs (string)

      Rule Class Namespace

    • Changed property ruleClassDescription (string)

      Rule Class Description

    • Changed property profile_constants (array)

      Profile-constants

      Changed items (string): > Items of Profile-constants

    • Changed property subservice_classes (array)

      Subservice_classes

      Changed items (object): > Response Assurance Options Details Subservice Class Info

      • Changed property id (string)

        Properties

      • Changed property name (string)

        Name

      • Changed property namespace (string)

        Namespace

    • Changed property monitoring_type (string)

      Monitoring Type

    • Changed property config_profiles (array)

      Config_profiles

      Changed items (object): > ConfigP rofile

      • Changed property id (string)

        ID of ConfigProfile

      • Changed property name (string)

        Name of ConfigProfile

      • Changed property namespace (string)

        Namespace of ConfigProfile

      • Changed property description (string)

        Description of ConfigProfile

      • Changed property create_timestamp (string)

        Create timestamp for ConfigProfile

      • Changed property update_timestamp (string)

        Update timestamp for ConfigProfile

      • Changed property version (string)

        Current version of the configProfile

      • Changed property rules (array)

        Rules of ConfigProfile

        Changed items (object): > RuleConfig Profile Candidate Rule

        • Changed property name (string)

          Name of RuleConfigProfileCandidateRule

        • Changed property namespace (string)

          Namespace of RuleConfigProfileCandidateRule

      • Changed property values (object)

        Subservices can potentially inherit multiple profiles when they are shared across different services. 'Precedence' determines which profile should be adopted by the Subservice. The key is the name of the config parameter (for example: the name of the Threshold constant). The key should be given in ALL CAPS.