Universal Template Web Services
Overview
Universal Controller supports the following RESTful-based web services for Universal Templates, which are listed alphabetically on this page.
- Create a Universal Template
- Delete a Universal Template
- List Universal Templates
- Modify a Universal Template
- Read a Universal Template
- Restore Default Universal Template Icon
- Set Universal Template Icon
- Universal Template - Delete Extension Archive
- Universal Template - Download Extension Archive
- Universal Template - Upload Extension Archive
- Universal Template Export
- Universal Template Import
Formatting specifications for each web service, including details about parameter requirements, are provided.
Note
You cannot create, read, modify, or list Built-In Universal Templates.
You can delete Built-In Universal Templates.
Auditing Universal Events
The Universal Event Web Service Publish Audit lets you specify whether or not an audit record is generated for each Universal Event published through the Universal Event Web Services.
(The Universal Event Extension Publish Audit lets you specify whether or not an audit record is generated for each Universal Event published through an Extension-based Universal Task Instance.)
Note
Enabling these audit properties can generate a large quantity of audit.
Create a Universal Template
|
Description |
---|---|
URI |
http://host_name/uc/resources/universaltemplate |
HTTP Method |
POST |
Description |
Creates a new Universal Template. |
Example URI |
http://localhost:8080/uc/resources/universaltemplate |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example |
See Create, Modify, and Read a Universal Template: XML and JSON Examples, below. |
Universal Template Properties |
See Web Services#Universal Template Universal Template Properties. |
Field Properties |
See Field Properties. |
Choice Properties |
See Choice Properties. |
Example Response |
|
Create, Modify, and Read a Universal Template: XML and JSON Examples
The excludeRelated and retainSysIds properties are specified as attributes in XML.
The
exportReleaseLevel
property is specified as an attribute in XML.
XML |
JSON |
---|---|
|
|
Delete a Universal Template
|
Description |
---|---|
URI |
http://host_name/uc/resources/universaltemplate |
HTTP Method |
DELETE |
Description |
Deletes a Universal Template. |
URI Parameters |
See Delete a Universal Template URI Parameters, below. |
Example URI |
http://localhost:8080/uc/resources/universaltemplate?templatename=UT1 |
Example Response |
|
Delete a Universal Template: URI Parameters
Parameter |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|
|
ID used within the Controller to identify this Universal Template. |
String; URI parameter. |
Y (unless |
|
|
Name used within the Controller to identify this Universal Template. |
String; URI parameter. |
Y (unless |
|
List Universal Templates
|
Description |
---|---|
URI |
http://host_name/uc/resources/universaltemplate/list |
HTTP Method |
GET |
Description |
Retrieves information on Universal Templates using specific query parameters. |
Example URI |
|
Authentication |
HTTP Basic |
Produces Content-Type |
application/xml, application/json |
Example |
|
Universal Template Properties |
List Universal Templates: URI Parameters
Parameter |
Description |
Specifications |
Required |
---|---|---|---|
|
Name used within the Controller to identify this Universal Template. |
String; URI parameter. Wildcards are supported. |
N |
List Universal Templates: XML and JSON Examples
XML |
JSON |
---|---|
|
|