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

Bundle Report
Create a Bundle
Delete a Bundle
List Bundles
Modify a Bundle
Read a Bundle

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

<?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	Status 200 /OK Successfully created the Bundle with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

Create a Bundle: Example Request

XML Request

JSON Request

XML Request

<?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 Request

  {
    "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"
      }
    ]
  }

Bundle Properties

Property	UI Field Name	Description	Specifications	Required
`bundleAgentClusters`	Agent Clusters	Task Items to include	String value of task	N
`bundleApplications`	Applications	Applications to include	String value of Applications	N
`bundleBusinessServices`	Business Services	Business Services Items to include	String value of Business Services	N
`bundleCalendars`	Calendars	Calendars Items to include	String value of Calendars	N
`bundleCredentials`	Credentials	Agent Clusters Items to include	String value of Agent Clusters	N
`bundleCustomDays`	Custom Days	Custom Days Items to include	String value of Custom Days	N
`bundleDatabaseConnections`	Database Connections	Database Connections Items to include	String value of Database Connections	N
`bundleEmailConnections`	Email Connections	Email Connections Items to include	String value of Email Connections	N
`bundleEmailTemplates`	Email Templates	Email Templates Items to include	String value of Email Templates	N
`bundleOAuthClients`	OAuth Clients	OAuth Client Items to include	String value of OAuth Clients	N
`bundlePeoplesoftConnections`	PeopleSoft Connections	PeopleSoft Connections Items to include	String value of PeopleSoft Connections	N
`bundleSapConnections`	Sap Connections	Sap Connections Items to include	String value of Sap Connections	N
`bundleScripts`	Scripts	Scripts Items to include	String value of Scripts	N
`bundleSnmpManagers`	SNMP Managers	SNMP Managers Items to include	String value of SNMP Managers	N
`bundleTasks`	Tasks	Task Items to include	String value of task	N
`bundleTriggers`	Triggers	Triggers Items to include	String value of Triggers	N
`bundleUniversalTemplates`	Universal Templates	Universal Templates Items to include	String value of Universal Templates	N
`bundleVariables`	Variables	Variables Items to include	String value of Variables	N
`bundleVirtualResources`	Virtual Resources	Virtual Resources Items to include	String value of Virtual Resources	N
`defaultPromotionTarget`	Default Promotion Target	Promotion Target server name	String value of target	N
`description`	Description	Bundle description	String value of description	N
`excludeOnExistence`	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
`followReferences`	Follow References	Follow references items	Boolean value	N
`name`	Bundle Name	Bundle name	String value of the bundle name	Y
`opswiseGroups`	Member Of Business Services	List of Business Services that this task belongs to	String value	N
`promoteBundleDefinition`	Promote Bundle Definition	Promote Bundle Definition	Boolean value	N
`promoteByBusinessServices`	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
`visibleTo`	Visible To	Visible to user	String value of user name	N (Required if promoteByBusinessServices is specified)

Create a Bundle By Business Services

	Description
URI	http://host_name/uc/resources/bundle/bybusinessservices
HTTP Method	POST
Description	Creates a Bundle.
Example URI	http://localhost:8080/uc/resources/bundle/bybusinessservices
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 Create a Bundle By Business Services Properties.
Example Response	Status 200 Successfully created bundle "bundle-by-service2" with 1 item(s).

Create a Bundle By Business Services: Example Request

XML Request

JSON Request

XML Request

<bundle> <name>bundle-by-service2</name> <businessServices> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </businessServices> <typesToInclude> Triggers, Tasks, Calendars, Variables, Credentials</typesToInclude> <businessServicesToInclude> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </businessServicesToInclude></bundle>

JSON Request

{ " name ": "bundle-service4", " typesToInclude ": "Triggers, Tasks, Calendars, Variables, Credentials", " businessServices ": [ "bus-1", "bus-2" ], " businessServicesToInclude ": [ "bus-1", "bus-2" ]}

