Access the Event Web Service

Your entry point to the event web service interface is the Service Document, using the following base URL:

• Secure environments:

  https://<server.example.com>/opr-web/rest/

• Non-TLS environments:

  http://<server.example.com>/opr-web/rest/

where:

<server.example.com> is the name of the gateway server.

For access to the Event Web Service, you must be a valid user, and need to provide your user name and password as credentials for user authentication. Only authorized users can view events, change events, or run actions.

The Service Document lists the URLs of different OPR Event services. These services are listed in List of OPR Event Services in the Service Document.

In the list of URLs in the Service Document, only two of them are actual links:

• Events Service:

  https://<server.example.com>/opr-web/rest/9.10/event_list

  9.10 is the current version of the OMi Event Web Service (not the current OMi version). If the version number is omitted, versions lower than 9.10 of the Event Web Service are addressed.

  This shows a list of all events.

• Event Changes Service:

  https://<server.example.com>/opr-web/rest/event_change_list

  This shows a list of changes to events.

All the other URLs require a parameter to be specified (for instance, the event ID). In case of annotations, for the event for which you want the annotation, you must specify the annotation ID. In List of OPR Event Services in the Service Document, variables that you must specify for each URL are shown in curly brackets, such as {event}, {annotation}, or {custom_attribute}. An example URL specifying the event with the ID 532d3674-684f-419f-a752-b8681ee01a72 would look like this:

https://<server.example.com>/opr-web/rest/9.10/event_list/532d3674-684f-419f-a752-b8681ee01a72

List of OPR Event Services in the Service Document

OPR Event Service	URL
Annotation Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/annotation_list/{annotation}
Annotations Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/annotation_list
Automatic Action Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/auto_action
Custom Attribute Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/custom_attribute_list/{custom_attribute}
Custom Attributes Service	http://<server.example.com>/opr-web/rest/9.10/event_list/{event}/custom_attribute_list
Event Change Service	https://<server.example.com>/opr-web/rest/event_change_list/{event_change}
Event Changes Service	https://<server.example.com>/opr-web/rest/event_change_list
Event Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}
Events Service	https://<server.example.com>/opr-web/rest/9.10/event_list
History Line Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/history_line_list/{history_line}
History Lines Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/history_line_list
Operator Action Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/user_action
Symptom Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/symptom_list/{symptom}
Symptoms Service	https://<server.example.com>/opr-web/rest/9.10/event_list/{event}/symptom_list

In general, for most of the OPR Event services, you can carry out the four supported operations (read, create, update and delete). Exceptions to this are:

• Automatic Action Service and Operator Action Service. For these services you can:

  • Get the state of an action by performing a read operation.
  • Start an action (if it is not already running) by performing a create operation.
  • Stop an action (if it is already in progress) by performing a delete operation.

• Services where only read operations are possible:

  • Event Change Service
  • Event Changes Service
  • History Line Service
  • History Lines Service

At first glance, the two services Event Change and Event Changes return very similar results to the services History Line and History Lines. However, the former services list all event changes, and are not specific to any particular events. The latter services are event-specific, and list changes to events relating to particular events. For more details about History Lines, see History lines.