...
Anchor |
---|
| Create a Script Example Request |
---|
| Create a Script Example Request |
---|
|
Create a Script: Example Request
...
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
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Content
...
Content of the script or SAP definition file.
...
Y
...
Description
...
User-defined; description of this record.
...
N
...
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
...
Universal Controller release that the record was exported from.
...
Member of Business Services
Business Services that this record belongs to.
Â
XML
...
Â
JSON
...
N
...
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
...
n/a
...
Specification for whether or not the Create a Script web service will persist the sysId property.
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.
Expand |
---|
| <scripts><script retainSysIds="true">
<content>echo %*</content>
<description>description</description>
<notes>
<note>
<sysId>a8756a120a00010357097d05fa5c558e</sysId>
<text>test</text>
<title>note 1</title>
</note>
</notes>
<opswiseGroups>
<opswiseGroup>1</opswiseGroup>
<opswiseGroup>2</opswiseGroup>
</opswiseGroups>
<resolveVariables>false</resolveVariables>
<scriptName>test.bat</scriptName>
<scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script> |
|
Expand |
---|
| {
"content": "echo",
"description": "description",
"notes": [ {
"sysId": "a8756a120a00010357097d05fa5c558e",
"text": "test",
"title": "note"
} ],
"opswiseGroups": ["1","2"],
"resolveVariables": false,
"retainSysIds": true,
"scriptName": "test.bat",
"scriptType": "Script",
"sysId": "f8756a120a00010357097d05fa5c558e"
}
|
|
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 |
---|
<opswiseGroups>
<opswiseGroup>group1</opswiseGroup>
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups> |
 JSON Panel |
---|
"opswiseGroups": ["group1","group2"] |
|
| 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 |
---|
| 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 |
| 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 |
| 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 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
|
List ScriptsList Scripts: Example Response
Expand |
---|
| <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="23">
<content>echo<content>echo %?*</content>content>
<description>description</description><description>description</description>
<notes>
<note>
<sysId>a8756a120a00010357097d05fa5c558e</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>test<scriptName>test2.bat</scriptName>
<scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>
<script exportReleaseLevel=scriptName>
<scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558f</sysId>
</script>
</scripts>
|
|
Expand |
---|
|
[
{
"content": "echo",
"description": "description", "exportReleaseLevel": "7.2.0.0", "exportTable=": "ops_script" version="3">
<content>echo ?*</content>
<description>description</description>
script",
"notes": [ {
<notes>
"sysId": "a8756a120a00010357097d05fa5c558e",
"text": "test",
"title": "note"
<note> } ],
"opswiseGroups": ["group1","group2"],
"resolveVariables": false,
"scriptName": "test.bat",
"scriptType": "Script",
<sysId>a8756a120a00010357097d05fa5c558f</sysId>
"sysId": "f8756a120a00010357097d05fa5c558e",
"version": 2
<text>test</text>
},
{
"content": "echo",
"description": "description", "exportReleaseLevel": "7.2.0.0", "exportTable": "ops_script",
<title>note 1</title>"notes": [ {
"sysId": "a8756a120a00010357097d05fa5c558f",
"text": "test",
</note> "title": "note"
} ],
</notes> <"opswiseGroups>
": ["group1","group2"],
"resolveVariables": false,
"scriptName": "test2.bat",
<opswiseGroup>group1</opswiseGroup>"scriptType": "Script",
"sysId": "f8756a120a00010357097d05fa5c558f",
"version": 3
}
<opswiseGroup>group2</opswiseGroup>
</opswiseGroups>
<resolveVariables>false</resolveVariables>
<scriptName>test2.bat</scriptName>
<scriptType>Script</scriptType>
<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
}
]
|
...
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>.
...
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 XML Request | JSON Request |
---|
Expand |
---|
| <script retainSysIds="true">
<content>echo %*</content>
<description>description</description>
<notes>
<note>
<sysId>a8756a120a00010357097d05fa5c558e</sysId>
<text>test</text>
<title>note 1</title>
</note>
</notes>
<opswiseGroups>
<opswiseGroup>1</opswiseGroup>
<opswiseGroup>2</opswiseGroup>
</opswiseGroups>
<resolveVariables>false</resolveVariables>
<scriptName>test.bat</scriptName>
<scriptType>Script</scriptType>
<sysId>f8756a120a00010357097d05fa5c558e</sysId>
</script>
|
|
Expand |
---|
| {
"content": "echo",
"description": "description",
"notes": [ {
"sysId": "a8756a120a00010357097d05fa5c558e",
"text": "test",
"title": "note"
} ],
"opswiseGroups": ["1","2"],
"resolveVariables": false,
"retainSysIds": true,
"scriptName": "test.bat",
"scriptType": "Script",
"sysId": "f8756a120a00010357097d05fa5c558e"
}
|
|
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
}
|
|
...