...
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 | |
Example Response |
|
Anchor |
---|
...
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
...
|
...
|
...
Universal Event Template Properties
...
See Universal Event Template Properties.
...
Example Response
...
...
|
...
Anchor | |
---|---|
|
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 | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
...
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 | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
Description | ||||||
---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/universaleventtemplate/list | |||||
HTTP Method | GET | |||||
Description | Retrieves information on Universal Event Templates using specific query parameters.
| |||||
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 |
Anchor | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
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 | |
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 |
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 | See Create, Modify, and Read a Universal Event Template: XML and JSON Examples. |
Universal Event Template Properties | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
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:
Default is Prohibit Universal Event (1). | N | ||||||||||||||||||||
attributes | Attributes | Zero or more attributes, specifying their Name, Label, and Type. |
| N |
Anchor | ||||
---|---|---|---|---|
|
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:
| Y |