...
Universal Controller supports the following RESTful-based web services for Script operations, which are listed alphabetically on this page.
- 794500104
- 794500104
- 794500104
- 794500104
- 794500104Create a Script
- Delete a Script
- List Scripts
- Modify a Script
- Read a Script
Formatting specifications for each web service, including details about property requirements, are provided.
...
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. |
Anchor | ||||
---|---|---|---|---|
|
...
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
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 |
...
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 |
|
...
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
|
|
...
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 |
|
...
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 | ||||
---|---|---|---|---|
|
...