Script Web Services
Overview
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.
Create a Script
|
Description |
---|---|
URI |
http://host_name/uc/resources/script |
HTTP Method |
POST |
Description |
Creates a Script. |
Example URI |
http://localhost:8080/uc/resources/script |
Consumes Content-Type |
application/xml, application/json |
Produces Content-Type |
n/a |
Example Request |
See Create a Script: Example Request, below. |
Example Response |
|
Script Properties |
See Create a Script: Script Properties, below. |
Notes Properties |
See Create a Script: Notes Properties, below. |
Create a Script: Example Request
XML Request |
JSON Request |
---|---|
|
|
Create a Script: Script Properties
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 |
|
n/a |
Universal Controller release that the record was exported from. |
read only | N |
|
n/a | Record table information. | read only | N |
|
Member of Business Services |
Business Services that this record belongs to. <opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups> "opswiseGroups": ["group1","group2"] |
|
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. |
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 |
Create a Script: Notes Properties
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 |
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 |
|
Delete a Script: URI Parameters
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 |
|
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 |
|
Notes Properties |
List Scripts: Example Response
|
|
Modify a Script
|
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 |
|
Modify a Script: Example Request
XML Request |
JSON Request |
---|---|
|
|
Read a Script
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 |
Read a Script: URI Parameters
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
|
|