Overview

Universal Controller supports the following RESTful-based web service for Universal Events.

Universal Event Publishing

The Universal Event Publishing web service is allowed only for users with the ops_admin role.

Formatting specifications for the web service, including details about parameter requirements, are provided.

Universal Event Publishing

	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/audit/list
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Responses	Status 200 Universal Event "{eventname}" published. Status 400 Invalid Time To Live. Value must be non-negative or empty. Universal Event attributes unknown for Universal Event Template "{eventname}". Universal Event attribute name required. Universal Event attribute "{attributename}" duplicated. Universal Event attribute "{attributename}" unknown for Universal Event Template "{eventname}". Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid integer. Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid float. Status 403 Operation prohibited due to security constraints. Status 404 Universal Event Template "{eventname}" not found. A universal template with id "{templateid}" does not exist. Status 500 Unexpected request failure. See log(s) for more details.

Universal Event Publishing: XML and JSON Examples

Universal Event Publishing: Example Request

XML Request

JSON Request

XML

<?xml version="1.0" encoding="UTF-8" ?>
<universalEvent>
  <name>ExampleEvent</name>
  <businessServices>
    <businessService>BusinessServiceName1</businessService>
    <businessService>BusinessServiceName2</businessService>
  </businessServices>
  <ttl>60</ttl>
  <attributes>
    <attribute>
      <name>example_attribute1</name>
      <value>Value1</value>
    </attribute>
    <attribute>
      <name>example_attribute2</name>
      <value>Value2</value>
    </attribute>
  </attributes>
</universalEvent>

JSON

{
	"name": "ExampleEvent",
    "businessServices": [
      "BusinessServiceName1",
      "BusinessServiceName2"
    ],
	"ttl": 60,
	"attributes": [
		{
			"name": "example_attribute1",
			"value": "Value1"
		},
		{
			"name": "example_attribute2",
			"value": "Value2"
		}
	]
}

Universal Event Publishing: Request Properties

Property	UI Field Name	Description	Specifications	Required
auditType	Audit Type	Audit type to filter the data.	Valid values: One of the following (not case sensitive): As String = Create, As Value = 1 As String = Update, As Value = 2 As String = Delete, As Value = 3 As String = Command, As Value = 4 As String = Server Operation, As Value = 5 As String = CLI, As Value = 6 As String = Restore Version, As Value = 7 As String = Delete Version, As Value = 8 As String = User Login, As Value = 9 As String = z/OS Auto-Restart, As Value = 10 As String = Delete Override File, As Value = 11 As String = Import, As Value = 12 As String = Export, As Value = 13 As String = Email, As Value = 14	N
source	Source	Audit source type	Valid values: One of the following (not case sensitive): As String = User Interface, As Value = 1 As String = Command Line, As Value = 2 As String = Web Service, As Value = 3 As String = System Operation, As Value = 4 As String = Set Variable Action, As Value = 5 As String = Task Instance, As Value = 6 As String = Agent Message, As Value = 7 As String = Scheduled, As Value = 8 As String = Stored Procedure, As Value = 9 As String = System Processing, As Value = 10 As String = Email Notification, As Value = 11	N
updatedTime	n/a	If `updatedTimeType` = Offset; -offset period.	Valid values: mn (minutes) h (hours) d (days) Default is d. Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days). If `updatedTimeType` is Since; date/time value (yyyy-MM-dd [HH:mm:ss]) If `updatedTimeType` is Today; `updatedTime` is ignored.	Y (if `updatedTimeType` is `Offset`, `Since`, or `Older Than`.)
`updatedTimeType`	n/a	Type of `updateTime`.	Valid values: As String = Today, As Value = 1 As String = Offset, As Value = 2 As String = Since, As Value = 3 As String = Older Than, As Value = 4	N
createdBy	Created By	Name of the person created the record.		N
status	Status	Status of the record		N
tableRecordName	Table Record Name	table record name		N
tableName	Table Name	table name		N
tableKey	Table Key	table key		N
includeChildAudits	n/a	include child audits	boolean property Valid values: true, false, 1, 0	N

Universal Event Web Services

Overview

Universal Event Publishing

Universal Event Publishing: XML and JSON Examples

Universal Event Publishing: Example Request

Universal Event Publishing: Request Properties