Create a Bundle By Business Services Properties

Property	UI Field Name	Description	Specifications	Required
`name`	Bundle Name	Bundle name	String value of the bundle name.	Y
`typesToInclude`	Types To Include	Include item types	String value.	Y
`businessServices`	Member Of Business Services	List of Business Services that this bundle belongs to	String value of the list.	N
`businessServicesToInclude`	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://host_name/uc/resources/bundle/bydate
HTTP Method	POST
Description	Creates a Bundle.
Example URI	http://localhost:8080/uc/resources/bundle/bydate
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 Create a Bundle By Date Properties.
Example Response	Status 200 Successfully created bundle "bundle-by-service2" with 1 item(s).

Create a Bundle By Date: Example Request

XML Request	JSON Request
XML Request `<bundle> <name>bundle-by-service2</name> <businessServices> <businessService>bus-1</businessService>` `<businessService>bus-2</businessService>` `</businessServices>` `<typesToInclude> Triggers, Tasks, Calendars, Variables, Credentials</typesToInclude> <updatedOnOrAfter> 2020-07-01 00:00:00 -0400</updatedOnOrAfter></bundle>`	JSON Request `{ " name ": "bundle-service4",` `" typesToInclude ": "Triggers, Tasks, Calendars, Variables, Credentials",` `" businessServices ": [` `"bus-1",` `"bus-2"` `],` `" updatedOnOrAfter ":"2020-07-01 00:00:00 -0400"}`

Create a Bundle By Date Properties

Property	UI Field Name	Description	Specifications	Required
`name`	Bundle Name	Bundle name	String value of the bundle name.	Y
`typesToInclude`	Types To Include	Include item types	String value.	Y
`businessServices`	Member Of Business Services	List of Business Services that this bundle belongs to	String value of the list.	N
`updatedOnOrAfter`	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	http://localhost:8080/uc/resources/bundle?bundleid=f87848b00a0001037f43e7c81c8ec969 http://localhost:8080/uc/resources/bundle?bundlename=testbundle
Example Response	Status 200 /OK Bundle deleted successfully.

Delete a Bundle: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`bundleid`	ID used within the Controller to identify this Bundle.	String value of the bundle sysId.	Y (unless `bundlename` is specified)	`bundlename`
`bundlename`	Name used within the Controller to identify this Bundle.	String value of the bundle name.	Y (unless `bundleid` is specified)	`bundleid`

List Bundles

	Description
