...
XML Request | JSON Request | |||||||
---|---|---|---|---|---|---|---|---|
|
...
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
...
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, |
...
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 specifyscriptname
andscriptid
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 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 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", "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", "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 | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
URI
...
HTTP Method
...
GET
...
Description
...
Retrieves information on a specific Script.
...
URI Parameters
...
See Read a Script: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/script?scriptname=test
- http://localhost:8080/uc/resources/script?scriptid=f87848b00a0001037f43e7c81c8ec969
...
Example Response
...
See Read a Script: Example Response, below.
...
Script Properties
...
See Create a Script: Script Properties.
...
Notes Properties
...
See Create a Script: Notes Properties.
...
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
...
XML Response
...
JSON Response
...
Expand | ||
---|---|---|
| ||
|
...
Expand | ||
---|---|---|
| ||
|
...
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
content | Content | Content of the script or SAP definition file. | Y | ||||||||||||
description | Description | User-defined; description of this record. | N | ||||||||||||
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 | |||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||
exportTable | n/a | Record table information. | read only | N | |||||||||||
opswisewGroups | Member of Business Services | Business Services that this record belongs to.
| N | ||||||||||||
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 | ||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Script web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||
scriptName | Script Name | Name of the script. | This name can be the same as the name of the script file. | Y | |||||||||||
scriptType | Script Type | Type of Script | Valid Values:
Default is Script (1). | N | |||||||||||
sysId | n/a | System ID field in the database for this Script record. | Persisted only if retainSysIds is set to true. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
sysId | n/a | sys_id used within the Controller to identify this Note. | N | |||||||
text | Text | Text of this note. | N | |||||||
title | Title | Title of this note. | N |
Anchor | ||||
---|---|---|---|---|
|
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 |
|
Anchor | ||||
---|---|---|---|---|
|
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Script. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this Script. | String; URI parameter. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
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 | |
Notes Properties |
List Scripts: Example Response
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/script |
HTTP Method | PUT |
Description | Modifies the Script specified by the |
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 | |
Notes Properties | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
URI | http://host_name/uc/resources/script |
HTTP Method | GET |
Description | Retrieves information on a specific Script. |
URI Parameters | See Read a Script: URI Parameters, below. |
Example URI | |
Example Response | See Read a Script: Example Response, below. |
Script Properties | |
Notes Properties |
Anchor | ||||
---|---|---|---|---|
|
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Script. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this Script. | String; URI parameter. | Y |
|
Read a Script: Example Response
|
|