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

...

n/a

...

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

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <script> element.

...

Valid values: true/false (default is true).

...

N

...

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

...

Script Type

...

Type of Script

...

Valid Values:

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

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Required

...

n/a

...

sys_id used within the Controller to identify this Note.

...

N

...

Text

...

Text of this note.

...

N

...

Title

...

Title of this note.

...

N

...

Description

...

URI

...

HTTP Method

...

DELETE

...

Description

...

Deletes a Script.

...

URI Parameters

...

See Delete a Script: URI Parameters, below.

...

Example URI

...

Example Response

...

Status 200 /OK
Script deleted successfully.
Status 400 /Bad Request
Mutual exclusion violation. Cannot specify scriptname and scriptid at the same time.
Status 404 /Not Found
A Script with {name/id} "test" does not exist.

...

Parameter

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

scriptid

...

ID used within the Controller to identify this Script.

...

String; URI parameter.

...

Y
(unless scriptname
is specified)

...

scriptname

...

scriptname

...

Name used within the Controller to identify this Script.

...

String; URI parameter.

...

Y
(unless scriptid
is specified)

...

scriptid

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Retrieves information on all Scripts.

...

Example URI

...

Authentication

...

HTTP Basic

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

See List Scripts: Example Response, below.

...

Script Properties

...

See Create a Script: Script Properties.

...

Notes Properties

...

See Create a Script: Notes Properties.

List Scripts: Example Response

...

title	XML Response

<scripts>
    <script exportReleaseLevel="7.2.0.0" exportTable="ops_script" version="2">
	<content>echo %*</content>
	<description>description</description>
        <notes>
              <note>
                    <sysId>a8756a120a00010357097d05fa5c558e</sysId>
                    <text>test</text>
                    <title>note 1</title>
              </note>
        </notes>
	<opswiseGroups>
              <opswiseGroup>group1</opswiseGroup>
              <opswiseGroup>group2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558e</sysId>
    </script>
    <script exportReleaseLevel="7.2.0.0" exportTable="ops_script" version="3">
	<content>echo ?*</content>
	<description>description</description>
        <notes>
              <note>
                    <sysId>a8756a120a00010357097d05fa5c558f</sysId>
                    <text>test</text>
                    <title>note 1</title>
              </note>
        </notes>
	<opswiseGroups>
              <opswiseGroup>group1</opswiseGroup>
              <opswiseGroup>group2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test2.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558f</sysId>
    </script>
</scripts>

...

title	JSON 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 Method

...

PUT

...

Description

...

Modifies the Script specified by the sysId.

...

Example URI

...

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

...

XML Request

JSON Request

Expand

title	XML Request

Panel

Expand

title	JSON Request

Panel

Html bobswift
<pre><script retainSysIds="true"> <

content

Html bobswift
>echo %*<

/content

Html bobswift
> <

description

Html bobswift
>description<

/description

Html bobswift
> <notes> <note> <

sysId

Html bobswift
>a8756a120a00010357097d05fa5c558e<

/sysId

Html bobswift
> <

text

Html bobswift
>test<

/text

Html bobswift
> <

title

Html bobswift
>note 1<

/title

Html bobswift
> </note> </notes> <

opswiseGroups

Html bobswift
> <opswiseGroup>1</opswiseGroup> <opswiseGroup>2</opswiseGroup> <

/opswiseGroups

Html bobswift
> <

resolveVariables

Html bobswift
>false<

/resolveVariables

Html bobswift
> <

scriptName

Html bobswift
>test.bat<

/scriptName

Html bobswift
> <

scriptType

Html bobswift
>Script<

/scriptType

Html bobswift
> <

sysId

Html bobswift
>f8756a120a00010357097d05fa5c558e<

/sysId

Html bobswift
> </script> </pre>

Expand

title	JSON Request

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
": ["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> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups> </pre>

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>="true" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="false" and  <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. 
</ul>

Note

title	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> As String = Script, As Value = 1 (for use in Windows or Linux/Unix tasks)
<li> As String = SAP Definition, As Value = 2 (for use in SAP tasks)
<li> As String = UDM Script, As Value = 3 (for use in UDM File Transfer tasks)
<li> As String = Web Service Payload, As Value = 4 (for use in Web Service tasks)
<li> As String = Data, As Value = 5 (for use in a script or task)
</ul>

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

Anchor
Create a Script Notes Properties
Create a Script Notes Properties
Create a Script: Notes Properties

Property

UI Field Name

Description

Specifications

Required

Anchor

	sysId - Notes
	sysId - Notes

sysId

n/a

sys_id used within the Controller to identify this Note.

N

Anchor

	text - Notes
	text - Notes

text

Text

Text of this note.

N

Anchor

	title - Notes
	title - Notes

title

Title

Title of this note.

N

Anchor
Delete a Script
Delete a Script
Delete a Script

	Description
URI	http://host_name/uc/resources/script
HTTP Method	DELETE
Description	Deletes a Script.
URI Parameters	See Delete a Script: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/script?scriptname=test
Example Response	Status 200 /OK Script deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `scriptname` and `scriptid` at the same time. Status 404 /Not Found A Script with {name/id} "test" does not exist.

Anchor
Delete a Script URI Parameters
Delete a Script URI Parameters
Delete a Script: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`scriptid`	ID used within the Controller to identify this Script.	String; URI parameter.	Y (unless `scriptname` is specified)	`scriptname`
`scriptname`	Name used within the Controller to identify this Script.	String; URI parameter.	Y (unless `scriptid` is specified)	`scriptid`

