Versions Compared

Old Version 3

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

>
</content>
	<description>description</description>
&lt;notes&gt;
<notes>
&lt;note&gt;
<note>
&lt;

sysId

XML Request

JSON Request


<pre>&lt;script
<script retainSysIds="true"
&gt; &lt;

content

&gt;echo
>
	<content>echo %*
&lt;

/content

Expand
titleXML Request
Panel
Html bobswift
Html bobswift
Html bobswift
&gt;
	&lt;

description

Html bobswift
&gt;description&lt;

/description

Html bobswift
Html bobswift
&gt;a8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift&gt;
<sysId>a8756a120a00010357097d05fa5c558e</sysId>
                    <text>test</text>
&lt;

text

Html bobswift
&gt;test&lt;

/text

Html bobswift&gt;
&lt;

title

Html bobswift
&gt;note 1&lt;

/title

Html bobswift&gt;
<title>note 1</title>
&lt;/note&gt;
</note>
&lt;/notes&gt; &lt;

opswiseGroups

Html bobswift&gt;
</notes>
	<opswiseGroups>
&lt;opswiseGroup&gt;1&lt;/opswiseGroup&gt;
<opswiseGroup>1</opswiseGroup>
&lt;opswiseGroup&gt;2&lt;/opswiseGroup&gt; &lt;

/opswiseGroups

Html bobswift
&gt;
	&lt;

resolveVariables

Html bobswift
&gt;false&lt;

/resolveVariables

Html bobswift
&gt;
	&lt;

scriptName

Html bobswift
&gt;test.bat&lt;

/scriptName

Html bobswift
&gt;
	&lt;

scriptType

Html bobswift
&gt;Script&lt;

/scriptType

Html bobswift
&gt;
	&lt;

sysId

Html bobswift
&gt;f8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift
&gt;
&lt;/script&gt;
</pre>
Expand
titleJSON Request
Panel
Html bobswift
<pre>
{
  "

content

Html bobswift
<opswiseGroup>2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>



": "description",
  "notes": [ {
    "
sysId
": "a8756a120a00010357097d05fa5c558e",
    "
text
": "test",
    "
title
": "note"
  } ],
  "
opswiseGroups
": ["1","2"],
  "
resolveVariables
": false,
  "retainSysIds": true,
  "
scriptName
": "test.bat",
  "
scriptType
": "Script",
  "
sysId
": "f8756a120a00010357097d05fa5c558e"
}
</pre>

Expand
titleJSON Request
{
  "content": "echo", 
  "
description
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift


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 onlyN

Anchor
exportTable - SCR
exportTable - SCR
exportTable

n/aRecord table information.read onlyN

Anchor
opswiseGroups - SCR
opswiseGroups - SCR
opswisewGroups

Member of Business Services

Business Services that this record belongs to.
 
XML

panel

html-bobswift
Panel
<pre> &lt;opswiseGroups&gt;
<opswiseGroups>
&lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt;
<opswiseGroup>group1</opswiseGroup>
&lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt; </pre>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>

 
JSON

html-bobswift
Panel
<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.

  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.
Note
titleNote

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:

  • As String = Script, As Value = 1 (for use in Windows or Linux/Unix tasks)
  • As String = SAP Definition, As Value = 2 (for use in SAP tasks)
  • As String = UDM Script, As Value = 3 (for use in UDM File Transfer tasks)
  • As String = Web Service Payload, As Value = 4 (for use in Web Service tasks)
  • As String = Data, As Value = 5 (for use in a script or task)

Default is Script (1).

N

Anchor
sysId - SCR
sysId - SCR
sysId

n/a

System ID field in the database for this Script record.

Persisted only if retainSysIds is set to true.

N

...


Expand
titleXML Response


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


[
  {
  "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
  }
]


...


Description

URI

http://host_name/uc/resources/script

HTTP Method

PUT

Description

Modifies the Script specified by the sysId.

Example URI

http://localhost:8080/uc/resources/script

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Script: Example Request, below.

Script Properties

See Create a Script: Script Properties.

Notes Properties

See Create a Script: Notes Properties.

Example Response

  • Status 200 /OK
    Successfully updated the Script with sysId <sysId> to version <version>.

...

/resources/script

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Script: Example Request

...

XML Request

JSON Request

Expand
titleXML Request
Panel
Html bobswift
<pre>&lt;script&gt;
	&lt;

content

Html bobswift
&gt;echo %*&lt;

/content

Html bobswift
&gt;
	&lt;

description

Html bobswift
&gt;description&lt;

/description

Html bobswift&gt; &lt;notes&gt;

, below.

Script Properties

See Create a Script: Script Properties.

Notes Properties

See Create a Script: Notes Properties.

Example Response

  • Status 200 /OK
    Successfully updated the Script with sysId <sysId> to version <version>.

Anchor
Modify a Script Example Request
Modify a Script Example Request
Modify a Script: Example Request

&gt;
<sysId>a8756a120a00010357097d05fa5c558e</sysId>
                    <text>test</text>
&lt;

title

&gt;note
1&lt;

/title

&gt;
              <title>note
&lt;/note&gt;
1</title>
&lt;/notes&gt; &lt;

opswiseGroups

&gt; 
</note>
        </notes>
	<opswiseGroups>
&lt;opswiseGroup&gt;group1&lt;/opswiseGroup&gt; 
   <opswiseGroup>1</opswiseGroup>
&lt;opswiseGroup&gt;group2&lt;/opswiseGroup&gt; &lt;

/opswiseGroups

XML Request

JSON Request


&gt;
 <note>
&lt;

text

Expand
titleXML Request
<script retainSysIds="true">
	<content>echo %*</content>
	<description>description</description>
        <notes>
&lt;note&gt;
&lt;

sysId

Html bobswift
&gt;a8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift
Html bobswift
&gt;test&lt;

/text

Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
&gt;
	&lt;

resolveVariables

Html bobswift
&gt;false&lt;

/resolveVariables

Html bobswift
&gt;
	&lt;

scriptName

Html bobswift
&gt;test.bat&lt;

/scriptName

Html bobswift
&gt;
	&lt;

scriptType

Html bobswift
&gt;Script&lt;

/scriptType

Html bobswift
&gt;
	&lt;

sysId

Html bobswift
&gt;f8756a120a00010357097d05fa5c558e&lt;

/sysId

Html bobswift&gt; &lt;/script&gt; </pre>
 <opswiseGroup>2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>




panel<pre> 
{
  "
content
": "echo", 
  "
description
": "description",
  "notes": [ {
"

sysId

"sysId": "a8756a120a00010357097d05fa5c558e",
    "
text
": "test",
    "
title
": "note"
  } ],
  "
opswiseGroups
": ["
group1
1","
group2
2"],
  "
resolveVariables
": false,
"

scriptName

"retainSysIds": true,
  "scriptName": "test.bat",
  "
scriptType
": "Script",
  "
sysId
": "f8756a120a00010357097d05fa5c558e"
}
</pre>

Expand
titleJSON Request
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift
Html bobswift


Anchor
Read a Script
Read a Script
Read a Script

...


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



...