Bundles and Promotion Web Services
Overview
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
Promotion
- Bundleless Promotion
- Cancel a Scheduled Bundle Promotion
- Delete a Scheduled Bundle Promotion
- Promote a Bundle or Schedule a Bundle Promotion
- Modify a Promotion Target
- List Promotion Targets
- Delete a Promotion Target
- Read a Promotion Target
- Refresh Target Agents
Formatting specifications for each web service, including details about parameter requirements, are provided.
Bundles
Bundle Report
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 Bundle Properties. |
Bundle Report: URI Parameters
Parameter | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| UUID | ID used within the Controller to identify this Bundle. | String value of the bundle sysId. | Y |
|
| Bundle Name | Name used within the Controller to identify this Bundle. | String value of the bundle name. | Y |
|
Bundle Report: Example Response
XML Response | JSON Response |
---|---|
Create a Bundle
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 Bundle Properties. |
Example Response |
|
Create a Bundle: Example Request
XML Request | JSON Request |
---|---|
Bundle Properties
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 |
| 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 |
| n/a | Universal Controller release that the record was exported from. | read only | N |
| 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 |
| 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 |
Create a Bundle By Business Services
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 | |
Example Response |
|
Create a Bundle By Business Services: Example Request
XML Request | JSON Request |
---|---|
Create a Bundle By Business Services Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Bundle Name | Bundle name | String value of the bundle name. | Y |
| Types To Include | Include item types | String value. | Y |
| Member Of Business Services | List of Business Services that this bundle belongs to | String value of the list. | N |
| Business Services To Include | Include List of Business Services for this bundle creation | String value of the list. | Y |
Create a Bundle By Date
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 | |
Example Response |
|
Create a Bundle By Date: Example Request
XML Request | JSON Request |
---|---|
Create a Bundle By Date Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Bundle Name | Bundle name | String value of the bundle name. | Y |
| Types To Include | Include item types | String value. | Y |
| Member Of Business Services | List of Business Services that this bundle belongs to | String value of the list. | N |
| Business Services To Include | Include List of items created On/After the dae | String value of the date. | Y |
Delete a Bundle
Description | |
---|---|
URI | http://host_name/uc/resources/bundle |
HTTP Method | DELETE |
Description | Deletes a Bundle. |
URI Parameters | See Delete a Bundle: URI Parameters, below. |
Example URI | |
Example Response |
|
Delete a Bundle: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Bundle. | String value of the bundle sysId. | Y |
|
| Name used within the Controller to identify this Bundle. | String value of the bundle name. | Y |
|
List Bundles
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 Bundle Properties. |
List Bundles Request Parameters
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| n/a | Request parameter bundlename. | String value of the bundle name. Wildcards 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 supported. | N |
List Bundles: Example Response
XML Response | JSON Response |
---|---|
Modify a Bundle
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 Bundle Properties. |
Example Response |
|
Modify a Bundle: Example Request
XML Request | JSON Request |
---|---|