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.)

...

	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	See 438090904 Universal Event Template Properties.
Example Response	Status 200 /OK Successfully created the universal event template with id <id>. Status 400 /Bad Request Create universal template failed. (message).

...

XML

JSON

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<eventTemplate retainSysIds="true">
    <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>
        <attribute>
            <label>attribute_label3</label>
            <name>attribute_name3</name>
            <type>Boolean</type>
        </attribute>
        <attribute>
            <label>attribute_label4</label>
            <name>attribute_name4</name>
            <type>Float</type>
        </attribute>
    </attributes>
    <attributesPolicy>Include Attributes</attributesPolicy>
    <description>Global universal event template description.</description>
    <label>Global Universal Event - Label</label>
    <name>global_universal_event_template</name>
    <sysId>66c6e90f5a334378809884a11cb12ac0</sysId>
    <ttl>11</ttl>
</eventTemplate>

Expand

title	JSON

{
    "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"
        }
    ],
    "attributesPolicy": "Include Attributes",
    "description": "Global universal event template description.",
    "label": "Global Universal Event - Label",
    "name": "global_universal_event_template",
    "retainSysIds": true,
    "sysId": "66c6e90f5a334378809884a11cb12ac0",
    "ttl": 11
}

Anchor

	Delete a Universal Event Template
	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 438090904 Delete a Universal Template URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/universaleventtemplate?templatename=global_universal_event_template http://localhost:8080/uc/resources/universaleventtemplate?templateid=66c6e90f5a334378809884a11cb12ac0
Example Response	Status 200 /OK Universal event template deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify templatename and templateid at the same time. Status 404 /Not Found A universal event template with "<{name/id>" does not exist.

...

Description

URI

http://host_name/uc/resources/universaleventtemplate/list

HTTP Method

GET

Description

Retrieves information on Universal Event Templates using specific query parameters.

Note

title	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

See 438090904 Universal Event Template Properties.

Anchor

	List Universal Event Templates - URI Parameters
	List Universal Event Templates - URI Parameters

...

XML

JSON

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<unversialEventTemplates>
    <eventTemplate>
        <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>
            <attribute>
                <label>attribute_label3</label>
                <name>attribute_name3</name>
                <type>Boolean</type>
            </attribute>
            <attribute>
                <label>attribute_label4</label>
                <name>attribute_name4</name>
                <type>Float</type>
            </attribute>
        </attributes>
        <attributesPolicy>Include Attributes</attributesPolicy>
        <description>Global universal event template description.</description>
        <label>Global Universal Event - Label</label>
        <name>global_universal_event_template</name>
        <sysId>66c6e90f5a334378809884a11cb12ac0</sysId>
        <ttl>11</ttl>
    </eventTemplate>
    <eventTemplate>
        <attributes>
            <attribute>
                <label>attribute_label1</label>
                <name>attribute_name1</name>
                <type>Integer</type>
            </attribute>
            <attribute>
                <label>attribute_label4</label>
                <name>attribute_name4</name>
                <type>Float</type>
            </attribute>
        </attributes>
        <attributesPolicy>Prohibit Universal Event</attributesPolicy>
        <description>description.</description>
        <label>Universal Event - Label2</label>
        <name>universal_event_template2</name>
        <sysId>982a434746fc4618aa55d7928ba1f3e4</sysId>
        <ttl />
    </eventTemplate>
    <eventTemplate>
        <attributes>
            <attribute>
                <label>attribute_label1</label>
                <name>attribute_name1</name>
                <type>Integer</type>
            </attribute>
            <attribute>
                <label>attribute_label4</label>
                <name>attribute_name4</name>
                <type>Float</type>
            </attribute>
        </attributes>
        <attributesPolicy>Prohibit Universal Event</attributesPolicy>
        <description>description.</description>
        <label>Universal Event - Label2 - Copy</label>
        <name>universal_event_template2_copy</name>
        <sysId>814b1b35ea844407b6cd378f149d61a3</sysId>
        <ttl />
    </eventTemplate>
</unversialEventTemplates>

Expand

title	JSON

[
    {
        "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"
            }
        ],
        "attributesPolicy": "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"
            }
        ],
        "attributesPolicy": "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"
            }
        ],
        "attributesPolicy": "Prohibit Universal Event",
        "description": "description.",
        "label": "Universal Event - Label2 - Copy",
        "name": "universal_event_template2_copy",
        "sysId": "814b1b35ea844407b6cd378f149d61a3",
        "ttl": null

Anchor

	Modify a Universal Event Template
	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	http://localhost:8080/uc/resources/universaleventtemplate
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	See 438090904 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	http://localhost:8080/uc/resources/universaleventtemplate?templatename=global_universal_event_template http://localhost:8080/uc/resources/universaleventtemplate?templateid=66c6e90f5a334378809884a11cb12ac0
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	See 438090904 Universal Event Template Properties.
Example Response	Status 200 /OK Successfully created the universal event template with id <id>. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `templatename` and `templateid` at the same time. Required either `templatename` of `templateid`. Status 404 /Not Found A universal event template with "<{name/id>" does not exist.

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	UETA - label
	UETA - label

label

Label

User-friendly display name for the attribute, to be displayed within the client.

Attribute Label must be unique.

Y

Anchor

	UETA - name
	UETA - name

name

Name

Unique attribute name, adhering to the same naming convention as a Universal Template field name.

Y

Anchor

	UETA - type
	UETA - type

type

Type

Attribute type.

Valid values:

As String = Text, As Value = 1
As String = Integer, As Value = 2
As String = Boolean, As Value = 3
As String = Float, As Value = 4
As String = Text Array, As Value = 5
As String = Integer Array, As Value = 6
As String = Boolean Array, As Value = 7
As String = Float Array, As Value = 8

Y

Versions Compared

Old Version 2

New Version Current

Key

Auditing Universal Events

Read a Universal Event Template

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Auditing Universal Events

Read a Universal Event Template