...
- Create a Universal Event Template
- Delete a Universal Event Template
- List Universal Event Templates
- Modify a Universal Event Template
- Read a Universal Event Template
Formatting specifications for each web service, including details about parameter requirements, are provided.
| Anchor | ||||
|---|---|---|---|---|
|
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 | |
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 | |
Example Response |
|
| Anchor | ||||
|---|---|---|---|---|
|
The excludeRelated and retainSysIds properties are specified as attributes in the <universalTemplate> element of XML web services.
| 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 |
| Anchor |
|---|
...
|
...
|
...
Delete a Universal Event Template
Description | |
|---|---|
URI | http://host_name/uc/resources/universaleventtemplate |
HTTP Method | POST |
Description | Creates a Universal Event Template. |
DELETE | |
Description | Deletes a Universal Event Template. |
URI Parameters | See Delete a Universal Template URI Parameters, below. |
Example URI | |
Example Response |
|
| Anchor | ||||
|---|---|---|---|---|
|
Parameter | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|
| ID used within the Controller to identify this Universal Event Template. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Universal Event Template. | String; URI parameter. | Y (unless |
|
| 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 |
n/a
Example | See Create, Modify, and Read a Universal Event Template: XML and JSON Examples, below. |
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 | ||||
|---|---|---|---|---|
|
| 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 | ||||
|---|---|---|---|---|
|
| 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 |
...
Parameter | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|
type | Type | Attribute type. | Valid values:
| Y |
...
Description
...
URI
...
HTTP Method
...
DELETE
...
Description
...
Deletes a Universal Event Template.
...
URI Parameters
...
See Delete a Universal Template URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/universaleventtemplate?templatename=global_universal_event_template
- http://localhost:8080/uc/resources/universaleventtemplate?templateid=66c6e90f5a334378809884a11cb12ac0
...
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.
...
templateid | ID used within the Controller to identify this Universal Event Template. | String; URI parameter. | Y (unless |
|
| Name used within the Controller to identify this Universal Event Template. | String; URI parameter. | Y (unless |
|
...