...

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

Universal Template Web Services#Create Create a Universal TemplateUniversal Template Web Services#Delete
Delete a Universal Template
Universal Template Web Services#List List Universal TemplatesUniversal
Template Web Services#Modify Modify a Universal TemplateUniversal Template Web Services#Read
Read a Universal Template
Universal Template Web Services#Restore Restore Default Universal Template IconUniversal Template Web Services#Set
Set Universal Template Icon
Universal Template - Delete Extension Archive
Universal Template - Download Extension Archive
Universal Template - Upload Extension Archive
Universal Template Web Services#Universal Template Export
Universal Template Web Services#Universal Template Import

Formatting specifications for each web service, including details about parameter requirements, are provided.

...

	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 Web Services#Universal Template Properties.
Field Properties	See Universal Template Web Services#Field Field Properties.
Choice Properties	See Universal Template Web Services#Choice Choice Properties.
Example Response	Status 200 /OK Successfully created the universal template with sysId {sysId}. Status 400 /Bad Request Create universal template failed. (message)

...

	Description
URI	http://host_name/uc/resources/universaltemplate
HTTP Method	DELETE
Description	Deletes a Universal Template.
URI Parameters	See Universal Template Web Services#Delete 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 all Universal Templates.
Example URI	http://localhost:8080/uc/resources/universaltemplate/list
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Example	See List Universal Templates: XML and JSON Examples.
Universal Template Properties	See Universal Template Web Services#Universal Template Properties.

Anchor
List Universal Templates XML and JSON Examples
List Universal Templates XML and JSON Examples
List Universal Templates: XML and JSON Examples

XML

JSON

Expand

title	XML

<universalTemplates>
  <universalTemplate> 
    <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> 
<sysId>32e34b8d138f40a2afbdda79cb1b1d56</sysId> 
<useCommonScript>false</useCommonScript> 
<variablePrefix>ut1</variablePrefix> 
<waitForOutput>false</waitForOutput> 
</universalTemplate>
<universalTemplate> 
<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> 
<sysId>32e34b8d138f40a2afbdda79cb1b1d56</sysId> 
<useCommonScript>false</useCommonScript> 
<variablePrefix>ut1</variablePrefix> 
<waitForOutput>false</waitForOutput> 
</universalTemplate>
</universalTemplates>

Expand

title	JSON

[

{     {

"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", 
    "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", 
    "sysId": "32e34b8d138f40a2afbdda79cb1b1d56", 
    "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", 
    "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", 
    "sysId": "32e34b8d138f40a2afbdda79cb1b1d56", 
    "useCommonScript": false, 
    "variablePrefix": "ut1", 
    "waitForOutput": false
}
]

Anchor
Modify a Universal Template
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 Universal Template Web Services#Universal Template Properties.
Field Properties	See Universal Template Web Services#Field Field Properties.
Choice Properties	See Universal Template Web Services#Choice 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 Universal Template Web Services#Universal Template Properties.
Field Properties	See Universal Template Web Services#Field Field Properties.
Choice Properties	See Universal Template Web Services#Choice Choice Properties.
Example Response	Status 200 /OK (See Create, Modify, and Read a Universal Template: XML and JSON Examples.) 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.

...

Versions Compared

Old Version 1

New Version 2

Key

Anchor
List Universal Templates XML and JSON Examples
List Universal Templates XML and JSON Examples
List Universal Templates: XML and JSON Examples

Anchor
Modify a Universal Template
Modify a Universal Template
Modify a Universal Template

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

AnchorList Universal Templates XML and JSON ExamplesList Universal Templates XML and JSON ExamplesList Universal Templates: XML and JSON Examples

AnchorModify a Universal TemplateModify a Universal TemplateModify a Universal Template

Anchor
List Universal Templates XML and JSON Examples
List Universal Templates XML and JSON Examples
List Universal Templates: XML and JSON Examples

Anchor
Modify a Universal Template
Modify a Universal Template
Modify a Universal Template