...
Universal Controller supports the following RESTful-based web services for Script operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about property requirements, are provided.
...
...
XML Request | JSON Request |
---|
Expand |
---|
| Panel |
---|
Html bobswift | <pre><script<script retainSysIds="true" >
<content Html bobswift | >echo>
<content>echo %* </content description Html bobswift |
---|
>description< |
/description Html bobswift | ></content>
<description>description</description>
<notes><notes>
<note><note>
<sysId Html bobswift |
---|
>a8756a120a00010357097d05fa5c558e< |
/sysId Html bobswift | ><sysId>a8756a120a00010357097d05fa5c558e</sysId>
<text Html bobswift |
---|
>test< |
/text Html bobswift | ><text>test</text>
<title Html bobswift |
---|
>note 1< |
/title Html bobswift | ><title>note 1</title>
</note></note>
</notes>
<opswiseGroups Html bobswift | ></notes>
<opswiseGroups>
<opswiseGroup>1</opswiseGroup><opswiseGroup>1</opswiseGroup>
<opswiseGroup>2</opswiseGroup>
</opswiseGroups resolveVariables Html bobswift |
---|
>false< |
/resolveVariables scriptName Html bobswift |
---|
>test.bat< |
/scriptName scriptType Html bobswift |
---|
>Script< |
/scriptType sysId Html bobswift |
---|
>f8756a120a00010357097d05fa5c558e< |
/sysId Html bobswift |
---|
>
</script>
</pre> |
| Expand |
---|
| Panel |
---|
content Html bobswift |
---|
<opswiseGroup>2</opswiseGroup>
</opswiseGroups>
<resolveVariables>false</resolveVariables>
<scriptName>test.bat</scriptName>
<scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script> |
|
Expand |
---|
| {
"content": "echo",
" description Html bobswift |
---|
": "description",
"notes": [ {
" sysId Html bobswift |
---|
": "a8756a120a00010357097d05fa5c558e",
" text Html bobswift |
---|
": "test",
" title Html bobswift | ":title": "note"
} ],
" opswiseGroups Html bobswift |
---|
": ["1","2"],
" resolveVariables Html bobswift |
---|
": false,
"retainSysIds": true,
" scriptName Html bobswift |
---|
": "test.bat",
" scriptType Html bobswift |
---|
": "Script",
" sysId Html bobswift |
---|
": "f8756a120a00010357097d05fa5c558e"
}
</pre>
|
|
Anchor |
---|
| Create a Script Script Properties |
---|
| Create a Script Script Properties |
---|
|
Create a Script: Script Properties
Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
| content - SCR |
---|
| content - SCR |
---|
|
content | Content | Content of the script or SAP definition file. |
| Y |
Anchor |
---|
| description - SCR |
---|
| description - SCR |
---|
|
description | Description | User-defined; description of this record. |
| N |
Anchor |
---|
| excludeRelated - SCR |
---|
| excludeRelated - SCR |
---|
|
excludeRelated | n/a | Specification for whether or not to exclude related records (Notes) from an update, even if they are provided in the request. | Valid values: true/false (default is false). | N |
Anchor |
---|
| exportReleaseLevel - SCR |
---|
| exportReleaseLevel - SCR |
---|
|
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N |
Anchor |
---|
| exportTable - SCR |
---|
| exportTable - SCR |
---|
|
exportTable | n/a | Record table information. | read only | N |
Anchor |
---|
| opswiseGroups - SCR |
---|
| opswiseGroups - SCR |
---|
|
opswisewGroups | Member of Business Services | Business Services that this record belongs to. Â XML Panel |
---|
Html bobswift | <pre>
<opswiseGroups><opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups><opswiseGroup>group2</opswiseGroup>
</ pre>opswiseGroups> |
 JSON Panel | html-bobswift |
