/
Universal Template Web Services

Universal Template Web Services

Dec 15, 2022

Overview

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

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 Universal Template Properties.

Field Properties

See Field Properties.

Choice Properties

See Choice Properties.

Example Response

  • Status 200 /OK
    Successfully created the universal template with sysId {sysId}.

  • Status 400 /Bad Request
    Create universal template failed. (message)

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

<universalTemplate exportReleaseLevel="7.2.0.0" retainSysIds="true"> <agent /> <agentCluster /> <agentClusterVar /> <agentFieldsRestriction>No Restriction</agentFieldsRestriction> <agentType>Windows</agentType> <agentVar /> <alwaysCancelOnFinish /> <automaticOutputRetrievalFieldsRestriction>Hidden</automaticOutputRetrievalFieldsRestriction> <broadcastCluster /> <broadcastClusterVar /> <commands>               <command>              <asynchronous>true</asynchronous>               <executionOption>In Process</executionOption>               <fields />                  <label>1</label>              <name>command</name>                 <statuses>                       <status>Queued</status>          </statuses>                 <sysId>db947be2c7f046dea54e3e49d3c1d349</sysId>             <timeout />           </command>          <command>                  <asynchronous>false</asynchronous>               <executionOption>Out Of Process</executionOption>               <fields/>                 <label>2</label>             <name>command2</name>              <statuses>                    <status>Queued</status>         </statuses>         <sysId>e9ddbdbba21d451c8baf3cf11db48c3b</sysId>              <timeout />           </command>      </commands>    <createConsole>false</createConsole>    <credentialFieldsRestriction>Hidden</credentialFieldsRestriction>    <credentials />    <credentialsVar />    <description />    <desktopInteract>false</desktopInteract>    <elevateUser>false</elevateUser>    <environment />    <environmentVariablesFieldsRestriction>Read Only</environmentVariablesFieldsRestriction>   <events>         <event>              <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>               <attribute>                      <label>attribute_label3</label>                      <name>attribute_name3</name>                      <type>Boolean</type>               </attribute>               <attribute>                      <label>attribute_label4</label>                      <name>attribute_name4</name>                      <type>Float</type>               </attribute>              </attributes>              <attributesPolicy>Include Attributes</attributesPolicy>              <description>Global universal event template description.</description>              <label>Global Universal Event - Label</label>              <name>global_universal_event_template</name>              <sysId>66c6e90f5a334378809884a11cb12ac0</sysId>              <ttl>11</ttl>         </event>   <events>    <exitCodeOutput />    <exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>    <exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction>    <exitCodeText />    <exitCodes>0</exitCodes>    <fields>        <field>            <arrayNameTitle />            <arrayValueTitle />            <booleanNoValue />            <booleanValueType>true/false</booleanValueType>            <booleanYesValue />            <choiceAllowEmpty>false</choiceAllowEmpty>            <choiceAllowMultiple>false</choiceAllowEmpty>            <choiceSortOption>Sequence</choiceSortOption>            <choices />            <defaultListView>false</defaultListView>                         <extensionStatus>false</extensionStatus>            <fieldLength />            <fieldMapping>Text Field 1</fieldMapping>            <fieldType>Text</fieldType>            <fieldValue />            <formColumnSpan>1</formColumnSpan>            <formEndRow>false</formEndRow>            <formStartRow>false</formStartRow>            <hint />            <intFieldMax />            <intFieldMin />            <label>Service</label>            <name>service</name>            <noSpaceIfHidden>true</noSpaceIfHidden>            <preserveValueIfHidden>false</preserveValueIfHidden>            <required>false</required>            <requireIfField />            <requireIfFieldValue />            <requireIfVisible>true</requireIfVisible>            <sequence>0</sequence>            <showIfField>Boolean Field 1</showIfField>            <showIfFieldValue>true</showIfFieldValue>            <sysId>f30ae218f2c64e0a96c5c64a7523e215</sysId>        </field>        <field>            <arrayNameTitle />            <arrayValueTitle />            <booleanNoValue />            <booleanValueType>true/false</booleanValueType>            <booleanYesValue />            <choiceAllowEmpty>false</choiceAllowEmpty>            <choiceAllowMultiple>false</choiceAllowEmpty>            <choiceSortOption>Sequence</choiceSortOption>            <choices>                <choice>                <fieldValue>1</fieldValue>                <fieldValueLabel>Start</fieldValueLabel>                <sequence>0</sequence>                <sysId>95b7d388a2ec407cb5f36768482449b0</sysId>                <useFieldValueForLabel>false</useFieldValueForLabel>                </choice>                <choice>                    <fieldValue>2</fieldValue>                    <fieldValueLabel>Stop</fieldValueLabel>                    <sequence>1</sequence>                    <sysId>07802a9cae3945769cfecbaeb2d1de70</sysId>                    <useFieldValueForLabel>false</useFieldValueForLabel>                </choice>            </choices>            <defaultListView>false</defaultListView>                         <extensionStatus>false</extensionStatus>            <fieldLength />            <fieldMapping>Choice Field 1</fieldMapping>            <fieldType>Choice</fieldType>            <fieldValue />            <formColumnSpan>1</formColumnSpan>            <formEndRow>false</formEndRow>            <formStartRow>false</formStartRow>            <hint />                         <intFieldMax />            <intFieldMin />            <label>Command</label>            <name>command</name>            <noSpaceIfHidden>false</noSpaceIfHidden>            <preserveValueIfHidden>false</preserveValueIfHidden>            <required>false</required>            <requireIfField />            <requireIfFieldValue />            <requireIfVisible>false</requireIfVisible>            <sequence>1</sequence>            <showIfField>Boolean Field 2</showIfField>            <showIfFieldValue>false</showIfFieldValue>            <sysId>88ba718e6b8b4ee984266faf362c3fde</sysId>        </field>                <field>                       <arrayFieldValue>                             <variable>                                  <name>a1</name>                                  <value>123</value>                             </variable>                             <variable>                                  <name>a2</name>                                  <value>abc</value>                             </variable>                       </arrayFieldValue>           <arrayNameTitle />           <arrayValueTitle />           <booleanNoValue />           <booleanValueType>true/false</booleanValueType>           <booleanYesValue />           <choiceAllowEmpty>false</choiceAllowEmpty>           <choiceAllowMultiple>false</choiceAllowMultiple>                        <choiceDynamic>false</choiceDynamic>                       <choiceFields/>                       <choiceSortOption>Sequence</choiceSortOption>                       <choices/>                       <defaultListView>false</defaultListView>                       <extensionStatus>false</extensionStatus>                       <fieldLength/>                       <fieldMapping>Array Field 1</fieldMapping>                       <fieldRestriction>No Restriction</fieldRestriction>                       <fieldType>Array</fieldType>                       <fieldValue>@ops_delim@a1=123@ops_delim@a2=abc</fieldValue>                       <formColumnSpan>1</formColumnSpan>                       <formEndRow>false</formEndRow>                       <formStartRow>false</formStartRow>                       <hint>11</hint>                       <intFieldMax/>                       <intFieldMin/>                       <label>Array1</label>                       <name>arr1</name>                       <noSpaceIfHidden>false</noSpaceIfHidden>                       <preserveOutputOnRerun>false</preserveOutputOnRerun>                       <preserveValueIfHidden>false</preserveValueIfHidden>                       <showIfField/>                       <requireIfFieldValue/>                       <requireIfVisible>false</requireIfVisible>                       <required>false</required>                       <sequence>0</sequence>                       <showIfField/>                       <showIfFieldValue/>                       <sysId>945eb16b73134f7382d6d0695f93d499</sysId>                       <textType>Plain</textType>              </field>    </fields>    <name>UT1</name>    <outputFailureOnly>true</outputFailureOnly>    <outputReturnFile />    <outputReturnNline>100</outputReturnNline>    <outputReturnSline>1</outputReturnSline>    <outputReturnText />    <outputReturnType>NONE</outputReturnType>    <outputType>STDOUT</outputType>    <runtimeDir />    <script />    <scriptTypeWindows />    <scriptUnix />    <scriptWindows>exit 0</scriptWindows>    <sendVariables>None</sendVariables>    <sysId>32e34b8d138f40a2afbdda79cb1b1d56</sysId>    <templateType>Extension</templateType>    <useCommonScript>false</useCommonScript>    <variablePrefix>ut1</variablePrefix>    <waitForOutput>false</waitForOutput> </universalTemplate>
{ "agent": null, "agentCluster": null, "agentClusterVar": null, "agentFieldsRestriction": "No Restriction", "agentType": "Windows", "agentVar": null, "alwaysCancelOnFinish": false, "automaticOutputRetrievalFieldsRestriction": "Hidden", "broadcastCluster": null, "broadcastClusterVar": null, "commands": [         {             "asynchronous": true,             "executionOption": "In Process",             "fields": [],             "label": "1",             "name": "command",             "statuses": [                 "Queued"             ],             "sysId": "db947be2c7f046dea54e3e49d3c1d349",             "timeout": null         },         {             "asynchronous": false,             "executionOption": "Out Of Process",             "fields": [],             "label": "2",             "name": "command2",             "statuses": [                 "Queued"             ],             "sysId": "e9ddbdbba21d451c8baf3cf11db48c3b",             "timeout": null         }      ], "createConsole": false, "credentialFieldsRestriction": "Hidden", "credentials": null, "credentialsVar": null, "description": null, "desktopInteract": false, "elevateUser": false, "environment": [], "environmentVariablesFieldsRestriction": "Read Only", "exitCodeOutput": null, "exitCodeProcessing": "Success Exitcode Range", "exitCodeProcessingFieldsRestriction": "Hidden", "exitCodeText": null, "exitCodes": "0", "exportReleaseLevel": "7.2.0.0", "fields": [ { "arrayNameTitle": null, "arrayValueTitle": null, "booleanNoValue": null, "booleanValueType": "true/false", "booleanYesValue": null, "choiceAllowEmpty": false, "choiceAllowMultiple": false, "choiceSortOption": "Sequence", "choices": [], "defaultListView": false, "extensionStatus" : false, "fieldLength": null, "fieldMapping": "Text Field 1", "fieldType": "Text", "fieldValue": null, "formColumnSpan": 1, "formEndRow": false, "formStartRow": false, "hint": null, "intFieldMax": null, "intFieldMin": null, "label": "Service", "name": "service", "noSpaceIfHidden": true, "preserveValueIfHidden": false, "required": false, "requireIfField": null, "requireIfFieldValue": null, "requireIfVisible": true, "sequence": 0, "showIfField": "Boolean Field 1", "showIfFieldValue": true, "sysId": "f30ae218f2c64e0a96c5c64a7523e215" }, { "arrayNameTitle": null, "arrayValueTitle": null, "booleanNoValue": null, "booleanValueType": "true/false", "booleanYesValue": null, "choiceAllowEmpty": false, "choiceAllowMultiple": false, "choiceSortOption": "Sequence", "choices": [ { "fieldValue": "1", "fieldValueLabel": "Start", "sequence": 0, "sysId": "95b7d388a2ec407cb5f36768482449b0", "useFieldValueForLabel": false }, { "fieldValue": "2", "fieldValueLabel": "Stop", "sequence": 1, "sysI": "07802a9cae3945769cfecbaeb2d1de70", "useFieldValueForLabel": false } ], "defaultListView": false, "extensionStatus" : false, "fieldLength": null, "fieldMapping": "Choice Field 1", "fieldType": "Choice", "fieldValue": null, "formColumnSpan": 1, "formEndRow": false, "formStartRow": false, "hint": null, "intFieldMax": null, "intFieldMin": null, "label": "Command", "name": "command", "noSpaceIfHidden": false, "preserveValueIfHidden": false, "required": false, "requireIfField": null, "requireIfFieldValue": null, "requireIfVisible": false, "sequence": 1, "showIfField": "Boolean Field 2", "showIfFieldValue": false, "sysId": "88ba718e6b8b4ee984266faf362c3fde" }, { "arrayFieldValue": [ { "name": "x", "value": "1" }, { "name": "y", "value": "2" }, { "name": "z", "value": "3" } ], "arrayNameTitle": null, "arrayValueTitle": null, "booleanNoValue": null, "booleanValueType": "true/false", "booleanYesValue": null, "choiceAllowEmpty": false, "choiceAllowMultiple": false, "choiceDynamic": false, "choiceFields": [], "choiceSortOption": "Sequence", "choices": [], "defaultListView": false, "extensionStatus" : false, "fieldLength": null, "fieldMapping": "Array Field 3", "fieldRestriction": "No Restriction", "fieldType": "Array", "fieldValue": "@ops_delim@x=1@ops_delim@y=2@ops_delim@z=3", "formColumnSpan": 1, "formEndRow": false, "formStartRow": false, "hint": null, "intFieldMax": null, "intFieldMin": null, "label": "Array3", "name": "ar3", "noSpaceIfHidden": false, "preserveOutputOnRerun": false, "preserveValueIfHidden": false, "requireIfField": null, "requireIfFieldValue": null, "requireIfVisible": false, "required": false, "sequence": 3, "showIfField": null, "requireIfFieldValue": null, "sysId": "a879e5f30c0f4f4698cd6c7c45776c99", "textType": "Plain" } ], "name": "UT1", "outputFailureOnly": true, "outputReturnFile": null, "outputReturnNline": "100", "outputReturnSline": "1", "outputReturnText": null, "outputReturnType": "NONE", "outputType": "STDOUT", "retainSysIds": true, "runtimeDir": null, "script": null, "scriptTypeWindows": null, "scriptUnix": null, "scriptWindows": "exit 0", "sendVariables": "None", "sysId": "32e34b8d138f40a2afbdda79cb1b1d56", "templateType": "Extension", "useCommonScript": false, "variablePrefix": "ut1", "waitForOutput": false }

 

 

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

  • Status 200 /OK
    Universal 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 template with {name/id} does not exist.