Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 1


Panel
Table of Contents
maxlevel2

...

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
titleNote

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.)

...


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 206388603 Field Properties.

Choice Properties

See 206388603 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


Expand
titleXML

<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>



Expand
titleJSON
{
    "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
}


Anchor
Delete a Universal Template
Delete a Universal Template

...


Description

URI

http://host_name/uc/resources/universaltemplate

HTTP Method

DELETE

Description

Deletes a Universal Template.

URI Parameters

See 206388603 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.

...


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

See List Universal Templates: XML and JSON Examples.

Universal Template Properties

See 206388603 Universal Template Properties.

Anchor
List Universal Templates URI Parameters
List Universal Templates URI Parameters

...

XML

JSON


Expand
titleXML
<universalTemplates>
<universalTemplate> exportReleaseLevel="7.2.0.0"
<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>
<exitCodeOutput />
<exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
<exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction>
<exitCodeText />
<exitCodes>0</exitCodes>
<fields />
<name>UT1</name>
<noSpaceIfHidden>true</noSpaceIfHidden>
<preserveValueIfHidden>false</preserveValueIfHidden>
<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>
<universalTemplate> exportReleaseLevel="7.2.0.0"
<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>
<exitCodeOutput />
<exitCodeProcessing>Success Exitcode Range</exitCodeProcessing>
<exitCodeProcessingFieldsRestriction>Hidden</exitCodeProcessingFieldsRestriction>
<exitCodeText />
<exitCodes>0</exitCodes>
<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>
</universalTemplates>



Expand
titleJSON