---|
<pre>
"opswiseGroups": ["group1","group2"]
</pre> |
|
| N |
Anchor |
---|
| resolveVariables - SCR |
---|
| resolveVariables - SCR |
---|
|
resolveVariables | Resolve UAC Variables | Controls whether or not the Script will be parsed in pursuit of Universal Controller variables. It allows the Controller to avoid the overhead of parsing a Script that does not contain variables. |
| N |
Anchor |
---|
| retainSysIds - SCR |
---|
| retainSysIds - SCR |
---|
| retainSysIds | n/a | Specification for whether or not the Create a Script web service will persist the sysId property. Html bobswift | <ul>
<li> If <b>retainSysIds</b> and <code>sysId</code> is included in the - andÂ
sysId  is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>- Â
sysId  will be persisted to the database. - If retainSysIds="false"
and <code>sysId</code> is included in the - andÂ
sysId  is included in the request/response, <code>sysId</code> will be - Â
sysId  will be ignored;
</ul> Note |
---|
| In XML web services, retainSysIds is specified as an attribute in the <script> element. |
| Valid values: true/false (default is true). | N |
Anchor |
---|
| scriptName - SCR |
---|
| scriptName - SCR |
---|
|
scriptName | Script Name | Name of the script. | This name can be the same as the name of the script file. Â You also can specify a file extension; the default file extension for Windows is .bat. Â If the name has the extension .ps1, Windows will run the script as a powershell script. Â You may have to create the appropriate file association and security for this to work. | Y |
Anchor |
---|
| scriptType - SCR |
---|
| scriptType - SCR |
---|
|
scriptType | Script Type | Type of Script | Valid Values: Html bobswift | <ul>
<li>
<li>
<li>
<li>
<li>
</ul>Default is Script (1). | N |
| n/a | System ID field in the database for this Script record. | Persisted only if retainSysIds is set to true. | N |
...
Expand |
---|
|
<scripts>
<script exportReleaseLevel="7.2.0.0" exportTable="ops_script" version="2">
<content>echo<content>echo %*</content>content>
<description>description</description><description>description</description>
<notes>
<note>
<sysId>a8756a120a00010357097d05fa5c558e</sysId><sysId>a8756a120a00010357097d05fa5c558e</sysId>
<text>test</text><text>test</text>
<title>note <title>note 1</title>title>
</note>
</notes>
<opswiseGroups><opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>opswiseGroups>
<resolveVariables>false</resolveVariables><resolveVariables>false</resolveVariables>
<scriptName>test<scriptName>test.bat</scriptName>scriptName>
<scriptType>Script</scriptType><scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId><sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>
<script exportReleaseLevel="7.2.0.0" exportTable="ops_script" version="3">
<content>echo<content>echo ?*</content>content>
<description>description</description><description>description</description>
<notes>
<note>
<sysId>a8756a120a00010357097d05fa5c558f</sysId><sysId>a8756a120a00010357097d05fa5c558f</sysId>
<text>test</text><text>test</text>
<title>note<title>note 1</title>title>
</note>
</notes>
<opswiseGroups><opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>opswiseGroups>
<resolveVariables>false</resolveVariables><resolveVariables>false</resolveVariables>
<scriptName>test2<scriptName>test2.bat</scriptName>scriptName>
<scriptType>Script</scriptType><scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558f</sysId><sysId>f8756a120a00010357097d05fa5c558f</sysId>
</script>
</scripts>
|
|
Expand |
---|
|
[
{
"content": "echo",
"description": "description", "exportReleaseLevel": "7.2.0.0", "exportTable": "ops_script",
"notes": [ {
"sysId": "a8756a120a00010357097d05fa5c558e",
"text": "test",
"title": "note"
} ],
"opswiseGroups": ["group1","group2"],
"resolveVariables": false,
"scriptName": "test.bat",
"scriptType": "Script",
"sysId": "f8756a120a00010357097d05fa5c558e",
"version": 2
},
{
"content": "echo",
"description": "description", "exportReleaseLevel": "7.2.0.0", "exportTable": "ops_script",
"notes": [ {
"sysId": "a8756a120a00010357097d05fa5c558f",
"text": "test",
"title": "note"
} ],
"opswiseGroups": ["group1","group2"],
"resolveVariables": false,
"scriptName": "test2.bat",
"scriptType": "Script",
"sysId": "f8756a120a00010357097d05fa5c558f",
"version": 3
}
]
|
|
...
XML Request | JSON Request |
---|
Expand |
---|
| Panel |
---|
Html bobswift |
---|
<pre><script>
< |
content Html bobswift |
---|
>echo %*< |
/content description Html bobswift |
---|
>description< |
/description Html bobswift | ><script retainSysIds="true">
<content>echo %*</content>
<description>description</description>
<notes><notes>
<note><note>
<sysId Html bobswift |
---|
>a8756a120a00010357097d05fa5c558e< |
/sysId Html bobswift | ><sysId>a8756a120a00010357097d05fa5c558e</sysId>
<text Html bobswift |
---|
>test< |
/text Html bobswift | ><text>test</text>
<title Html bobswift |
---|
>note 1< |
/title Html bobswift | ><title>note 1</title>
</note></note>
</notes>
<opswiseGroups Html bobswift | ></notes>
<opswiseGroups>
<opswiseGroup>group1</opswiseGroup><opswiseGroup>1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups resolveVariables Html bobswift |
---|
>false< |
/resolveVariables scriptName Html bobswift |
---|
>test.bat< |
/scriptName scriptType Html bobswift |
---|
>Script< |
/scriptType sysId Html bobswift |
---|
>f8756a120a00010357097d05fa5c558e< |
/sysId Html bobswift | >
</script>
</pre><opswiseGroup>2</opswiseGroup>
</opswiseGroups>
<resolveVariables>false</resolveVariables>
<scriptName>test.bat</scriptName>
<scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>
|
|
Expand |
---|
| Panel | html-bobswift | <pre>
{
" content Html bobswift |
---|
": "echo",
" description Html bobswift |
---|
": "description",
"notes": [ {
" sysId Html bobswift |
---|
": "a8756a120a00010357097d05fa5c558e",
" text Html bobswift |
---|
": "test",
" title Html bobswift |
---|
": "note"
} ],
" opswiseGroups Html bobswift |
---|
": [" group11"," group22"],
" resolveVariables Html bobswift |
---|
": false,
"scriptName Html bobswift |
---|
"retainSysIds": true,
"scriptName": "test.bat",
" scriptType Html bobswift |
---|
": "Script",
" sysId Html bobswift |
---|
": "f8756a120a00010357097d05fa5c558e"
}
</pre>
|
|
Anchor |
---|
| Read a Script |
---|
| Read a Script |
---|
|
Read a Script
...
Expand |
---|
| <script exportReleaseLevel="7.2.0.0" exportTable="ops_script" retainSysIds="true" version="1">
<content>echo<content>echo %*</content>content>
<description>description</description><description>description</description>
<notes>
<note>
<sysId>a8756a120a00010357097d05fa5c558e</sysId><sysId>a8756a120a00010357097d05fa5c558e</sysId>
<text>test</text><text>test</text>
<title>note<title>note 1</title>title>
</note>
</notes>
<opswiseGroups><opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>opswiseGroups>
<resolveVariables>false</resolveVariables><resolveVariables>false</resolveVariables>
<scriptName>test<scriptName>test.bat</scriptName>scriptName>
<scriptType>Script</scriptType><scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId><sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>
|
|
Expand |
---|
| {
"content": "echo",
"description": "description", "exportReleaseLevel": "7.2.0.0", "exportTable": "ops_script",
"notes": [ {
"sysId": "a8756a120a00010357097d05fa5c558e",
"text": "test",
"title": "note"
} ],
"opswiseGroups": ["group1","group2"],
"resolvableVariables": false,
"retainSysIds": true,
"scriptName": "test.bat",
"scriptType": "Script",
"sysId": "f8756a120a00010357097d05fa5c558e",
"version": 2
}
|
|
...