Versions Compared

Old Version 8

changes.mady.by.user Former user

Saved on

compared with

New Version 9

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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

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

...

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
titleXML
Code Block
languagetext
    <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
titleJSON
Code Block
languagetext
    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        }
    ]
N

...

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