[

  {
"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": "0",
    "fields": [],
    "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 },
{
    "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": "0",
    "fields": [],
    "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
}
]



Anchor
Modify a Universal Template
Modify a Universal Template

...


Description

URI

http://host_name/uc/resources/universaltemplate

HTTP Method

PUT

Description

Modifies the Universal Template specified by the sysId in the request.
 
To modify Universal Template properties without modifying related records, see the excludeRelated property.

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.

Universal Template Properties

See 206388603 Universal Template Properties.

Field Properties

See 206388603 Field Properties.

Choice Properties

See 206388603 Choice Properties.

Example Response

  • Status 200 /OK
    Successfully updated the universaltemplate with sysId <sysId>.
  • Status 400 /Bad Request
    Update universal template failed. (message)

...


Description

URI

http://host_name/uc/resources/universaltemplate

HTTP Method

GET

Description

Retrieves information on a specific Universal Template.

URI Parameters

See Read a Universal Template: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/universaltemplate?templatename=UT1

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Universal Template Properties

See 206388603 Universal Template Properties.

Field Properties

See 206388603 Field Properties.

Choice Properties

See 206388603 Choice Properties.

Example Response

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agent - UTEMP
agent - UTEMP
agent

Agent

Name of the Agent to use.


N

agentVar,
broadcastCluster, and
broadcastClusterVar

Anchor
agentCluster - UTEMP
agentCluster - UTEMP
agentCluster

Agent Cluster

Group of Agents, one of which the Controller will choose to run this task (compare with broadcastCluster).


N

agentClusterVar,
broadcastCluster, and
broadcastClusterVar

Anchor
agentClusterVar - UTEMP
agentClusterVar - UTEMP
agentClusterVar

Agent Cluster Variable

Name of a variable that will be resolved at run time to the name of the Agent Cluster to use.

Format: ${variable name}.

N

agentCluster,
broadcastCluster, and
broadcastClusterVar

Anchor
agentFieldsRestriction - UTEMP
agentFieldsRestriction - UTEMP
agentFieldsRestriction

Agent Fields

Restriction to apply to the group of Agent Fields.

Valid values:

  • As String = No Restriction, As Value = 0
  • As String = Read Only, As Value = 1
  • As String = Hidden, As Value = 2

N


Anchor
agentType - UTEMP
agentType - UTEMP
agentType

Agent Type

Type of Agent on which Universal Tasks based on this template can be run.

Valid values:

  • As String = Any, As Value = 1
  • As String = Linux/Unix, As Value = 2
  • As String = Windows, As Value = 3

Y


Anchor
agentVar - UTEMP
agentVar - UTEMP
agentVar

Agent Variable

Name of a variable that will be resolved at run time to the name of the Agent to use.

Format: ${variable name}.

N

agent,
broadcastCluster, and
broadcastClusterVar

Anchor
alwaysCancelOnFinish - UTEMP
alwaysCancelOnFinish - UTEMP
alwaysCancelOnFinish

Always Cancel On Finish

Specification for whether or not to always perform a Cancel when Force Finishing a Universal Task for this template.

Boolean; Valid values: true/false. Default is false.

N


Anchor
automaticOutputRetrievalFieldsRestriction - UTEMP
automaticOutputRetrievalFieldsRestriction - UTEMP
automaticOutputRetrievalFieldsRestriction

Automatic Output Retrieval Fields

Restriction to apply to the group of Automatic Output Retrieval Fields.

Valid values:

  • As String = No Restriction, As Value = 0
  • As String = Read Only, As Value = 1
  • As String = Hidden, As Value = 2

N


Anchor
broadcastCluster - UTEMP
broadcastCluster - UTEMP
broadcastCluster

Cluster Broadcast

Group of Agents, all of which will run this task (compare with agentCluster). Each instance of the task running on its own Agent becomes a separate task instance record in the database and displays separately on the Activity Monitor.


N

broadcastClusterVar,
agent,
agentVar,
agentCluster, and
agentClusterVar

Anchor
broadcastClusterVar - UTEMP
broadcastClusterVar - UTEMP
broadcastClusterVar

Cluster Broadcast Variable

Name of a variable that will be resolved at run time to the name of the Cluster Broadcast to use.

Format: ${variable name}

N

broadcastCluster,
agent,
agentVar,
agentCluster, and
agentClusterVar

Anchor
createConsole - UTEMP
createConsole - UTEMP
createConsole

Create Console

If desktopInteract is true; Specification for whether or not to allocate a new console for the process, rather than having it inherit one.

Boolean; Valid values: true/false. Default is false.

N


Anchor
credentialFieldsRestriction - UTEMP
credentialFieldsRestriction - UTEMP
credentialFieldsRestriction

Credential Fields

Restriction to apply to the group of Credential Fields.

Valid values:

  • As String = No Restriction, As Value = 0
  • As String = Read Only, As Value = 1
  • As String = Hidden, As Value = 2

N


Anchor
credentials - UTEMP
credentials - UTEMP
credentials

Credentials

Credentials under which an Agent runs this task. These credentials override any credentials provided in the Agent Details for any Agent running this task.


N

credentialsVar

Anchor
credentialsVar - UTEMP
credentialsVar - UTEMP
credentialsVar

Credentials Variable

Name of a variable that will be resolved at run time to the name of the {Credentials] to use.


N

credentials

Anchor
description - UTEMP
description - UTEMP
description

Description

Description of this Universal Template.


N


Anchor
desktopInteract - UTEMP
desktopInteract - UTEMP
desktopInteract

Interact with Desktop

Specification for whether or not a task that runs an application with a GUI requires some manual actions from a user (for example, clicking buttons or entering values).

Boolean; Valid values: true/false. Default is false.
 
This property is effective only for tasks executed on Windows XP or Server 2003. Windows Vista introduced the desktop isolation feature, which prevents tasks from accessing the interactive desktop session on Vista, Windows 7, Server 2008, Windows 8, and Server 2012. The Windows agent will execute the task, but the Interact with Desktop option has no effect. Therefore, an interactive application's GUI will not be visible on those platforms.

N


Anchor
elevateUser - UTEMP
elevateUser - UTEMP
elevateUser

Run with Highest Privileges

Specification for whether or not to execute the task using an elevated privileges token, rather than one subject to User Account Control (UAC) restrictions. An elevated token allows a process to execute with all the privileges available to its specified credentials. For example, a task executed with an administrative account will behave as though it received permission via a UAC dialog to perform a privileged operation.

Boolean; Valid values: true/false. Default is false.
 
This property will not give a user account privileges that have are not already granted to it. For example, taking ownership of a file is a privileged operation by default. A task will still fail even with this option selected if it is run with a regular user account that has not been granted the ability to change file ownership.

N


Anchor
environment - UTEMP
environment - UTEMP
environment

Environment Variables

Environment variables needed by the program to run.

List of environment variables:

Panel
<environment>
       <variable>
             <name>env1</name>
             <value>test1</value>
       </variable>
       <variable>
             <name>env2</name>
             <value>test2</value>
       </variable>
</environment>


N


Anchor
environmentVariableFieldsRestriction - UTEMP
environmentVariableFieldsRestriction - UTEMP
environmentVariableFieldsRestriction

Environment Variable Fields

Restriction to apply to the group of Environment Variables Fields.

Valid values:

  • As String = No Restriction, As Value = 0
  • As String = Read Only, As Value = 1
  • As String = Hidden, As Value = 2

N


Anchor
excludeRelated - UTEMP
excludeRelated - UTEMP
excludeRelated

n/a

Specification for whether or not to exclude related records.

Boolean; Valid values: true/false. Default is false.
 
For XML, excludeRelated is specified as an attribute on the universalTemplate element.

N


Anchor
exitCodeOutput - UTEMP
exitCodeOutput - UTEMP
exitCodeOutput

Output File

Path and file name of the output file that should be scanned for the text in exitCodeText.


N


Anchor
exitCodeProcessing - UTEMP
exitCodeProcessing - UTEMP
exitCodeProcessing

Exit Code Processing

Specification for how the Controller should determine whether the executed command failed or completed successfully.

Valid values:

  • As String = Success Exitcode Range, As Value = 1
  • As String = Failure Exitcode Range, As Value = 2
  • As String = Success Output Contains, As Value = 3
  • As String = Failure Output Contains, As Value = 4

Default is Success Exitcode (1).

N


Anchor
exitCodeProcessingFieldsRestriction - UTEMP
exitCodeProcessingFieldsRestriction - UTEMP
exitCodeProcessingFieldsRestriction

Exit Code Processing Fields

Restriction to apply to the group of Exit Code Processing Fields.

Valid values:

  • As String = No Restriction, As Value = 0
  • As String = Read Only, As Value = 1
  • As String = Hidden, As Value = 2

N


Anchor
exitCodes - UTEMP
exitCodes - UTEMP
exitCodes

Exit Codes

If exitCodeProcessing is Success Exitcode Range or Failure Exitcode Range; Range of exit codes.

Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30.

Y


Anchor
exitCodeText - UTEMP
exitCodeText - UTEMP
exitCodeText

Scan Output For

If exitCodeProcessing is Success Output Contains (3) or Failure Output Contains (4); text for which the Controller should scan the output file.

The Controller will process this field as a regular expression.

Y


Anchor
exportReleaseLevel - UTEMP
exportReleaseLevel - UTEMP
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
name - UTEMP
name - UTEMP
name

Name

Name of this Universal Template.


Y


Anchor
outputFailureOnly - UTEMP
outputFailureOnly - UTEMP
outputFailureOnly

Failure Only

If outputReturnType = STDOUT (2), STDERR (3), FILE (4), or OUTERR (6), and waitForOutput is false; Indication for whether output should be retrieved on task failure only.

Boolean; Valid values: true/false. Default is false.

N


Anchor
outputReturnFile - UTEMP
outputReturnFile - UTEMP
outputReturnFile

Output File

If outputReturnType is FILE; Path and file name containing the output that you want automatically retrieved and attached to the task instance.


N


Anchor
outputReturnNline - UTEMP
outputReturnNline - UTEMP
outputReturnNline

Number of Lines

If outputReturnType is STDOUT, STDERR, FILE, or OUTERR; Limit the retrieved data to this number of lines.

Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property.

N


Anchor
outputReturnSline - UTEMP
outputReturnSline - UTEMP
outputReturnSline

Start Line

If outputReturnType is STDOUT, STDERR, FILE, or OUTERR; Instructs the Controller to retrieve data beginning at the line indicated.

Default is 1.

N


Anchor
outputReturnText - UTEMP
outputReturnText - UTEMP
outputReturnText

Scan Text

If outputReturnType is STDOUT, STDERR, FILE, or OUTERR; Instructs the Controller to scan the data for the text specified and retrieve only that.

The Controller will process this field as a regular expression.

N


Anchor
outputReturnType - UTEMP
outputReturnType - UTEMP
outputReturnType

Automatic Output Retrieval

Specificaton for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record.

Valid values:

  • As String = NONE, As Value = 1
  • As String = STDOUT, As Value = 2
  • As String = STDERR, As Value = 3
  • As String = FILE, As Value = 4
  • As String = OUTERR, As Value = 6

Default is OUTERR (6).
 


Note
titleNote

If outputReturnType is not NONE (1), the web service will fail with Start Failure if outputProhibited is true for the specified agent.


N


Anchor
outputType - UTEMP
outputType - UTEMP
outputType

Output Type

If exitCodeProcessing is Success Output or Failure Output; Type of output.

Valid values:

  • As String = STDOUT, As Value = 1
  • As String = STDERR, As Value = 2
  • As String = FILE, As Value = 3

Default is STDOUT (1).

N


Anchor
retainSysIds - UTEMP
retainSysIds - UTEMP
retainSysIds

n/a

Specification for whether or not the Create a Universal Template web service will persist the sysId property.

Boolean; Valid values: true/false. Default is false.
 
For XML, retainSysIds is specified as an attribute on the universalTemplate element.
 
Used for both the Create and Update web services; for Update, it is used only for the related lists (Fields and Choices). It is recommended that retainSysIds be enabled when updating Choice values so that the command can determine which Choice values have been updated and propagate the new value to Universal Tasks using the previous Choice value.
 
If retainSysIds is not enabled when updating Choice values, the command can determine only which Choice values have been added or removed; Universal Tasks using the previous Choice values will not be updated.

N


Anchor
runtimeDir - UTEMP
runtimeDir - UTEMP
runtimeDir

Runtime Directory

Directory from which the application should be executed.

Variables are supported.

N


Anchor
script - UTEMP
script - UTEMP
script

Script

If useCommonScript is true; Script to be executed by the specified Agent.


N


Anchor
scriptUnix - UTEMP
scriptUnix - UTEMP
scriptUnix

Linux/Unix Script

If agentType is Any or Linux/Unix; Script to be executed by the Linux/Unix Agent.


N


Anchor
scriptWindows - UTEMP
scriptWindows - UTEMP
scriptWindows

Windows Script

If agentType is Any or Windows; Script to be executed by the Windows Agent.


N


Anchor
scriptTypeWindows- UTEMP
scriptTypeWindows- UTEMP
scriptTypeWindows

Windows Script File Type

If agentType is Windows; Type of Windows Script to be executed by the Windows Agent.

Valid values:

  • As String = bat
  • As String = cmd
  • As String = js
  • As String = ps1
  • As String = py
  • As String = uapy
  • As String = vbs
  • As String = wsf
  • As String = Other

N


Anchor
sendVariables - UTEMP
sendVariables - UTEMP
sendVariables

Send Extension Variables

If templateType is Extension; Specification for whether the Extension should be provided with task instance variable data when launched.

Options:

  • None
    Do not provide the Extension with task instance variable data.
  • Local
    Provide the Extension with task instance variable data.

Valid values:

  • As String = None, As Value = 0

  • As String = Local, As Value = 1

Default is None (0).

N

Anchor
sysId - UTEMP
sysId - UTEMP
sysId

UUID

System ID field in the database for this record.

Persisted only if retainSysIds is set to true.

N


Anchor
templateType - UTEMP
templateType - UTEMP
templateType

Template TypeSpecification for whether the Universal Template will be executed as a Script or will be executed through the Universal Extension framework.

Valid values:

  • As String = Script, As Value = 1

  • As String = Extension, As Value = 2

Default is Script (1).

N

Anchor
useCommonScript - UTEMP
useCommonScript - UTEMP
useCommonScript

Use Common Script

Indication that the specified script can be executed by both Linux/Unix and Windows Agents.

Boolean; Valid values: true/false. Default is false.

N


Anchor
variablePrefix - UTEMP
variablePrefix - UTEMP
variablePrefix

Variable Prefix

Variable prefix to append to the default prefix (ops_) for the system-assigned variables that are provided for the user-defined Fields in this Universal Template.


Y


Anchor
waitForOutput - UTEMP
waitForOutput - UTEMP
waitForOutput

Wait For Output

If outputReturnType = STDOUT (2), STDERR (3), FILE (4), or OUTERR (6), and outputFailureOnly is false; Specification for whether or not the task should wait for the requested output before completing.

Boolean; Valid values: true/false. Default is false.

N


...


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

AuthenticationHTTP Basic

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.

...


Description

URI

http://host_name/uc/resources/universaltemplate/seticon

HTTP Method

POST

Note
titleNote

The Post request must include an attached binary file; specifically, it must be a 48 x 48 pixel PNG file.

If the file is omitted, of the wrong MIME type, or has incorrect dimensions, the process will fail.


Description

Upload a 48 x 48 pixel to be set as the custom icon for a specific Universal Template.

Example URI

AuthenticationHTTP Basic

Consumes Content-Type

application/octet-stream, image/png

Produces Content-Type

plain/text

Example Response

  • Status 200

    • Successfully set icon for Universal Template “{templatename}”.

  • Status 400

    • PNG image is not 48 x 48 pixels.

  • 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.

...


Description

URI

http://host_name/uc/resources/universaltemplate/extension

HTTP Method

DELETE

Description

Delete an Extension Archive for a Universal Template.

URI Parameters

See Delete Extension Archive: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1

AuthenticationHTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

n/a

Example Response

  • Status 200

    • Successfully removed Extension Archive from universal template "{templatename}".

  • Status 400

    • Universal template "{templatename}" is not an Extension template type.

  • 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.

...


Description

URI

http://host_name/uc/resources/universaltemplate/extension

HTTP Method

GET

Description

Download an Extension Archive for a Universal Template.

URI Parameters

See Download Extension Archive: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/universaltemplate/extension?templatename=Template1

AuthenticationHTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/octet-stream

Example Response

  • Status 200

    • [Binary data sent in response]

  • Status 400

    • Universal template "{templatename}" is not an Extension template type.

  • 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.

...


Description

URI

http://host_name/uc/resources/universaltemplate/extension

HTTP Method

POST

Note
titleNote

The Post request must include an attached binary file; specifically, it must be a zip file.


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/extension?templatename=Template1

AuthenticationHTTP Basic

Consumes Content-Type

application/octet-stream, application/zip, application/x-zip-compressed

Produces Content-Type

plain/text

Example Response

  • Status 200

    • Successfully updated Extension Archive for universal template "{templatename}".

  • Status 400

    • Universal template "{templatename}" is not an Extension template type.

  • 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.

...


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:

  • template.json
  • template_icon.png (if it exists)
  • extension_archive.zip (if it exists and the excludeExtension parameter is not set to true)

URI Parameters

See Universal Template Export: URI Parameters, below.

Example URI

AuthenticationHTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/octet-stream

Example Response

  • Status 200

    • [Binary data sent in response]

  • Status 403

    • Operation prohibited for built-in universal templates.

    • 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

    • Read universal template failed. {errors}

    • Unexpected request failure. See log(s) for more details.

...


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

AuthenticationHTTP Basic

Consumes Content-Type

application/octet-stream, application/zip, application/x-zip-compressed

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.

...