...
...
...
...
...
...
Panel | ||||
---|---|---|---|---|
|
...
Universal Controller supports the following RESTful-based web services for Bundles and Promotion operations, which are listed alphabetically on this page under two categories:
Bundles
...
- Bundle Report
- Create a Bundle
- Bundles and Promotion Web Services#Delete Delete a BundleBundles and Promotion Web Services#List
- List Bundles
- Bundles and Promotion Web Services#Modify Modify a BundleBundles and Promotion Web Services#Read
- Read a Bundle
...
Promotion
...
- Bundleless Promotion
- Cancel a Scheduled Bundle Promotion
- Bundles and Promotion Web Services#Delete Delete a Scheduled Bundle Promotion
- Bundles and Promotion Web Services#Promote Promote a Bundle or Schedule a Bundle Promotion
Bundles and Promotion Web Services#Create Create a Promotion Target
Bundles and Promotion Web Services#Modify- Modify a Promotion Target
- Bundles and Promotion Web Services#List List Promotion Targets
- Delete a Promotion Target
- Bundles and Promotion Web Services#Read Read a Promotion TargetBundles and Promotion Web Services#Refresh
- Refresh Target Agents
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Description | |
---|---|
URI | http://host_name/uc/resources/bundle/report |
HTTP Method | GET |
Description | Retrieve Bundle Report details using specific query parameters. |
Example URI | |
URI Parameters | See Bundle Report: URI Parameters, below. |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Bundle Report: Example Response, below. |
Properties | See Bundles and Promotion Web Services#Bundle Bundle Properties. |
Anchor | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/bundle |
HTTP Method | POST |
Description | Creates a Bundle. |
Example URI | http://localhost:8080/uc/resources/bundle |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Bundle: Example Request, below. |
Properties | See Bundles and Promotion Web Services#Bundle Bundle Properties. |
Example Response |
|
...
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| Agent Clusters | Task Items to include | String value of task | N | ||||||
| Applications | Applications to include | String value of Applications | N | ||||||
| Business Services | Business Services Items to include | String value of Business Services | N | ||||||
| Calendars | Calendars Items to include | String value of Calendars | N | ||||||
| Credentials | Agent Clusters Items to include | String value of Agent Clusters | N | ||||||
| Custom Days | Custom Days Items to include | String value of Custom Days | N | ||||||
| Database Connections | Database Connections Items to include | String value of Database Connections | N | ||||||
| Email Connections | Email Connections Items to include | String value of Email Connections | N | ||||||
| Email Templates | Email Templates Items to include | String value of Email Templates | N | ||||||
| OAuth Clients | OAuth Client Items to include | String value of OAuth Clients | N | ||||||
| PeopleSoft Connections | PeopleSoft Connections Items to include | String value of PeopleSoft Connections | N | ||||||
| Sap Connections | Sap Connections Items to include | String value of Sap Connections | N | ||||||
| Scripts | Scripts Items to include | String value of Scripts | N | ||||||
| SNMP Managers | SNMP Managers Items to include | String value of SNMP Managers | N | ||||||
| Tasks | Task Items to include | String value of task | N | ||||||
| Triggers | Triggers Items to include | String value of Triggers | N | ||||||
| Universal Templates | Universal Templates Items to include | String value of Universal Templates | N | ||||||
| Variables | Variables Items to include | String value of Variables | N | ||||||
| Virtual Resources | Virtual Resources Items to include | String value of Virtual Resources | N | ||||||
| Default Promotion Target | Promotion Target server name | String value of target | N | ||||||
| Description | Bundle description | String value of description | N | ||||||
| Exclude On Existence | Exclude Items on existence | String value | 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 | ||||||
| Follow References | Follow references items | Boolean value | N | ||||||
| Bundle Name | Bundle name | String value of the bundle name | Y | ||||||
| Member Of Business Services | List of Business Services that this task belongs to | String value | N | ||||||
| Promote Bundle Definition | Promote Bundle Definition | Boolean value | N | ||||||
| Promote Member of Business Service | Promote List of Business Services that this task belongs to | String value | N | ||||||
sysId | n/a | System ID field in the database for this Bundles record. | Persisted only if retainSysIds is set to true. | N | ||||||
| Visible To | Visible to user | String value of user name | N |
...
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Creates a Bundle. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Bundle By Business Services: Example Request, below. |
Properties | See Bundles and Promotion Web Services#Create Create a Bundle By Business Services Properties. |
Example Response |
|
...
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Creates a Bundle. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Bundle By Date: Example Request, below. |
Properties | See Bundles and Promotion Web Services#Create Create a Bundle By Date Properties. |
Example Response |
|
...
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/bundle/list |
HTTP Method | GET |
Description | Retrieves information on all Bundles. |
Example URI | |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Bundles: Example Response, below. |
Properties | See Bundles and Promotion Web Services#Bundle Properties Bundle Properties. |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
| n/a | Request parameter bundlename. | String value of the bundle name. Wildcards are are supported. | N | ||||||
| n/a | Request parameter businessServices. | String value of the bundle business service. | N | ||||||
| n/a | Request parameter defaultPromotionTarget. | String value of the promotion target. Wildcards are are supported. | N |
Anchor | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/bundle |
HTTP Method | PUT |
Description | Modifies the Credential specified by the |
Example URI | http://localhost:8080/uc/resources/bundle |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Modify a Bundle: Example Request, below. |
Properties | See Bundles and Promotion Web Services#Bundle Bundle Properties. |
Example Response |
|
...
URI | http://host_name/uc/resources/bundle |
HTTP Method | GET |
Description | Retrieve Bundle details using a specific query parameters. |
URI Parameters | See Read a Bundle: URI Parameters, below. |
Example URI | |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Read a Bundle: Example Response, below. |
Properties | See Bundles and Promotion Web Services#Bundle Bundle Properties. |
Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
itemType | n/a | Item type for promotion item(s). | Valid Values: One of the following (not case sensitive):
| Y | ||||||||||||
itemIds | n/a | IDs for promotion items. | Comma-separated list of promotion item IDs. | Y (unless itemNames is specified) | itemNames | |||||||||||
itemNames | n/a | Names for promotion items. | Comma-separated list of promotion item names. | Y (unless itemIds is specified) | itemIds | |||||||||||
promotionTargetId | n/a | ID of the Promotion Target. | Y (unless promotionTargetName is specified) | promotionTargetName | ||||||||||||
promotionTargetName | Promotion Target | Name of the Promotion Target. | Y (unless promotionTargetId is specified) | promotionTargetId | ||||||||||||
overrideUser | User | User name to use instead of the default User name for the Promotion Target. | Y (if overridePassword is specified) | |||||||||||||
overridePassword | Password | User password to use instead of the default User password for the Promotion Target. | Y (if overrideUser is specified) | |||||||||||||
| Personal Access Token | Personal Access Token to use instead of the default personal access token for the Promotion Target. | If both | N | ||||||||||||
excludeOnExistence | Exclude On Existence | Item types that will not be updated if they exist on the target server. | Comma-separated list of excluded types. Valid Values:
| N | ||||||||||||
followReferences | Follow References | Dynamically include items in the promotion that are referenced by promotion items. | Valid values:
| N | ||||||||||||
| Allow Universal Template Changes | Allow the promotion to contain new or changed Universal Templates. | Valid values:
| N |
Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
allowUnvTmpltChanges | Allow Universal Template Changes | Allow the promotion to contain new or changed Universal Templates. | Valid values:
| N | ||||||||||||
createSnapshot | Create Snapshot | Schedule the Bundle promotion using the current Bundle records. | Valid values:
| N | ||||||||||||
date | Date | Date on which to promote the Bundle. | Y | |||||||||||||
id | n/a | 32-character sysid of the Bundle to be promoted. | Y |
| ||||||||||||
name | Bundle Name | Name of the Bundle to be promoted. | Y |
| ||||||||||||
notificationOption | System Notification | System Notification to send on success and/or failure of the promotion. | Valid values (not case sensitive):
| N | ||||||||||||
overridePassword | Password | User password to use instead of the default User password for the promotion target. | Y | |||||||||||||
| Personal Access Token | Personal Access Token to use instead of the default personal access token for the Promotion Target. | If both | N | ||||||||||||
overrideUser | User | User name to use instead of the default User name for the promotion target. | Y | |||||||||||||
promotionTargetId | n/a | ID of the Controller cluster node on which to promote the Bundle. | Default is the Default Promotion Target of the specified Bundle. | N |
| |||||||||||
promotionTargetName | Promotion Target | Name of the Controller cluster node on which to promote the Bundle. | Default is the Default Promotion Target of the specified Bundle. | N |
| |||||||||||
schedule | Schedule | Indication of whether or not to schedule a Bundle promotion. | Valid values
| Y | ||||||||||||
time | Time | Time on which to promote the Bundle. | Default is 00:00. | N |
...
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Creates a Promotion Target. |
Example URI | http://localhost:8080/uc/resources/promotiontarget |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Promotion Target: Example Request, below. |
Properties | See Bundles and Promotion Web Services#Promotion Target Properties. |
Example Response |
|
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| n/a | List of agentMapping details associated with the Controller | agentMapping details |
| n/a | List of agentMapping details associated with the Controller | agentMapping details | N | |||||||||
| Authentication Method | Authentication method to use on the target cluster node of the universal controller. | Valid Values:
Default is Basic (1). | N | |||||||||||||
description | Description | Promotion Target description | String value of description | 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 | |||||||||||||
name | Name | Name for this Promotion Target. | String value of the promotion target name | Y | |||||||||||||
| Member Of Business Services | List of Business Services that this task belongs to | String value | N | |||||||||||||
| Password | Login password on the target cluster node of Universal Controller. | String value of password | N | |||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Promotion Target web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||||
| Source Agent | List of source agent names. | List of source agent names. | N | |||||||||||||
| n/a | System ID field in the database for this Prommotion Target record. | Persisted only if retainSysIds is set to true. | N | |||||||||||||
| Target Agent | Target agent name. | String value of the target agent name. | Y | |||||||||||||
| Personal Access Token | if authenticationMethod = Access Token; the personal access token to use for authentication. | String value | N | |||||||||||||
| Type | Agent type. | String value of agent type. (For example, Windows) | Y | |||||||||||||
| URI | Uniform Resource Identifier (URI) used to locate the Promotion Target cluster node. | String value uri. | Y | |||||||||||||
user | User | Login ID on the target cluster node of Universal Controller. | String value of user. | N |
...
Description | |
---|---|
URI | |
HTTP Method | PUT |
Description | Updates a Promotion Target. |
Example URI | http://localhost:8080/uc/resources/promotiontarget |
Authentication | HTTP Basic |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Modify a Promoition Target: Example Request, below. |
Properties | See Bundles and Promotion Web Services#Promotion Target Properties. |
Example Response |
|
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
|
...
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieve Promotion Target details. |
URI Parameters | See List Promotion Targets: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/promotiontarget/list?targetname=test http://localhost:8080/uc/resources/promotiontarget/list?targetname=* http://localhost:8080/uc/resources/promotiontarget/list?targetname=local&businessServies=bus-1,bus-2 |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Respone | See List Promoition Targets: Example Response, below. |
Response Properties | See Bundles and Promotion Web Services#Promotion Target Properties. |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| N/A | Request parameter targetname | String value of the target name. Wildcards are supported. | N |
| N/A | Request parameter businessServices. | String value of the business service | N |
...
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Response |
|
|
...
Description | |
---|---|
URI | |
HTTP Method | DELETE |
Description | Delete a specified Promotion Target. |
URI Parameters | See Delete a Promotion Target: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/promotiontarget?targetname=test http://localhost:8080/uc/resources/promotiontarget?targetid=ed76d6c78f06402d882e155bfd42b98f |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | text/plain |
Properties | See Bundles and Promotion Web Services#Promotion Target Properties. |
Example Response |
|
...
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieve a specified Promotion Target details. |
URI Parameters | See Read a Promotion Target: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/promotiontarget?targetname=test http://localhost:8080/uc/resources/promotiontarget?targetid=ed76d6c78f06402d882e155bfd42b98f |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See Read a Promoition Target: Example Response, below. |
Response Properties | See Bundles and Promotion Web Services#Promotion Target Properties. |
Anchor | ||||
---|---|---|---|---|
|
...
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
Examples | XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Example Request |
|
|
Anchor | ||||
---|---|---|---|---|
|
...
Property | Description | Specifications | Required | Mutually Exclusive |
---|---|---|---|---|
| Name for this Promotion Target. | String value of the promotion target name passed as query parameter. | Y |
|
| Promotion Target sysId. | String value of the promotion target sysId passed as query parameter. | Y (unless targetname is specified) |
|
| Override Personal Access Token on the target cluster node of Universal Controller. | String value of personal access token, passed as request body. | N | |
| Override Login ID on the target cluster node of Universal Controller. | String value of user, passed as request body. | NY | |
| Override Login password on the target cluster node of Universal Controller. | String value of password, passed as request body.N | Y |
Anchor | ||||
---|---|---|---|---|
|
...