Trouble Management Web Service
Trouble Management web service provide access to the subset of the trouble management functionality available in the Oracle Utilities Network Management System.
Port TroubleServiceSOAP
Location: https://<nms host>:<nms port>/nms/trouble
Protocol: SOAP
Default Style: document
Transport Protocol: SOAP over HTTP
Target Namespace: http://oms.splwg.com/ws/trouble/
Operations
CreateEvent
Creates new event in NMS.
Operation Type: Request-response. The endpoint receives a message and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/trouble/CreateEvent
Input: CreateEventRequest (soap:body, use = literal)
parameters type CreateEvent
status type jobConditionStatus - type string with restriction - enum { 'NO_OUTAGE', 'PROBABLE_SERVICE_OUTAGE', 'PROBABLE_DEVICE_OUTAGE', 'REAL_SERVICE_OUTAGE', 'REAL_DEVICE_OUTAGE', 'RESERVED_5', 'RESERVED_6', 'NON_OUTAGE', 'CRITICAL_MEET', 'FUTURE_MEET', 'CONFIRMED_SERVICE_OUTAGE', 'CONFIRMED_SECONDARY_OUTAGE', 'ADDITIONAL_ALARM', 'PROBABLE_MOMENTARY_OUTAGE', 'REAL_MOMENTARY_OUTAGE', 'PLANNED_OUTAGE', 'NON_ELECTRIC_EVENT', 'SWITCHING_JOB', 'FAULT_CURRENT_EVENT', 'CVR_JOB' }
Condition status
device - optional; type handle
Device handle
deviceAlias - optional; type string
Device alias. If device handle is not provided device alias is used to determine it
phases - optional; type phaseCode
Affected device phases (default: all phases)
groupable - optional; type boolean
Groupable flag (default: non-groupable)
beginTime - optional; type dateTime
Event begin time (default: current time)
restoreTime - optional; type dateTime
Event restoration time (only applicable to momentary outages)
priority - optional; type int
Event priority
appliedRule - optional; type int
Initial applied rule value. When creating real momentary outage value 3 (SRS_SCADA) indicates that this is SCADA-reported event
accidental - optional; type int
0 - normal, 1 - accidental, 2 - planned
numMomentaries - optional; type int
Number of momentaries (only applicable to momentary outages)
description - optional; type string
Description text
dispatchGroup - optional; type string
Dispatch group
userCustOut - optional; type int
Number of customers affected by the created event. Populates USER_CUST_OUT field in the created event
ddsAlarm - optional; type handle
Handle of the DDS alarm (device operation) related to the event being created.
switchingPlan - optional; type handle
When creating SWITCHING_JOB event this element must be populated with the switching plan handle.
Output: CreateEventResponse (soap:body, use = literal)
parameters type CreateEventResponse
event type handle
Handle of the created event
Fault: TroubleServiceException (soap:fault, use = literal)
parameters type TroubleServiceFault
SetGenericFields
Updates generic fields of an existing event in NMS.
Operation Type: Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action: http://oms.splwg.com/ws/trouble/SetGenericFields
Input: SetGenericFieldsRequest (soap:body, use = literal)
parameters type SetGenericFields
• event - optional; type handle
Event handle
• externalId - optional; type string
Event's external id.
• fields type ArrayOfStringPair
Generic field values (list of name-value pairs).
Output: None.
Fault: TroubleServiceException (soap:fault, use = literal)
parameters type TroubleServiceFault
Faults
TroubleServiceFault
• errors - unbounded; type Error
List of errors
• error type errorCode
Error code.
Valid values: 'ERROR', 'UNKNOWN_EVENT', 'UNKNOWN_GENERIC_FIELD', 'COMPLETED_EVENT'.
• errorMessage type string
Error message
• eventIdx type int
Event index associated with the error