...

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.

...

Description

...

URI

...

HTTP Method

...

POST

...

Description

...

Creates a Universal Event Template.

...

Example URI

...

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

...

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

title	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

	Description
URI	http://host_name/uc/resources/universaleventtemplate
HTTP Method

GET

POST

Description

Read

Creates 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

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

Anchor
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template: XML and JSON Examples

...

XML

...

...

The excludeRelated and retainSysIds properties are specified as attributes in the <eventTemplate> element of XML web services.

<attributes> <attribute> <label>attribute_label1</label> <name>attribute_name1</name> <type>Text</type>

Property

UI Field Name

Description

Specifications

Required

name

Name

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

Y

label

Label

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

The Label must be unique.

Y

description

Description

Description of the Universal Event.

N

TTL

Time To Live

Default value for Time to live; how long, in minutes, the Universal Event data is valid.

non-negative Integer

N

attributePolicy

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

attributes

Attributes

Zero or more attributes, specifying their Name, Label, and Type.

Expand

title	XML

Code Block

language	text

JSON

Property

UI Field Name

Description

Specifications

Required

name

Name

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

Y

label

Label

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

The Attribute Label must be unique.

Y

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

Y

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

            <label>attribute_label2</

label> <name>attribute_name2</name> <type>Integer</type> </attribute> </attributes>

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>

{
    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        }

]

Expand

title	JSON

Code Block

language	text

N

...

,
        {
            "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
Delete a Universal Event Template

...

Anchor
List Universal Event Templates
List Universal Event Templates
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

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

Create, Modify, and Read a

List Universal Event

Template

Templates: XML and JSON Examples, below.
Universal Event Template Properties	See Universal Event Template Properties.

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

Parameter	Description	Specifications	Required
`templatename`	Name used within the Controller to identify this Universal Event Template.	Wildcards are supported.	N

Anchor
List Universal Event Templates XML and JSON Examples
List Universal Event Templates XML and JSON Examples
List Universal Event Templates: XML and JSON Examples

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
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 Universal Event Template Properties.

Anchor
Read a Universal Event Template
Read a Universal Event Template
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 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.

Anchor
Properties
Properties
Properties

Anchor
Universal Event Template Properties
Universal Event Template 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

name

Name

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

Y

label

Label

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

The Label must be unique.

Y

description

Description

Description of the Universal Event.

N

TTL

Time To Live

Default value for Time to live; how long, in minutes, the Universal Event data is valid.

non-negative Integer

N

attributePolicy

Anchor

	UET - attributesPolicy
	UET - attributesPolicy

attributesPolicy

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

title	XML

Code Block

language	text

    <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

title	JSON

Code Block

language	text

    "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

Anchor

	UET - label
	UET - label

label

Label

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

The Label must be unique.

Y

Anchor

	UET - name
	UET - name

name

Name

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

Y

Anchor

	UET - ttl
	UET - ttl

ttl

Time To Live

Default value for Time to live; how long, in minutes, the Universal Event data is valid.

non-negative Integer

N

Anchor

	UET - sysId
	UET - sysId

sysId

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

Property	UI Field Name	Description	Specifications	Required

name

Anchor

Name

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

Y

	UETA - label
	UETA - label

label

Label

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

The

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

Y

Versions Compared

Old Version 2

New Version Current

Key

Auditing Universal Events

Anchor
Create a Universal Event Template
Create a Universal Event Template
Create a Universal Event Template

Anchor
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template: XML and JSON Examples

Anchor
Delete a Universal Event Template
Delete a Universal Event Template
Delete a Universal Event Template

Anchor
List Universal Event Templates
List Universal Event Templates
List Universal Event Templates

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

Anchor
List Universal Event Templates XML and JSON Examples
List Universal Event Templates XML and JSON Examples
List Universal Event Templates: XML and JSON Examples

Anchor
Modify a Universal Event Template
Modify a Universal Event Template
Modify a Universal Event Template

Anchor
Read a Universal Event Template
Read a Universal Event Template
Read a Universal Event Template

Anchor
Properties
Properties
Properties

Anchor
Universal Event Template Properties
Universal Event Template Properties
Universal Event Template Properties

Anchor
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Auditing Universal Events

AnchorCreate a Universal Event TemplateCreate a Universal Event TemplateCreate a Universal Event Template

AnchorCreate, Modify, and Read a Universal Event Template XML and JSON ExamplesCreate, Modify, and Read a Universal Event Template XML and JSON ExamplesCreate, Modify, and Read a Universal Event Template: XML and JSON Examples

AnchorDelete a Universal Event TemplateDelete a Universal Event TemplateDelete a Universal Event Template

AnchorList Universal Event TemplatesList Universal Event TemplatesList Universal Event Templates

AnchorList Universal Event Templates - URI ParametersList Universal Event Templates - URI ParametersList Universal Event Templates - URI Parameters

AnchorList Universal Event Templates XML and JSON ExamplesList Universal Event Templates XML and JSON ExamplesList Universal Event Templates: XML and JSON Examples

AnchorModify a Universal Event TemplateModify a Universal Event TemplateModify a Universal Event Template

AnchorRead a Universal Event TemplateRead a Universal Event TemplateRead a Universal Event Template

AnchorPropertiesPropertiesProperties

AnchorUniversal Event Template PropertiesUniversal Event Template PropertiesUniversal Event Template Properties

AnchorUniversal Event Template - Attribute PropertiesUniversal Event Template - Attribute PropertiesUniversal Event Template - Attribute Properties

Anchor
Create a Universal Event Template
Create a Universal Event Template
Create a Universal Event Template

Anchor
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template: XML and JSON Examples

Anchor
Delete a Universal Event Template
Delete a Universal Event Template
Delete a Universal Event Template

Anchor
List Universal Event Templates
List Universal Event Templates
List Universal Event Templates

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

Anchor
List Universal Event Templates XML and JSON Examples
List Universal Event Templates XML and JSON Examples
List Universal Event Templates: XML and JSON Examples

Anchor
Modify a Universal Event Template
Modify a Universal Event Template
Modify a Universal Event Template

Anchor
Read a Universal Event Template
Read a Universal Event Template
Read a Universal Event Template

Anchor
Properties
Properties
Properties

Anchor
Universal Event Template Properties
Universal Event Template Properties
Universal Event Template Properties

Anchor
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties
Universal Event Template - Attribute Properties