1 Overview
- 1.1 Bundles
- 1.2 Promotion
2 Bundles
3 Bundle Report
- 3.1 Bundle Report: URI Parameters
- 3.2 Bundle Report: Example Response
4 Create a Bundle
- 4.1 Create a Bundle: Example Request
- 4.2 Bundle Properties
5 Create a Bundle By Business Services
- 5.1 Create a Bundle By Business Services: Example Request
- 5.2 Create a Bundle By Business Services Properties
6 Create a Bundle By Date
- 6.1 Create a Bundle By Date: Example Request
- 6.2 Create a Bundle By Date Properties
7 Delete a Bundle
- 7.1 Delete a Bundle: URI Parameters
8 List Bundles
- 8.1 List Bundles Request Parameters
- 8.2 List Bundles: Example Response
9 Modify a Bundle
- 9.1 Modify a Bundle: Example Request
10 Read a Bundle
- 10.1 Read a Bundle: URI Parameters
- 10.2 Read a Bundle: Example Response
11 Promotion
12 Bundleless Promotion
- 12.1 Bundleless Promotion: XML and JSON Examples
- 12.2 Bundleless Promotion: Properties
13 Cancel a Scheduled Bundle Promotion
- 13.1 Cancel a Scheduled Bundle Promotion: URI Parameters
- 13.2 Cancel a Scheduled Bundle Promotion: XML and JSON Examples
14 Delete a Scheduled Bundle Promotion
- 14.1 Delete a Scheduled Bundle Promotion: URI Parameters
15 Promote a Bundle or Schedule a Bundle Promotion
- 15.1 Promote a Bundle or Schedule a Bundle Promotion: XML and JSON Examples
- 15.2 Promote a Bundle or Schedule a Bundle Promotion: Properties
16 Create a Promotion Target
- 16.1 Create a Promotion Target: Example Request
- 16.2 Promotion Target Properties
17 Modify a Promotion Target
- 17.1 Modify a Promotion Target: Example Request
18 List Promotion Targets
- 18.1 List Promotion Targets: URI Parameters
- 18.2 List Promotion Targets: Example Response
19 Delete a Promotion Target
20 Delete Promotion Target: URI Parameters
21 Read a Promotion Target
- 21.1 Read a Promotion Target: URI Parameters
- 21.2 Read a Promotion Target: Example Response
22 Refresh Target Agents
- 22.1 Refresh Target Agents: URI Parameters
- 22.2 Refresh Target Agents: Example Request

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:

Promotion

Bundleless Promotion
Cancel a Scheduled Bundle Promotion
Delete a Scheduled Bundle Promotion
Promote a Bundle or Schedule a Bundle Promotion
Create a Promotion Target
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

	Description
URI	http://host_name/uc/resources/bundle/report
HTTP Method	GET
Description	Retrieve Bundle Report details using specific query parameters.
Example URI	http://localhost:8080/uc/resources/bundle/report?bundlename=test-bundle http://localhost:8080/uc/resources/bundle/report?bundleid=12345
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
`bundleid`	UUID	ID used within the Controller to identify this Bundle.	String value of the bundle sysId.	Y (unless `bundlename` is specified)	`bundlename`
`bundlename`	Bundle Name	Name used within the Controller to identify this Bundle.	String value of the bundle name.	Y (unless `bundleid` is specified)	`bundleid`

Bundle Report: Example Response

XML Response	JSON Response

XML Response

JSON 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>

Bundles and Promotion Web Services

.css-sa5fy1{color:var(--ds-link, #1868DB);}.css-sa5fy1:hover{color:var(--ds-link, #1868DB);-webkit-text-decoration:underline;text-decoration:underline;}.css-sa5fy1:active{color:var(--ds-link-pressed, #1558BC);}Bundles

Promotion

Bundles

Bundle Report

Bundle Report: URI Parameters

Bundle Report: Example Response

Bundles