Jump to

• Request
• Response

Initiate a Request for Synchronization of Events or Alarms

post

/rest/{versionId}/fault/trapReceivers/{trapReceiverId}/action

Use this (POST) method to request that the SDM server re-send events or alarms within a specific time range to the trap receiver targeted by its identifier. SDM resends alarms to this northbound trap receiver only if the type is set to syncActiveAlarm, or it resends events if the type is set to syncAlarm. This method is used to retrieve events or alarms that may not have been received by a northbound server because the system is down or there are network partitions. Using this method for a northbound system can request and synchronize with events or alarms that may have been missed during a connectivity downtime event.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• trapReceiverId: string
• versionId: string

Body ()

Root Schema : alarmAction

Type: object

Show Source

• endTime(optional): string
• minimumSeverity(optional): string
• startTime(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "minimumSeverity":{
            "type":"string"
        }
    },
    "xml":{
        "name":"alarmAction"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : alarmActionResult

Type: object

Show Source

• forwardedAlarms(optional): integer(int32)
• status(optional): string
• trapReceiverId(optional): string
• trapReceiverIpAddress(optional): string

{
    "type":"object",
    "properties":{
        "trapReceiverId":{
            "type":"string"
        },
        "trapReceiverIpAddress":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "forwardedAlarms":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"alarmActionResult"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top