Anchor
List Scripts
List Scripts
List Scripts

	Description
URI	http://host_name/uc/resources/script/list
HTTP Method	GET
Description	Retrieves information on all Scripts.
Example URI	http://localhost:8080/uc/resources/script/list
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See List Scripts: Example Response, below.
Script Properties	See Create a Script: Script Properties.
Notes Properties	See Create a Script: Notes Properties.

List Scripts: Example Response

Expand

title	XML Response

<scripts>
    <script exportReleaseLevel="7.2.0.0" exportTable="ops_script" version="2">
	<content>echo %*</content>
	<description>description</description>
        <notes>
              <note>
                    <sysId>a8756a120a00010357097d05fa5c558e</sysId>
                    <text>test</text>
                    <title>note 1</title>
              </note>
        </notes>
	<opswiseGroups>
              <opswiseGroup>group1</opswiseGroup>
              <opswiseGroup>group2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558e</sysId>
    </script>
    <script exportReleaseLevel="7.2.0.0" exportTable="ops_script" version="3">
	<content>echo ?*</content>
	<description>description</description>
        <notes>
              <note>
                    <sysId>a8756a120a00010357097d05fa5c558f</sysId>
                    <text>test</text>
                    <title>note 1</title>
              </note>
        </notes>
	<opswiseGroups>
              <opswiseGroup>group1</opswiseGroup>
              <opswiseGroup>group2</opswiseGroup>
	</opswiseGroups>
	<resolveVariables>false</resolveVariables>
	<scriptName>test2.bat</scriptName>
	<scriptType>Script</scriptType>
	<sysId>f8756a120a00010357097d05fa5c558f</sysId>
    </script>
</scripts>

Expand

title	JSON 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
  }
]

Anchor
Modify a Script
Modify a Script
Modify a Script

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

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

XML Request

JSON Request

Expand

title	XML Request

Panel

Html bobswift
<pre><script> <

content

Html bobswift
>echo %*<

/content

Html bobswift
> <

description

Html bobswift
>description<

/description

Html bobswift
> <notes> <note> <

sysId

Html bobswift
>a8756a120a00010357097d05fa5c558e<

/sysId

Html bobswift
> <

text

Html bobswift
>test<

/text

Html bobswift
> <

title

Html bobswift
>note 1<

/title

Html bobswift
> </note> </notes> <

opswiseGroups

Html bobswift
> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> <

/opswiseGroups

Html bobswift
> <

resolveVariables

Html bobswift
>false<

/resolveVariables

Html bobswift
> <

scriptName

Html bobswift
>test.bat<

/scriptName

Html bobswift
> <

scriptType

Html bobswift
>Script<

/scriptType

Html bobswift
> <

sysId

Html bobswift
>f8756a120a00010357097d05fa5c558e<

/sysId

Html bobswift
> </script> </pre>

Expand

title	JSON Request

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
": ["group1","group2"], "

resolveVariables

Html bobswift
": false, "

scriptName

Html bobswift
": "test.bat", "

scriptType

Html bobswift
": "Script", "

sysId

Html bobswift
": "f8756a120a00010357097d05fa5c558e" } </pre>

Anchor
Read a Script
Read a Script
Read a Script

...

Versions Compared

Old Version 9

New Version 10

Key

List Scripts: Example Response

Anchor
Create a Script Script Properties
Create a Script Script Properties
Create a Script: Script Properties

Anchor
Create a Script Notes Properties
Create a Script Notes Properties
Create a Script: Notes Properties

Anchor
Delete a Script
Delete a Script
Delete a Script

Anchor
Delete a Script URI Parameters
Delete a Script URI Parameters
Delete a Script: URI Parameters

Anchor
List Scripts
List Scripts
List Scripts

List Scripts: Example Response

Anchor
Modify a Script
Modify a Script
Modify a Script

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

Anchor
Read a Script
Read a Script
Read a Script

Page Comparison

Versions Compared

Old Version 9

New Version 10

Key

List Scripts: Example Response

AnchorCreate a Script Script PropertiesCreate a Script Script PropertiesCreate a Script: Script Properties

AnchorCreate a Script Notes PropertiesCreate a Script Notes PropertiesCreate a Script: Notes Properties

AnchorDelete a ScriptDelete a ScriptDelete a Script

AnchorDelete a Script URI ParametersDelete a Script URI ParametersDelete a Script: URI Parameters

AnchorList ScriptsList ScriptsList Scripts

List Scripts: Example Response

AnchorModify a ScriptModify a ScriptModify a Script

AnchorModify a Script Example RequestModify a Script Example RequestModify a Script: Example Request

AnchorRead a ScriptRead a ScriptRead a Script

Anchor
Create a Script Script Properties
Create a Script Script Properties
Create a Script: Script Properties

Anchor
Create a Script Notes Properties
Create a Script Notes Properties
Create a Script: Notes Properties

Anchor
Delete a Script
Delete a Script
Delete a Script

Anchor
Delete a Script URI Parameters
Delete a Script URI Parameters
Delete a Script: URI Parameters

Anchor
List Scripts
List Scripts
List Scripts

Anchor
Modify a Script
Modify a Script
Modify a Script

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

Anchor
Read a Script
Read a Script
Read a Script