Bundles and Promotion Web Services
- Stonebranch (Deactivated)
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 |
---|---|
XML Response <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bundle retainSysIds="true"> <name>bundle-test</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> <description>bundle test</description> <defaultPromotionTarget>local</defaultPromotionTarget> <followReferences>true</followReferences> <excludeOnExistence> Triggers, Tasks, Calendars, Custom Days, Variables, Credentials, Agent Clusters, Virtual Resources, Scripts, Email Templates, Email Connections, Database Connections, SAP Connections, PeopleSoft Connections, SNMP Managers</excludeOnExistence> <opswiseGroups> <opswiseGroup>bus-1</opswiseGroup> <opswiseGroup>bus-2</opswiseGroup> </opswiseGroups> <promoteBundleDefinition> true</promoteBundleDefinition> <promoteByBusinessServices> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </promoteByBusinessServices> <visibleTo> ops.admin</visibleTo> <bundleTasks> <bundleTask> <name>win-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> <bundleTask> <name>abc</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> </bundleTasks> <bundleApplications> <bundleApplication> <name>App-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleApplication> </bundleApplications> <bundleTriggers> <bundleTrigger> <name>manual-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> <bundleTrigger> <name>time-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> </bundleTriggers> <bundleCalendars> <bundleCalendar> <name>cal-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCalendar> </bundleCalendars> <bundleCustomDays> <bundleCustomDay> <name>custome-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCustomDay> </bundleCustomDays> <bundleVariables> <bundleVariable> <name>var1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVariable> </bundleVariables> <bundleBusinessServices> <bundleBusinessService> <name>bus-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleBusinessService> </bundleBusinessServices> <bundleCredentials> <bundleCredential> <name>sap-cred</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCredential> </bundleCredentials> <bundleAgentClusters> <bundleAgentCluster> <name>Opswise - Default Windows Cluster</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleAgentCluster> </bundleAgentClusters> <bundleVirtualResources> <bundleVirtualResource> <name>VR-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVirtualResource> </bundleVirtualResources> <bundleScripts> <bundleScript> <name>script-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleScript> </bundleScripts> <bundleEmailTemplates> <bundleEmailTemplate> <name>email-temp-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailTemplate> </bundleEmailTemplates> <bundleEmailConnections> <bundleEmailConnection> <name>Email-con-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailConnection> </bundleEmailConnections> <bundleDatabaseConnections> <bundleDatabaseConnection> <name>DB-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleDatabaseConnection> </bundleDatabaseConnections> <bundleSapConnections> <bundleSapConnection> <name>SAP-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSapConnection> </bundleSapConnections> <bundlePeoplesoftConnections> <bundlePeoplesoftConnection> <name>People-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundlePeoplesoftConnection> </bundlePeoplesoftConnections> <bundleSnmpManagers> <bundleSnmpManager> <name>snmp-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSnmpManager> </bundleSnmpManagers> <bundleUniversalTemplates> <bundleUniversalTemplate> <name>univ-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleUniversalTemplate> </bundleUniversalTemplates> </bundle> | JSON Response { "retainSysIds": true, "name": "bundle-1", "sysId": "b52335345df646e5b597dc26df599344", "description": "bundle test 1", "opswiseGroups": [ "bus-1", "bus-2" ], "defaultPromotionTarget": "local", "excludeOnExistence": "Triggers, Tasks, Calendars, Custom Days, Variables, Credentials, Agent Clusters, Virtual Resources, Scripts, Email Templates, Email Connections, Database Connections, SAP Connections, PeopleSoft Connections, SNMP Managers, Applications", "followReferences": true, "promoteBundleDefinition": true, "promoteByBusinessServices": [ "bus-1", "bus-2" ], "visibleTo": "ops.admin", "bundleAgentClusters": [ { "name": "Opswise - Default Linux/Unix Cluster", "sysId": "0d7f03026a96451fbc3d7a8eecd641d5" }, { "name": "Opswise - Default Windows Cluster", "sysId": "d3f8282f702544d69500928afbcc00f0" } ], "bundleApplications": [ { "name": "app-1", "sysId": "e12830a711c849388819230203e601d3" } ], "bundleBusinessServices": [ { "name": "bus-1", "sysId": "b939eedb63544517accd905cfdd13b22" } ], "bundleCalendars": [ { "name": "cal-1", "sysId": "655b9c498e574ace886b114f79d5933a" } ], "bundleCredentials": [ { "name": "cred-1", "sysId": "d04886ac74be43a0aa3faa8042f82cca" } ], "bundleCustomDays": [ { "name": "cust-1", "sysId": "1b0e9acedb98439a8319ac3cd51c21ba" } ], "bundleDatabaseConnections": [ { "name": "db-con-1", "sysId": "fc8223ece09f407bb9b5bb865574cb49" } ], "bundleEmailConnections": [ { "name": "email-conn", "sysId": "bd54eae4221a4f909454f7fa04c75efb" } ], "bundleEmailTemplates": [ { "name": "email-temp-1", "sysId": "5dce586a419448ee83fa121589d60a75" } ], "bundlePeoplesoftConnections": [ { "name": "ps-con-1", "sysId": "aac40dfd5c3242ae9bcaaf169a5468b9" } ], "bundleSapConnections": [ { "name": "sap-1", "sysId": "a4b0544fb668404ba10b2826b2e6db81" } ], "bundleScripts": [ { "name": "script-1", "sysId": "01e90371bed4473d87dad00148512f35" } ], "bundleSnmpManagers": [ { "name": "snmp-1", "sysId": "4bfa01f747ca4ad5b4ee9e073d643604" } ], "bundleTasks": [ { "name": "win-1", "sysId": "3b50f8c015d6494288328cfdb35d9ea7" } ], "bundleTriggers": [ { "name": "cron-trig-1", "sysId": "d2869f93a68547beb8e5b156d4fac99e" } ], "bundleUniversalTemplates": [ { "name": "uni-1", "sysId": "0ff4abb1d80c4f95b517dc073c9abd0c" } ], "bundleVariables": [ { "name": "var1", "sysId": "9988d78bf82e44dbae66cf0e8ec4b820" } ], "bundleVirtualResources": [ { "name": "VR-1", "sysId": "deeaf3e516ce485fac5fc2283022d904" } ] } |
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 |
---|---|
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 |
| 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 |
| 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 |
---|---|
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 |
---|---|
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 |
---|---|
XML Response
| JSON Response
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"type": "Single Date"
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
"addedBy": "ops.admin",
] |
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 |
---|---|
XML Request
| JSON Request
|
Read a Bundle
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 Bundle Properties. |
Read 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 |
|
Read a Bundle: Example Response
The
exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML Response | JSON Response |
---|---|
XML Response
| JSON Response
|