URI	http://host_name/uc/resources/bundle/list
HTTP Method	GET
Description	Retrieves information on all Bundles.
Example URI	http://localhost:8080/uc/resources/bundle/list?bundlename=abcd&businessServices=A&defaultPromotionTarget=local http://localhost:8080/uc/resources/bundle/list?bundlename=*
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
`bundlename`	n/a	Request parameter bundlename.	String value of the bundle name. Wildcards are supported.	N
`businessServices`	n/a	Request parameter businessServices.	String value of the bundle business service.	N
`defaultPromotionTarget`	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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><bundles> <bundle exportReleaseLevel="7.2.0.0" exportTable="ops_bundle" retainSysIds=true> <name> bundle-test</name> <sysId >b52335345df646e5b597dc26df599344</sysI> <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 addedBy="ops.admin" type="Workflow"> <name>win-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> </bundleTasks> <bundleApplications> <bundleApplication addedBy="ops.admin" type="Windows Service"> <name>App-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleApplication> </bundleApplications> <bundleTriggers> <bundleTrigger addedBy="ops.admin" type="Cron"> <name>manual-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> </bundleTriggers> <bundleCalendars> <bundleCalendar addedBy="ops.admin" type="calendar 1"> <name>cal-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCalendar> </bundleCalendars> <bundleCustomDays> <bundleCustomDay addedBy="ops.admin" description="custom day test" type="Single Date"> <name>custome-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCustomDay> </bundleCustomDays> <bundleVariables> <bundleVariable addedBy="ops.admin" description="variable 1" > <name>var1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVariable> </bundleVariables> <bundleBusinessServices> <bundleBusinessService addedBy="ops.admin"> <name>bus-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleBusinessService> </bundleBusinessServices> <bundleCredentials> <bundleCredential addedBy="ops.admin"> <name>sap-cred</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCredential> </bundleCredentials> <bundleAgentClusters> <bundleAgentCluster addedBy="ops.admin" type="Linux/Unix"> <name>Opswise - Default Windows Cluster</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleAgentCluster> </bundleAgentClusters> <bundleVirtualResources> <bundleVirtualResource addedBy="ops.admin" type="Renewable"> <name>VR-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVirtualResource> </bundleVirtualResources> <bundleScripts> <bundleScript addedBy="ops.admin" description="script 1" type="Script"> <name>script-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleScript> </bundleScripts> <bundleEmailTemplates> <bundleEmailTemplate addedBy="ops.admin"> <name>email-temp-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailTemplate> </bundleEmailTemplates> <bundleEmailConnections> <bundleEmailConnection addedBy="ops.admin" type="Outgoing"> <name>Email-con-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailConnection> </bundleEmailConnections> <bundleDatabaseConnections> <bundleDatabaseConnection addedBy="ops.admin"> <name>DB-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleDatabaseConnection> </bundleDatabaseConnections> <bundleSapConnections> <bundleSapConnection addedBy="ops.admin"> <name>SAP-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSapConnection> </bundleSapConnections> <bundlePeoplesoftConnections> <bundlePeoplesoftConnection addedBy="ops.admin"> <name>People-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundlePeoplesoftConnection> </bundlePeoplesoftConnections> <bundleSnmpManagers> <bundleSnmpManager addedBy="ops.admin"> <name>snmp-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSnmpManager> </bundleSnmpManagers> <bundleUniversalTemplates> <bundleUniversalTemplate addedBy="ops.admin"> <name>univ-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleUniversalTemplate> </bundleUniversalTemplates> </bundle> <bundles>

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": [
      {

        "addedBy": "ops.admin",
        "name": "Opswise - Default Linux/Unix Cluster",
        "sysId": "0d7f03026a96451fbc3d7a8eecd641d5",
        "type": "Windows"

      }
    ],
    "bundleApplications": [
      {

        "addedBy": "ops.admin",
        "name": "app-1", 
        "sysId": "e12830a711c849388819230203e601d3",
        "type": "Windows Service"

      }
    ],
    "bundleBusinessServices": [
      {

        "addedBy": "ops.admin",

        "name": "bus-1",
        "sysId": "b939eedb63544517accd905cfdd13b22"
      }
    ],
    "bundleCalendars": [
      {

        "addedBy": "ops.admin",
        "description": "calendar 1",

        "name": "cal-1",
        "sysId": "655b9c498e574ace886b114f79d5933a"
      }
    ],
    "bundleCredentials": [
      {

"addedBy": "ops.admin",

        "name": "cred-1",
        "sysId": "d04886ac74be43a0aa3faa8042f82cca"
      }
    ],
    "bundleCustomDays": [
      {

        "addedBy": "ops.admin",
        "description": "custom day test",

        "name": "cust-1",
        "sysId": "1b0e9acedb98439a8319ac3cd51c21ba",

"type": "Single Date"

      }
    ],
    "bundleDatabaseConnections": [
      {

"addedBy": "ops.admin",

        "name": "db-con-1",
        "sysId": "fc8223ece09f407bb9b5bb865574cb49"
      }
    ],
    "bundleEmailConnections": [
      {

"addedBy": "ops.admin",

        "name": "email-conn",
        "sysId": "bd54eae4221a4f909454f7fa04c75efb",

        "type": "Outgoing"

      }
    ],
    "bundleEmailTemplates": [
      {

"addedBy": "ops.admin",

        "name": "email-temp-1",
        "sysId": "5dce586a419448ee83fa121589d60a75"
      }
    ],
    "bundlePeoplesoftConnections": [
      {

"addedBy": "ops.admin",

        "name": "ps-con-1",
        "sysId": "aac40dfd5c3242ae9bcaaf169a5468b9"
      }
    ],
    "bundleSapConnections": [
      {

"addedBy": "ops.admin",

        "name": "sap-1",
        "sysId": "a4b0544fb668404ba10b2826b2e6db81"
      }
    ],
    "bundleScripts": [
      {

"addedBy": "ops.admin",

        "description": "script 1",

        "name": "script-1",
        "sysId": "01e90371bed4473d87dad00148512f35",

        "type": "Script"

      }
    ],
    "bundleSnmpManagers": [
      {

"addedBy": "ops.admin",

        "name": "snmp-1",
        "sysId": "4bfa01f747ca4ad5b4ee9e073d643604"
      }
    ],
    "bundleTasks": [
      {

"addedBy": "ops.admin",

        "name": "win-1",
        "sysId": "3b50f8c015d6494288328cfdb35d9ea7",

        "type": "Workflow"
      }
    ],
    "bundleTriggers": [
      {

"addedBy": "ops.admin",

        "name": "cron-trig-1",
        "sysId": "d2869f93a68547beb8e5b156d4fac99e",

        "type": "Cron"
      }
    ],
    "bundleUniversalTemplates": [
      {

"addedBy": "ops.admin",

        "name": "uni-1",
        "sysId": "0ff4abb1d80c4f95b517dc073c9abd0c"
      }
    ],
    "bundleVariables": [
      {

        "addedBy": "ops.admin",
        "description": "variable 1",

        "name": "var1",
        "sysId": "9988d78bf82e44dbae66cf0e8ec4b820"
      }
    ],
    "bundleVirtualResources": [
      {

"addedBy": "ops.admin",

        "name": "VR-1",
        "sysId": "deeaf3e516ce485fac5fc2283022d904",

        "type": "Renewable"
      }

    ]
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_bundle",
  }

