Overview
Universal Controller supports the following RESTful-based web service for Universal Events.
Formatting specifications for the web service, including details about parameter requirements, are provided.
Publish Universal Event
Note
When publishing Universal Events through the Web Service API, take into consideration both Universal Controller server and Database server sizings.
The Universal Event Publishing web service is allowed only for users with the ops_admin role.
Description | |
URI | http://host_name/uc/resources/universalevent/publish |
Description | Publsh a global Universal Event. |
HTTP Method | POST |
Example URI | http://localhost:8080/uc/resources/universalevent/publish |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | text/plain |
Example Responses |
|
Publish Universal Event: XML and JSON Example Request
XML Request | JSON Request |
---|---|
Push Universal Event
The push endpoint provides an Inbound Webhook endpoint for third party Webhook integration with Universal Events.
The request body is captured as the
payload
attribute.ttl
andbusinessService
(multi-value) query parameters specify the Universal Event TTL and Member of Business Services, respectively.All other query parameters are captured as attributes with the exception of an
access_token
query parameter.Any character in a query parameter name that is not a letter or digit is converted to an underscore (_).
All headers are captured as attributes with the exception of
authorization
andconnection
.Any character in a header name that is not a letter or digit is converted to an underscore (_).
Description | |
---|---|
URL | http://host_name/uc/resources/universalevent/push/${eventName} |
HTTP Method | POST |
Description | Publish a global Universal Event. |
Consumes Content-Type | application/xml, application/json, text/plain |
Produces Content-Type | text/plain |
Example URI | |
Example Responses |
|