...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
asynchronous | Asynchronous | If If | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||
| Execution Option | Specification for whether the command runs out-of-process execution or in-process execution. | Valid values:
Default is Out Of Process. | N | ||||||||||||||||||||
| Dependent Fields | Universal Template fields (if any) that are required by the command. The values of those fields are included in the command request. |
Valid values for field:
| N | ||||||||||||||||||||
| Label | User-friendly display name for the command, to be displayed within the client. | Y | |||||||||||||||||||||
| Name | Unique name of this command, adhering to the same naming convention as a Universal Template field name. | Y | |||||||||||||||||||||
| Supported Status(es) | Task instance status(es) that the dynamic command should be enabled for. |
Valid values for status:
| Y | ||||||||||||||||||||
sysId | n/a | sys_id used within the Controller to identify this Universal Template Field. | Persisted only if retainSysIds is set to true. | N | ||||||||||||||||||||
| Timeout (Seconds) | Optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds. | N |
Anchor |
---|
...
|
...
|
...
|
...
|
...
Universal Event Template
...
A Universal Template cannot have its icon restore or set to the default without appropriate update permissions. Additionally, built-in templates cannot be the targets of these requests.
...
Description
...
URI
...
http://host_name/uc/resources/universaltemplate/restoredefaulticon
...
HTTP Method
...
POST
...
Description
...
Restores the icon of a specific Universal Template to its default.
...
URI Parameters
...
See Restore Default Universal Template: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/universaltemplate/restoredefaulticon?templatename=Template1
- http://localhost:8080/uc/resources/universaltemplate/restoredefaulticon?templateid=a7de2b3601af48ab886e6a8b7ecec0da
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
plain/text
...
Example Response
...
Status 200
Successfully restored the default icon for Universal Template “{templatename}”.
Universal Template "{templatename}" already using the default icon.
Status 403
Operation prohibited due to security constraints.
Status 404
A Universal Template with name “{templatename}” does not exist.
A Universal Template with id "{templateid}" does not exist.
Status 500
Unexpected request failure. See log(s) for more details.
Note | ||
---|---|---|
| ||
The Post request must include an attached binary file; specifically, it must be a 48 x 48 pixel PNG file. The process will fail if either:
|
...
Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
templateid
...
ID used within the Controller to identify the Universal Template.
...
String; URI parameter
...
Y
(unless templatename
is specified)
...
templatename
...
templatename
...
Name used within the Controller to identify the Universal Template.
...
String; URI parameter
...
Y
(unless templateid
is specified)
...
templateid
...
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 | The unique event name, adhering to the same naming convention as a Universal Template field name. | Y | |||||||||||||||||||||
label | Label | A user friendly display name for the event, to be displayed within the client. | The Label must be unique. | Y | ||||||||||||||||||||
description | Description | An option 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 | ||||
---|---|---|---|---|
|
A Universal Template cannot have its icon restore or set to the default without appropriate update permissions. Additionally, built-in templates cannot be the targets of these requests.
Description | ||||||
---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/universaltemplate/seticonrestoredefaulticon | |||||
HTTP Method | POST
| |||||
Description | Upload a 48 x 48 pixel to be set as the custom icon for a specific Universal Template. | |||||
Description | Restores the icon of a specific Universal Template to its default. | |||||
URI Parameters | See Restore Default Universal Template: URI Parameters, below. | |||||
Example URI | ||||||
Authentication | HTTP Basic | |||||
Consumes Content-Type | application/octet-stream, image/pngn/a | |||||
Produces Content-Type | plain/text | |||||
Example Response |
|
Note | ||
---|---|---|
| ||
The Post request must include an attached binary file; specifically, it must be a 48 x 48 pixel PNG file. The process will fail if either:
|
Anchor |
---|
...
|
...
|
...
Restore Default Universal Template Icon: URI Parameters
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Anchor |
---|
...
|
A Universal Template cannot have its icon restore or set to the default without appropriate update permissions. Additionally, built-in templates cannot be the targets of these requests.
Description | |||||||
---|---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/universaltemplate/extensionseticon | ||||||
HTTP Method | DELETE | ||||||
Description | Delete an Extension Archive for a Universal Template. | ||||||
URI Parameters | See Delete Extension Archive: URI Parameters, below | POST
| |||||
Description | Upload a 48 x 48 pixel to be set as the custom icon for a specific Universal Template. | ||||||
Example URI | extension | ||||||
Authentication | HTTP Basic | ||||||
Consumes Content-Type | n/a application/octet-stream, image/png | ||||||
Produces Content-Type | nplain/atext | ||||||
Example Response |
|
...
The following URI parameters will be needed for deleting the Extension Archive.
...
Name
Note | ||
---|---|---|
| ||
The Post request must include an attached binary file; specifically, it must be a 48 x 48 pixel PNG file. The process will fail if either:
|
Anchor | ||||
---|---|---|---|---|
|
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Example
...
...
curl --request DELETE "http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1" --header "Authorization: Basic ****************"
...
Anchor | ||
---|---|---|
|
...
|
...
Delete Extension Archive
Description | |
---|---|
URI | |
HTTP Method | GETDELETE |
Description | Download Delete an Extension Archive for a Universal Template. |
URI Parameters | See Download Delete Extension Archive: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1 |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | applicationn/octet-streama |
Example Response |
|
Anchor |
---|
...
|
...
|
...
Delete Extension Archive: URI Parameters
The following URI parameters will be needed for downloading deleting the Extension Archive.
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Example
Code Block | ||
---|---|---|
| ||
curl --location --request GETDELETE "http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1" --header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************" -O -J |
Anchor |
---|
...
|
...
|
...
Download Extension Archive
Description | |||||
---|---|---|---|---|---|
URI | |||||
HTTP Method | POST Note |
GET | |||
Description | Upload Download an Extension Archive for a Universal Template. | ||||
URI Parameters | See Upload Download Extension Archive: URI Parameters, below. | ||||
Example URI | http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1 | ||||
Authentication | HTTP Basic | ||||
Consumes Content-Typeapplication/octet-stream, application/zip, application/x-zip-compressed | n/a | ||||
Produces Content-Type | plainapplication/textoctet-stream | ||||
Example Response |
|
Anchor |
---|
...
|
...
|
...
Download Extension Archive: URI Parameters
The following URI parameters will be needed for uploading downloading the Extension Archive.
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
Example
Code Block | ||
---|---|---|
| ||
curl --location -data-binaryrequest @extension.zipGET "http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1" --header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************" -O -J |
...
Anchor |
---|
...
|
...
Upload Extension Archive
Description | |||||
---|---|---|---|---|---|
URI | http://host_name/uc/resources/universaltemplate/exporttemplateextension | ||||
HTTP Method | Example URI | POSTGET
| |||
Description | Download the zip file of a Universal Template specified by a URI parameter. The file will contain the following entries:
| ||||
URI Parameters | See Universal Template Export: URI Parameters, below. | ||||
| |||||
Description | Upload an Extension Archive for a Universal Template. | ||||
URI Parameters | See Upload Extension Archive: URI Parameters, below. | ||||
Example URI | http://localhost:8080/uc/resources/universaltemplate/ exporttemplateextension?templatename=Template1 | ||||
Authentication | HTTP Basic | ||||
Consumes Content-Type | n/aapplication/octet-stream, application/zip, application/x-zip-compressed | ||||
Produces Content-Type | applicationplain/octet-streamtext | ||||
Example Response |
|
Anchor |
---|
...
|
...
|
...
Upload Extension Archive: URI Parameters
The following URI parameters will be needed for exporting uploading the Universal TemplateExtension Archive.
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||
---|---|---|---|---|---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
| |||||
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
| excludeExtension | n/aIndication of whether the extension archive zip file should be excluded in the export operation. | Boolean (True/False, true/false); URI parameter | N (false by default) |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --location data--request GETbinary @extension.zip "http://localhost:80088080/uc/resources/universaltemplate/exporttemplateextension?templatename=Template1" --header "Content-Type: application/octet-stream" --header "Authorization: Basic xxxxxxxxxxxxxxxxxxx" -O -J |
Export File Entries
...
--header "Authorization: Basic ****************" |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/universaltemplate/exporttemplate |
HTTP Method | GET |
Description | Download the zip file of a Universal Template specified by a URI parameter. The file will contain the following entries:
|
URI Parameters | See Universal Template Export: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/octet-stream |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
The following URI parameters will be needed for exporting the Universal Template.
Name | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | ID used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
| n/a | Name used within the Controller to identify the Universal Template. | String; URI parameter | Y |
|
excludeExtension | n/a | Indication of whether the extension archive zip file should be excluded in the export operation. | Boolean (True/False, true/false); URI parameter | N (false by default) |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --location --request GET "http://localhost:8008/uc/resources/universaltemplate/exporttemplate?templatename=Template1"
--header "Content-Type: application/octet-stream" --header "Authorization: Basic xxxxxxxxxxxxxxxxxxx" -O -J |
Export File Entries
The downloaded Universal Template zip file will include the following required/optional entries:
File Name | Description | Present If… |
---|---|---|
template.json | The Universal Template definition in JSON format. | Always |
template_icon.png | The Universal Template Icon in PNG format. Icon metadata will be set as attributes in the Universal Template JSON. | The template has an icon. |
extension_archive.zip | The Universal Template Extension Archive in ZIP format. | The template has an extension and the optional query parameter excludeExtension is not set to true. |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/universaltemplate/importtemplate |
HTTP Method | POST |
Description | Upload the zip file of a Universal Template to be created/updated. |
URI Parameters | See Universal Template Import: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/universaltemplate/importtemplate |
Authentication | HTTP Basic |
Consumes Content-Type | application/octet-stream, application/zip, application/x-zip-compressed |
Produces Content-Type | plain/text |
Example Response |
|
Binary Data
The uploaded Universal Template zip file will include the following required/optional entries:
File Name | Description | Present If…Optional |
---|---|---|
template.json | The Universal Template definition in JSON format. | AlwaysNo |
template_icon.png | The Universal Template Icon in PNG format. Icon metadata will be set as attributes in the Universal Template JSON. | The template has an icon.Yes |
extension_archive.zip | The Universal Template Extension Archive in ZIP format. | The template has an extension and the optional query parameter excludeExtension is not set to true. |
...
Description | |
---|---|
URI | http://host_name/uc/resources/universaltemplate/importtemplate |
HTTP Method | POST |
Description | Upload the zip file of a Universal Template to be created/updated. |
URI Parameters | See Universal Template Import: URI Parameters, below. |
Example URI | Yes |
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data-binary @unv-tmplt-Template1.zip "http://localhost:8080/uc/resources/universaltemplate/importtemplate |
...
" --header "Content-Type |
...
: application/octet-stream |
...
Produces Content-Type
...
plain/text
...
Example Response
...
Status 200
Successfully imported universal template. Created new template with id {sysid}
Successfully imported universal template. Updated existing template with id {sysId}
Status 400
The attached Template is invalid. Please re-import your Template.
Template cannot be greater than {maximum_template_size} bytes.
Template must contain template.json/template_icon.png/extension_archive.zip.
Cluster Node release level is {current_release_level}, which does not meet the minimum release level of {min_release_level} for the Template.
Status 500
Unexpected request failure. See log(s) for more details.
Operation prohibited due to security constraints.
Binary Data
The uploaded Universal Template zip file will include the following required/optional entries:
...
File Name
...
Description
...
Optional
...
template.json
...
The Universal Template definition in JSON format.
...
No
...
template_icon.png
...
The Universal Template Icon in PNG format.
Icon metadata will be set as attributes in the Universal Template JSON.
...
Yes
...
extension_archive.zip
...
The Universal Template Extension Archive in ZIP format.
...
Yes
Example
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data-binary @unv-tmplt-Template1.zip "http://localhost:8080/uc/resources/universaltemplate/importtemplate" --header "Content-Type: application/octet-stream" --header "Authorization: Basic ****************"" --header "Authorization: Basic ****************" |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/universaleventtemplate |
HTTP Method | POST |
Description | Creates a new Universal Event Template. |
Example URI | http://localhost:8080/uc/resources/universaleventtemplate |
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 | |
Field Properties | See Field Properties. |
Choice Properties | See Choice Properties. |
Example Response |
|