Modify a Bundle

	Description
URI	http://host_name/uc/resources/bundle
HTTP Method	PUT
Description	Modifies the Credential specified by the `sysId`.
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	Status 200 /OK Successfully updated the Bundle with sysId <sysId> to version <version>.

Modify a Bundle: Example Request

XML Request

JSON Request

XML Request

<?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 Request

  {
    "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",
      }
    ]
  }

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	http://localhost:8080/uc/resources/bundle?bundlename=test-bundle http://localhost:8080/uc/resources/bundle?bundleid=12345
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
`bundleid`	ID used within the Controller to identify this Bundle.	String value of the bundle sysId.	Y (unless `bundlename` is specified)	`bundlename`
`bundlename`	Name used within the Controller to identify this Bundle.	String value of the bundle name.	Y (unless `bundleid` is specified)	`bundleid`

Read a Bundle: Example Response

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

XML Response

JSON Response

XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bundle exportReleaseLevel="7.2.0.0" exportTable="ops_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> </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"

Universal Controller 7.4.x

Bundles and Promotion Web Services

Overview

Bundles

Promotion

Bundles

Bundle Report

Bundle Report: URI Parameters

Bundle Report: Example Response

Create a Bundle

Create a Bundle: Example Request

Bundle Properties

Create a Bundle By Business Services

Create a Bundle By Business Services: Example Request

Create a Bundle By Business Services Properties

Create a Bundle By Date

Create a Bundle By Date: Example Request

Create a Bundle By Date Properties

Delete a Bundle

Delete a Bundle: URI Parameters

List Bundles

List Bundles Request Parameters

List Bundles: Example Response

Modify a Bundle

Modify a Bundle: Example Request

Read a Bundle

Read a Bundle: URI Parameters

Read a Bundle: Example Response