Universal Event Template Web Services
Overview
Universal Controller supports the following RESTful-based web services for Global Universal Event Templates, which are listed alphabetically on this page.
- Create a Universal Event Template
- Delete a Universal Event Template
- List Universal Event Templates
- Modify a Universal Event Template
- Read a Universal Event Template
Formatting specifications for each web service, including details about parameter requirements, are provided.
Auditing Universal Events
The Universal Event Web Service Publish Audit lets you specify whether or not an audit record is generated for each Universal Event published through the Universal Event Web Services.
(The Universal Event Extension Publish Audit lets you specify whether or not an audit record is generated for each Universal Event published through an Extension-based Universal Task Instance.)
Note
Enabling these audit properties can generate a large quantity of audit.
Create a Universal Event Template
Description | |
---|---|
URI | http://host_name/uc/resources/universaleventtemplate |
HTTP Method | POST |
Description | Creates a Universal Event Template. |
Example URI | http://localhost:8080/uc/resources/universaleventtemplate |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example | See Create, Modify, and Read a Universal Event Template: XML and JSON Examples, below. |
Universal Event Template Properties | |
Example Response |
|
Create, Modify, and Read a Universal Event Template: XML and JSON Examples
XML | JSON |
---|---|
Delete a Universal Event Template
Description | |
---|---|
URI | http://host_name/uc/resources/universaleventtemplate |
HTTP Method | DELETE |
Description | Deletes a Universal Event Template. |
URI Parameters | See Delete a Universal Template URI Parameters, below. |
Example URI | |
Example Response |
|
Delete a Universal Event Template - URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Universal Event Template. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Universal Event Template. | String; URI parameter. | Y (unless |
|
List Universal Event Templates
Description | |
---|---|
URI | http://host_name/uc/resources/universaleventtemplate/list |
HTTP Method | GET |
Description | Retrieves information on Universal Event Templates using specific query parameters. Note System event template will not be included in the list response. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | See List Universal Event Templates: XML and JSON Examples, below. |
Universal Event Template Properties |
List Universal Event Templates - URI Parameters
Parameter | Description | Specifications | Required |
---|---|---|---|
| Name used within the Controller to identify this Universal Event Template. | Wildcards are supported. | N |
List Universal Event Templates: XML and JSON Examples
XML | JSON |
---|---|
Modify a Universal Event Template
Description | |
---|---|
URI | http://host_name/uc/resources/universaleventtemplate |
HTTP Method | PUT |
Description | Modifies the Universal Event Template specified by the sysId in the request. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Example | See Create, Modify, and Read a Universal Event Template: XML and JSON Examples. |
Universal Event Template Properties |
Read a Universal Event Template
Description | |
---|---|
URI | http://host_name/uc/resources/universaleventtemplate |
HTTP Method | GET |
Description | Read a Universal Event Template. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Example | See Create, Modify, and Read a Universal Event Template: XML and JSON Examples. |
Universal Event Template Properties | |
Example Response |
|
Properties
Universal Event Template Properties
The excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate
> element of XML web services.
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Unmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled. | Valid values:
Default is Prohibit Universal Event (1). | N |
| Attributes | Zero or more attributes, specifying their Name, Label, and Type. | N | |
| Description | Description of the Universal Event. | N | |
| Label | User-friendly display name for the event, to be displayed within the client. | The Label must be unique. | Y |
| Name | Unique event name, adhering to the same naming convention as a Universal Template field name. | Y | |
| Time To Live | Default value for Time to live; how long, in minutes, the Universal Event data is valid. | non-negative Integer | N |
| n/a | sys_id used within the Controller to identify this record. | Persisted only if retainSysIds is set to true. | N |
Universal Event Template - Attribute Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Label | User-friendly display name for the attribute, to be displayed within the client. | Attribute Label must be unique. | Y |
| Name | Unique attribute name, adhering to the same naming convention as a Universal Template field name. | Y | |
| Type | Attribute type. | Valid values:
| Y |