Event message or variables missing in REST API response for DX NetOps Spectrum

Products

• Network Observability
• Spectrum

Issue/Introduction

When querying events via the DX NetOps Spectrum RESTful API using the rs:get-event-request schema, the response returns the Event ID and requested model attributes but does not include the formatted event message or event variables by default. This occurs even when the event (such as 0x82105a for configuration changes) contains necessary data in the OneClick view.

Environment

• DX NetOps Spectrum
• RESTful API

Resolution

To retrieve the formatted event message and associated event variables through the REST API, include the internal attribute 0x4820007 in the request payload.

Follow these steps to modify the XML request:

1. Open the XML body for the rs:get-event-request.

2. Add the attribute ID 0x4820007 to the <rs:requested-attribute> section.

   Example Request Snippet:
   
   

   <?xml version="1.0" encoding="UTF-8"?>
<rs:get-event-request xmlns:rs="http://www.ca.com/spectrum/restful/schema/request">
  <rs:get-events-filter start-time="####" end-time="####" include-events="0x82105a" />
  <rs:requested-attribute id="0x1006e" /> <!-- Model Name -->
  <rs:requested-attribute id="0x4820007" /> <!-- Event Message/Variables -->
</rs:get-event-request>

    

3. Execute the API call. The response now contains the full event text, such as: "The current configuration model: 0x####".

Additional Information

or further guidance on API structures, see the DX NetOps Spectrum REST API Documentation.