Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

Universal Controller supports the following RESTful-based web services for Universal Event Templates, which are listed alphabetically on this page.

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.

 XML
    <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>
 JSON
    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        }
    ]
N

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


Create a Universal Event Template


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



Create, 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.


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.

 XML
    <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>
 JSON
    "attributes": [
        {
            "label": "attribute_label1",
            "name": "attribute_name1",
            "type": "Text"
        },
        {
            "label": "attribute_label2",
            "name": "attribute_name2",
            "type": "Integer"
        }
    ]
N

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



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 Delete a Universal Template URI Parameters, below.

Example URI

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.

Delete a Universal Event Template - URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

templateid

ID used within the Controller to identify this Universal Event Template.

String; URI parameter.

Y (unless templatename is specified)

templatename

templatename

Name used within the Controller to identify this Universal Event Template.

String; URI parameter.

Y (unless templateid is specified)

templateid


List Universal Event Templates: XML and JSON Examples






  • No labels