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

...

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

...

Create, Modify, and Read a Universal Event Template

...

XML and JSON Examples

...

Universal Event Template Properties

...

See Universal Event Template Properties.

...

Example Response

...

Create

...

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

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

...

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

...

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

    <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"
        }
    ]

...

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

...

.

...

Valid values:

...

As String = Text, As Value = 1

...

As String = Integer, As Value = 2

...

As String = Float, As Value = 4

...

Y

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 Universal Event Template: XML and JSON Examples, below.

Universal Event Template Properties

See Universal Event Template Properties.

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

	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 Create universal template failed. (message).

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

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

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

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

Versions Compared

Old Version 2

New Version 3

Key

Anchor

Create, Modify, and Read a Universal Event Template

XML and JSON Examples

Create

Anchor
Create, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template XML and JSON ExamplesCreate, 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 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 3

Key

Anchor

Create, Modify, and Read a Universal Event Template

XML and JSON Examples

Create

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 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, Modify, and Read a Universal Event Template XML and JSON Examples
Create, Modify, and Read a Universal Event Template XML and JSON ExamplesCreate, 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 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