...
Universal Controller supports the following RESTful-based web services for Global Universal Event Templates, which are listed alphabetically on this page.
...
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. |
| Anchor |
|---|
| Create a Universal Event Template |
|---|
| Create a Universal Event Template |
|---|
|
Create a Universal Event Template
...
XML | JSON |
|---|
| | Expand |
|---|
|
{
"attributes": [
{
"label": "attribute_label1",
"name": "attribute_name1",
"type": "Text"
},
{
"label": "attribute_label2",
"name": "attribute_name2",
"type": "Integer"
},
{
"label": "attribute_label3",
"name": "attribute_name3",
"type": "Boolean"
},
{
"label": "attribute_label4",
"name": "attribute_name4",
"type": "Float"
}
],
"attributePolicyattributesPolicy": "Include Attributes",
"description": "Global universal event template description.",
"label": "Global Universal Event - Label",
"name": "global_universal_event_template",
"retainSysIds": true,
"sysId": "66c6e90f5a334378809884a11cb12ac0",
"TTLttl": 11
}
|
|
| Anchor |
|---|
| Delete a Universal Event Template |
|---|
| Delete a Universal Event Template |
|---|
|
Delete a Universal Event Template
...
| 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 Create, Modify, and Read a List Universal Event TemplateTemplates: XML and JSON Examples, below. |
Universal Event Template Properties | See Universal Event Template Properties. |
...
XML | JSON |
|---|
| | Expand |
|---|
| [
{
"attributes": [
{
"label": "attribute_label1",
"name": "attribute_name1",
"type": "Text"
},
{
"label": "attribute_label2",
"name": "attribute_name2",
"type": "Integer"
},
{
"label": "attribute_label3",
"name": "attribute_name3",
"type": "Boolean"
},
{
"label": "attribute_label4",
"name": "attribute_name4",
"type": "Float"
}
],
"attributePolicyattributesPolicy": "Include Attributes",
"description": "Global universal event template description.",
"label": "Global Universal Event - Label",
"name": "global_universal_event_template",
"sysId": "66c6e90f5a334378809884a11cb12ac0",
"ttl": 11
},
{
"attributes": [
{
"label": "attribute_label1",
"name": "attribute_name1",
"type": "Integer"
},
{
"label": "attribute_label4",
"name": "attribute_name4",
"type": "Float"
}
],
"attributePolicyattributesPolicy": "Prohibit Universal Event",
"description": "description.",
"label": "Universal Event - Label2",
"name": "universal_event_template2",
"sysId": "982a434746fc4618aa55d7928ba1f3e4",
"ttl": null
},
{
"attributes": [
{
"label": "attribute_label1",
"name": "attribute_name1",
"type": "Integer"
},
{
"label": "attribute_label4",
"name": "attribute_name4",
"type": "Float"
}
],
"attributePolicyattributesPolicy": "Prohibit Universal Event",
"description": "description.",
"label": "Universal Event - Label2 - Copy",
"name": "universal_event_template2_copy",
"sysId": "814b1b35ea844407b6cd378f149d61a3",
"TTLttl": null
|
|
| Anchor |
|---|
| Modify a Universal Event Template |
|---|
| Modify a Universal Event Template |
|---|
|
Modify a Universal Event Template
...
Property | UI Field Name | Description | Specifications | Required |
|---|
| Anchor |
|---|
| UET - attributePolicyattributesPolicy |
|---|
| UET - attributePolicyattributesPolicy |
|---|
|
attributePolicyattributesPolicy
| Unmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled. | Valid values: As String = Prohibit Universal Event, As Value = 1 As String = Include Attributes, As Value = 2 As String = Exclude Attributes, As Value = 3
Default is Prohibit Universal Event (1). | N |
| Anchor |
|---|
| UET - attributes |
|---|
| UET - attributes |
|---|
|
attributes
| Attributes | Zero or more attributes, specifying their Name, Label, and Type. | | Expand |
|---|
| | Code Block |
|---|
| <attributes>
<attribute>
<label>attribute_label1</label>
<name>attribute_name1</name>
<type>Text</type>
</attribute>
<attribute>
<label>attribute_label2</label>
<name>attribute_name2</name>
<type>Integer</type>
</attribute>
</attributes> |
|
| Expand |
|---|
| | Code Block |
|---|
| "attributes": [
{
"label": "attribute_label1",
"name": "attribute_name1",
"type": "Text"
},
{
"label": "attribute_label2",
"name": "attribute_name2",
"type": "Integer"
}
] |
|
| N |
| Anchor |
|---|
| UET - description |
|---|
| UET - description |
|---|
|
description
| 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 |
| Anchor |
|---|
| Universal Event Template - Attribute Properties |
|---|
| Universal Event Template - Attribute Properties |
|---|
|
Universal Event Template - Attribute Properties
...
