Page Comparison

Panel

Table of Contents

maxlevel	1

...

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

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	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 206378998 Bundle Properties.

Anchor

	Bundle Report URI Parameters
	Bundle Report URI Parameters

...

XML Response

JSON Response

Expand

title	XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bundle retainSysIds="true"> <name - bun> bundle-test</name - bun> <sysId - bun >0d7f03026a96451fbc3d7a8eecd641d5</ sysId - bun > <description - bun> bundle test</description - bun> <defaultPromotionTarget - bun> local</defaultPromotionTarget - bun> <followReferences - bun> true</followReferences - bun> <excludeOnExistence - bun> 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 - bun> <opswiseGroups - bun> <opswiseGroup>bus-1</opswiseGroup> <opswiseGroup>bus-2</opswiseGroup> </opswiseGroups - bun> <promoteBundleDefinition - bun> true</promoteBundleDefinition - bun> <promoteByBusinessServices - bun> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </promoteByBusinessServices - bun> <visibleTo - bun> ops.admin</visibleTo - bun> <bundleTasks - bun> <bundleTask> <name>win-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> <bundleTask> <name>abc</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> </bundleTasks - bun> <bundleApplications - bun> <bundleApplication> <name>App-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleApplication> </bundleApplications - bun> <bundleTriggers - bun> <bundleTrigger> <name>manual-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> <bundleTrigger> <name>time-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> </bundleTriggers - bun> <bundleCalendars - bun> <bundleCalendar> <name>cal-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCalendar> </bundleCalendars - bun> <bundleCustomDays - bun> <bundleCustomDay> <name>custome-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCustomDay> </bundleCustomDays - bun> <bundleVariables - bun> <bundleVariable> <name>var1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVariable> </bundleVariables - bun> < bundleBusinessServices - bun> <bundleBusinessService> <name>bus-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleBusinessService> </bundleBusinessServices - bun> < bundleCredentials -bun> <bundleCredential> <name>sap-cred</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCredential> </bundleCredentials -bun> < bundleAgentClusters - bun> <bundleAgentCluster> <name>Opswise - Default Windows Cluster</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleAgentCluster> </bundleAgentClusters - bun> < bundleVirtualResources - bun> <bundleVirtualResource> <name>VR-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVirtualResource> </bundleVirtualResources - bun> < bundleScripts - bun> <bundleScript> <name>script-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleScript> </bundleScripts - bun> < bundleEmailTemplates - bun> <bundleEmailTemplate> <name>email-temp-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailTemplate> </bundleEmailTemplates - bun> < bundleEmailConnections - bun> <bundleEmailConnection> <name>Email-con-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailConnection> </bundleEmailConnections - bun> < bundleDatabaseConnections - bun> <bundleDatabaseConnection> <name>DB-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleDatabaseConnection> </bundleDatabaseConnections - bun> < bundleSapConnections - bun> <bundleSapConnection> <name>SAP-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSapConnection> </bundleSapConnections - bun> < bundlePeoplesoftConnections - bun> <bundlePeoplesoftConnection> <name>People-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundlePeoplesoftConnection> </bundlePeoplesoftConnections - bun> < bundleSnmpManagers - bun> <bundleSnmpManager> <name>snmp-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSnmpManager> </bundleSnmpManagers - bun> < bundleUniversalTemplates - bun> <bundleUniversalTemplate> <name>univ-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleUniversalTemplate> </bundleUniversalTemplates - bun> </bundle>

Expand

title	JSON Response

  {
    "retainSysIds": true,
    "name - bun": "bundle-1",
    "sysId - bun": "b52335345df646e5b597dc26df599344",
    "description - bun": "bundle test 1",
    "opswiseGroups - bun": [
      "bus-1",
      "bus-2"
    ],
    "defaultPromotionTarget - bun": "local",
    "excludeOnExistence - bun": "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 - bun": true,
    "promoteBundleDefinition - bun": true,
    "promoteByBusinessServices - bun": [
      "bus-1",
      "bus-2"
    ],
    "visibleTo - bun": "ops.admin",
    "bundleAgentClusters - bun": [
      {
        "name": "Opswise - Default Linux/Unix Cluster",
        "sysId": "0d7f03026a96451fbc3d7a8eecd641d5"
      },
      {
        "name": "Opswise - Default Windows Cluster",
        "sysId": "d3f8282f702544d69500928afbcc00f0"
      }
    ],
    "bundleApplications - bun": [
      {
        "name": "app-1",
        "sysId": "e12830a711c849388819230203e601d3"
      }
    ],
    "bundleBusinessServices - bun": [
      {
        "name": "bus-1",
        "sysId": "b939eedb63544517accd905cfdd13b22"
      }
    ],
    "bundleCalendars - bun": [
      {
        "name": "cal-1",
        "sysId": "655b9c498e574ace886b114f79d5933a"
      }
    ],
    "bundleCredentials -bun": [
      {
        "name": "cred-1",
        "sysId": "d04886ac74be43a0aa3faa8042f82cca"
      }
    ],
    "bundleCustomDays - bun": [
      {
        "name": "cust-1",
        "sysId": "1b0e9acedb98439a8319ac3cd51c21ba"
      }
    ],
    "bundleDatabaseConnections - bun": [
      {
        "name": "db-con-1",
        "sysId": "fc8223ece09f407bb9b5bb865574cb49"
      }
    ],
    "bundleEmailConnections - bun": [
      {
        "name": "email-conn",
        "sysId": "bd54eae4221a4f909454f7fa04c75efb"
      }
    ],
    "bundleEmailTemplates - bun": [
      {
        "name": "email-temp-1",
        "sysId": "5dce586a419448ee83fa121589d60a75"
      }
    ],
    "bundlePeoplesoftConnections - bun": [
      {
        "name": "ps-con-1",
        "sysId": "aac40dfd5c3242ae9bcaaf169a5468b9"
      }
    ],
    "bundleSapConnections - bun": [
      {
        "name": "sap-1",
        "sysId": "a4b0544fb668404ba10b2826b2e6db81"
      }
    ],
    "bundleScripts - bun": [
      {
        "name": "script-1",
        "sysId": "01e90371bed4473d87dad00148512f35"
      }
    ],
    "bundleSnmpManagers - bun": [
      {
        "name": "snmp-1",
        "sysId": "4bfa01f747ca4ad5b4ee9e073d643604"
      }
    ],
    "bundleTasks - bun": [
      {
        "name": "win-1",
        "sysId": "3b50f8c015d6494288328cfdb35d9ea7"
      }
    ],
    "bundleTriggers - bun": [
      {
        "name": "cron-trig-1",
        "sysId": "d2869f93a68547beb8e5b156d4fac99e"
      }
    ],
    "bundleUniversalTemplates - bun": [
      {
        "name": "uni-1",
        "sysId": "0ff4abb1d80c4f95b517dc073c9abd0c"
      }
    ],
    "bundleVariables - bun": [
      {
        "name": "var1",
        "sysId": "9988d78bf82e44dbae66cf0e8ec4b820"
      }
    ],
    "bundleVirtualResources - bun": [
      {
        "name": "VR-1",
        "sysId": "deeaf3e516ce485fac5fc2283022d904"
      }
    ]
  }

...

	Description
URI	http://host_name/uc/resources/bundle
HTTP Method	POST
Description	Creates a Bundle Bundles and Promotion Overview.
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 206378998 Bundle Properties.
Example Response	Status 200 /OK Successfully created the Bundle with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

...

XML Request

JSON Request

Expand

title	XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bundle retainSysIds="true"> < name - bun> bundle-test</name - bun> < sysId - bun >0d7f03026a96451fbc3d7a8eecd641d5</ sysId - bun > < description - bun> bundle test</description - bun> < defaultPromotionTarget - bun> local</defaultPromotionTarget - bun> < followReferences - bun> true</followReferences - bun> < excludeOnExistence - bun> 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 - bun> < opswiseGroups - bun> <opswiseGroup>bus-1</opswiseGroup> <opswiseGroup>bus-2</opswiseGroup> </opswiseGroups - bun> < promoteBundleDefinition - bun> true</promoteBundleDefinition - bun> < promoteByBusinessServices - bun> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </promoteByBusinessServices - bun> < visibleTo - bun> ops.admin</visibleTo - bun> < bundleTasks - bun> <bundleTask> <name>win-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> <bundleTask> <name>abc</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> </bundleTasks - bun> < bundleApplications - bun> <bundleApplication> <name>App-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleApplication> </bundleApplications - bun> < bundleTriggers - bun> <bundleTrigger> <name>manual-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> <bundleTrigger> <name>time-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> </bundleTriggers - bun> < bundleCalendars - bun> <bundleCalendar> <name>cal-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCalendar> </bundleCalendars - bun> < bundleCustomDays - bun> <bundleCustomDay> <name>custome-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCustomDay> </bundleCustomDays - bun> < bundleVariables - bun> <bundleVariable> <name>var1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVariable> </bundleVariables - bun> < bundleBusinessServices - bun> <bundleBusinessService> <name>bus-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleBusinessService> </bundleBusinessServices - bun> < bundleCredentials -bun> <bundleCredential> <name>sap-cred</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCredential> </bundleCredentials -bun> < bundleAgentClusters - bun> <bundleAgentCluster> <name>Opswise - Default Windows Cluster</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleAgentCluster> </bundleAgentClusters - bun> < bundleVirtualResources - bun> <bundleVirtualResource> <name>VR-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVirtualResource> </bundleVirtualResources - bun> < bundleScripts - bun> <bundleScript> <name>script-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleScript> </bundleScripts - bun> < bundleEmailTemplates - bun> <bundleEmailTemplate> <name>email-temp-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailTemplate> </bundleEmailTemplates - bun> < bundleEmailConnections - bun> <bundleEmailConnection> <name>Email-con-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailConnection> </bundleEmailConnections - bun> < bundleDatabaseConnections - bun> <bundleDatabaseConnection> <name>DB-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleDatabaseConnection> </bundleDatabaseConnections - bun> < bundleSapConnections - bun> <bundleSapConnection> <name>SAP-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSapConnection> </bundleSapConnections - bun> < bundlePeoplesoftConnections - bun> <bundlePeoplesoftConnection> <name>People-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundlePeoplesoftConnection> </bundlePeoplesoftConnections - bun> < bundleSnmpManagers - bun> <bundleSnmpManager> <name>snmp-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSnmpManager> </bundleSnmpManagers - bun> < bundleUniversalTemplates - bun> <bundleUniversalTemplate> <name>univ-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleUniversalTemplate> </bundleUniversalTemplates - bun> </bundle>

Expand

title	JSON Request

  {
    "retainSysIds": true,
    "name - bun": "bundle-1",
    "sysId - bun": "b52335345df646e5b597dc26df599344",
    "description - bun": "bundle test 1",
    "opswiseGroups - bun": [
      "bus-1",
      "bus-2"
    ],
    "defaultPromotionTarget - bun": "local",
    "excludeOnExistence - bun": "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 - bun": true,
    "promoteBundleDefinition - bun": true,
    "promoteByBusinessServices - bun": [
      "bus-1",
      "bus-2"
    ],
    "visibleTo - bun": "ops.admin",
    "bundleAgentClusters - bun": [
      {
        "name": "Opswise - Default Linux/Unix Cluster",
        "sysId": "0d7f03026a96451fbc3d7a8eecd641d5"
      },
      {
        "name": "Opswise - Default Windows Cluster",
        "sysId": "d3f8282f702544d69500928afbcc00f0"
      }
    ],
    "bundleApplications - bun": [
      {
        "name": "app-1",
        "sysId": "e12830a711c849388819230203e601d3"
      }
    ],
    "bundleBusinessServices - bun": [
      {
        "name": "bus-1",
        "sysId": "b939eedb63544517accd905cfdd13b22"
      }
    ],
    "bundleCalendars - bun": [
      {
        "name": "cal-1",
        "sysId": "655b9c498e574ace886b114f79d5933a"
      }
    ],
    "bundleCredentials -bun": [
      {
        "name": "cred-1",
        "sysId": "d04886ac74be43a0aa3faa8042f82cca"
      }
    ],
    "bundleCustomDays - bun": [
      {
        "name": "cust-1",
        "sysId": "1b0e9acedb98439a8319ac3cd51c21ba"
      }
    ],
    "bundleDatabaseConnections - bun": [
      {
        "name": "db-con-1",
        "sysId": "fc8223ece09f407bb9b5bb865574cb49"
      }
    ],
    "bundleEmailConnections - bun": [
      {
        "name": "email-conn",
        "sysId": "bd54eae4221a4f909454f7fa04c75efb"
      }
    ],
    "bundleEmailTemplates - bun": [
      {
        "name": "email-temp-1",
        "sysId": "5dce586a419448ee83fa121589d60a75"
      }
    ],
    "bundlePeoplesoftConnections - bun": [
      {
        "name": "ps-con-1",
        "sysId": "aac40dfd5c3242ae9bcaaf169a5468b9"
      }
    ],
    "bundleSapConnections - bun": [
      {
        "name": "sap-1",
        "sysId": "a4b0544fb668404ba10b2826b2e6db81"
      }
    ],
    "bundleScripts - bun": [
      {
        "name": "script-1",
        "sysId": "01e90371bed4473d87dad00148512f35"
      }
    ],
    "bundleSnmpManagers - bun": [
      {
        "name": "snmp-1",
        "sysId": "4bfa01f747ca4ad5b4ee9e073d643604"
      }
    ],
    "bundleTasks - bun": [
      {
        "name": "win-1",
        "sysId": "3b50f8c015d6494288328cfdb35d9ea7"
      }
    ],
    "bundleTriggers - bun": [
      {
        "name": "cron-trig-1",
        "sysId": "d2869f93a68547beb8e5b156d4fac99e"
      }
    ],
    "bundleUniversalTemplates - bun": [
      {
        "name": "uni-1",
        "sysId": "0ff4abb1d80c4f95b517dc073c9abd0c"
      }
    ],
    "bundleVariables - bun": [
      {
        "name": "var1",
        "sysId": "9988d78bf82e44dbae66cf0e8ec4b820"
      }
    ],
    "bundleVirtualResources - bun": [
      {
        "name": "VR-1",
        "sysId": "deeaf3e516ce485fac5fc2283022d904"
      }
    ]
  }

...

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

...

XML Request

JSON Request

Expand

title	XML Request

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

Expand

title	JSON Request

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

...

	Description
URI	http://host_name/uc/resources/bundle/bydate
HTTP Method	POST
Description	Creates a Bundle Bundles and Promotion Overview.
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 206378998 Create a Bundle By Date Properties.
Example Response	Status 200 Successfully created bundle "bundle-by-service2" with 1 item(s).

...

XML Request

JSON Request

Expand

title	XML Request

<bundle> <name - bunD>bundle-by-service2</name - bunD> < businessServices> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </businessServices - bunD> < typesToInclude - bunD> Triggers, Tasks, Calendars, Variables, Credentials</typesToInclude - bunD> < updatedOnOrAfter- bunD> 2020-07-01 00:00:00 -0400</updatedOnOrAfter- bunD></bundle>

Expand

title	JSON Request

{ " name - bunD ": "bundle-service4", " typesToInclude - bunD ": "Triggers, Tasks, Calendars, Variables, Credentials", " businessServices ": [ "bus-1", "bus-2" ], " updatedOnOrAfter- bunD ": "2020-07-01 00:00:00 -0400"}

...

	Description
URI	http://host_name/uc/resources/bundle
HTTP Method	DELETE
Description	Deletes a Bundle Bundles and Promotion Overview.
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.

...

	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 206378998 Bundle Properties.

Anchor

	List Bundles Request Parameters
	List Bundles Request Parameters

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	bundlename - bunlist
	bundlename - bunlist

bundlename

n/a

Request parameter bundlename.

String value of the bundle name. Remote Interfaces Wildcards are supported.

N

Anchor

	businessServices - bunlist
	businessServices - bunlist

businessServices

n/a

Request parameter businessServices.

String value of the bundle business service.

N

Anchor

	defaultPromotionTarget - bunlist
	defaultPromotionTarget - bunlist

defaultPromotionTarget

n/a

Request parameter defaultPromotionTarget.

String value of the promotion target. Remote Interfaces Wildcards are supported.

N

...

XML Response

JSON Response

Expand

title	XML Response

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

Expand

title	JSON Response

  {
    "retainSysIds": true,
    "name - bun": "bundle-1",
    "sysId - bun": "b52335345df646e5b597dc26df599344",
    "description - bun": "bundle test 1",
    "opswiseGroups - bun": [
      "bus-1",
      "bus-2"
    ],
    "defaultPromotionTarget - bun": "local",
    "excludeOnExistence - bun": "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 - bun": true,
    "promoteBundleDefinition - bun": true,
    "promoteByBusinessServices - bun": [
      "bus-1",
      "bus-2"
    ],
    "visibleTo - bun": "ops.admin",
    "bundleAgentClusters - bun": [
      {

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

      }
    ],
    "bundleApplications - bun": [
      {

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

      }
    ],
    "bundleBusinessServices - bun": [
      {

        "addedBy": "ops.admin",

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

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

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

"addedBy": "ops.admin",

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

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

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

"type": "Single Date"

      }
    ],
    "bundleDatabaseConnections - bun": [
      {

"addedBy": "ops.admin",

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

"addedBy": "ops.admin",

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

        "type": "Outgoing"

      }
    ],
    "bundleEmailTemplates - bun": [
      {

"addedBy": "ops.admin",

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

"addedBy": "ops.admin",

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

"addedBy": "ops.admin",

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

"addedBy": "ops.admin",

        "description": "script 1",

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

        "type": "Script"

      }
    ],
    "bundleSnmpManagers - bun": [
      {

"addedBy": "ops.admin",

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

"addedBy": "ops.admin",

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

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

"addedBy": "ops.admin",

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

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

"addedBy": "ops.admin",

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

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

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

"addedBy": "ops.admin",

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

        "type": "Renewable"
      }

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

Anchor

	Modify a 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 206378998 Bundle Properties.
Example Response	Status 200 /OK Successfully updated the Bundle with sysId <sysId> to version <version>.

...

XML Request

JSON Request

Expand

title	XML Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bundle retainSysIds=true> < name - bun> bundle-test</name - bun> < sysId - bun >0d7f03026a96451fbc3d7a8eecd641d5</ sysId - bun > < description - bun> bundle test</description - bun> < defaultPromotionTarget - bun> local</defaultPromotionTarget - bun> < followReferences - bun> true</followReferences - bun> < excludeOnExistence - bun> 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 - bun> < opswiseGroups - bun> <opswiseGroup>bus-1</opswiseGroup> <opswiseGroup>bus-2</opswiseGroup> </opswiseGroups - bun> < promoteBundleDefinition - bun> true</promoteBundleDefinition - bun> < promoteByBusinessServices - bun> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </promoteByBusinessServices - bun> < visibleTo - bun> ops.admin</visibleTo - bun> < bundleTasks - bun> <bundleTask> <name>win-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> <bundleTask> <name>abc</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> </bundleTasks - bun> < bundleApplications - bun> <bundleApplication> <name>App-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleApplication> </bundleApplications - bun> < bundleTriggers - bun> <bundleTrigger> <name>manual-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> <bundleTrigger> <name>time-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> </bundleTriggers - bun> < bundleCalendars - bun> <bundleCalendar> <name>cal-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCalendar> </bundleCalendars - bun> < bundleCustomDays - bun> <bundleCustomDay> <name>custome-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCustomDay> </bundleCustomDays - bun> < bundleVariables - bun> <bundleVariable> <name>var1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVariable> </bundleVariables - bun> < bundleBusinessServices - bun> <bundleBusinessService> <name>bus-1</name> <sysID>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleBusinessService> </bundleBusinessServices - bun> < bundleCredentials -bun> <bundleCredential> <name>sap-cred</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCredential> </bundleCredentials -bun> < bundleAgentClusters - bun> <bundleAgentCluster> <name>Opswise - Default Windows Cluster</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleAgentCluster> </bundleAgentClusters - bun> < bundleVirtualResources - bun> <bundleVirtualResource> <name>VR-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVirtualResource> </bundleVirtualResources - bun> < bundleScripts - bun> <bundleScript> <name>script-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleScript> </bundleScripts - bun> < bundleEmailTemplates - bun> <bundleEmailTemplate> <name>email-temp-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailTemplate> </bundleEmailTemplates - bun> < bundleEmailConnections - bun> <bundleEmailConnection> <name>Email-con-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailConnection> </bundleEmailConnections - bun> < bundleDatabaseConnections - bun> <bundleDatabaseConnection> <name>DB-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleDatabaseConnection> </bundleDatabaseConnections - bun> < bundleSapConnections - bun> <bundleSapConnection> <name>SAP-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSapConnection> </bundleSapConnections - bun> < bundlePeoplesoftConnections - bun> <bundlePeoplesoftConnection> <name>People-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundlePeoplesoftConnection> </bundlePeoplesoftConnections - bun> < bundleSnmpManagers - bun> <bundleSnmpManager> <name>snmp-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSnmpManager> </bundleSnmpManagers - bun> < bundleUniversalTemplates - bun> <bundleUniversalTemplate> <name>univ-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleUniversalTemplate> </bundleUniversalTemplates - bun> </bundle>

Expand

title	JSON Request

  {
    "retainSysIds": true,
    "name - bun": "bundle-1",
    "sysId - bun": "b52335345df646e5b597dc26df599344",
    "description - bun": "bundle test 1",
    "opswiseGroups - bun": [
      "bus-1",
      "bus-2"
    ],
    "defaultPromotionTarget - bun": "local",
    "excludeOnExistence - bun": "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 - bun": true,
    "promoteBundleDefinition - bun": true,
    "promoteByBusinessServices - bun": [
      "bus-1",
      "bus-2"
    ],
    "visibleTo - bun": "ops.admin",
    "bundleAgentClusters - bun": [
      {
        "name": "Opswise - Default Linux/Unix Cluster",
        "sysId": "0d7f03026a96451fbc3d7a8eecd641d5",
      },
      {
        "name": "Opswise - Default Windows Cluster",
        "sysId": "d3f8282f702544d69500928afbcc00f0",
      }
    ],
    "bundleApplications - bun": [
      {
        "name": "app-1",
        "sysId": "e12830a711c849388819230203e601d3",
      }
    ],
    "bundleBusinessServices - bun": [
      {
        "name": "bus-1",
        "sysId": "b939eedb63544517accd905cfdd13b22"
      }
    ],
    "bundleCalendars - bun": [
      {
        "name": "cal-1",
        "sysId": "655b9c498e574ace886b114f79d5933a"
      }
    ],
    "bundleCredentials -bun": [
      {
        "name": "cred-1",
        "sysId": "d04886ac74be43a0aa3faa8042f82cca"
      }
    ],
    "bundleCustomDays - bun": [
      {
        "name": "cust-1",
        "sysId": "1b0e9acedb98439a8319ac3cd51c21ba",
      }
    ],
    "bundleDatabaseConnections - bun": [
      {
        "name": "db-con-1",
        "sysId": "fc8223ece09f407bb9b5bb865574cb49"
      }
    ],
    "bundleEmailConnections - bun": [
      {
        "name": "email-conn",
        "sysId": "bd54eae4221a4f909454f7fa04c75efb",
      }
    ],
    "bundleEmailTemplates - bun": [
      {
        "name": "email-temp-1",
        "sysId": "5dce586a419448ee83fa121589d60a75"
      }
    ],
    "bundlePeoplesoftConnections - bun": [
      {
        "name": "ps-con-1",
        "sysId": "aac40dfd5c3242ae9bcaaf169a5468b9"
      }
    ],
    "bundleSapConnections - bun": [
      {
        "name": "sap-1",
        "sysId": "a4b0544fb668404ba10b2826b2e6db81"
      }
    ],
    "bundleScripts - bun": [
      {
        "name": "script-1",
        "sysId": "01e90371bed4473d87dad00148512f35",
      }
    ],
    "bundleSnmpManagers - bun": [
      {
        "name": "snmp-1",
        "sysId": "4bfa01f747ca4ad5b4ee9e073d643604"
      }
    ],
    "bundleTasks - bun": [
      {
        "name": "win-1",
        "sysId": "3b50f8c015d6494288328cfdb35d9ea7",
      }
    ],
    "bundleTriggers - bun": [
      {
        "name": "cron-trig-1",
        "sysId": "d2869f93a68547beb8e5b156d4fac99e",
      }
    ],
    "bundleUniversalTemplates - bun": [
      {
        "name": "uni-1",
        "sysId": "0ff4abb1d80c4f95b517dc073c9abd0c"
      }
    ],
    "bundleVariables - bun": [
      {
        "name": "var1",
        "sysId": "9988d78bf82e44dbae66cf0e8ec4b820"
      }
    ],
    "bundleVirtualResources - bun": [
      {
        "name": "VR-1",
        "sysId": "deeaf3e516ce485fac5fc2283022d904",
      }
    ]
  }

...

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 206378998 Bundle Properties.

Anchor

	Read a Bundle URI Parameters
	Read a Bundle URI Parameters

...

Read a Bundle: Example Response

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

XML Response

JSON Response

Expand

title	XML Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bundle exportReleaseLevel - bun="7.2.0.0" exportTable - bun="ops_bundle" retainSysIds=true> < name - bun> bundle-test</name - bun> < sysId - bun >0d7f03026a96451fbc3d7a8eecd641d5</ sysId - bun > < description - bun> bundle test</description - bun < defaultPromotionTarget - bun> local</defaultPromotionTarget - bun> < followReferences - bun> true</followReferences - bun> < excludeOnExistence - bun> 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 - bun> < opswiseGroups - bun> <opswiseGroup>bus-1</opswiseGroup> <opswiseGroup>bus-2</opswiseGroup> </opswiseGroups - bun> < promoteBundleDefinition - bun> true</promoteBundleDefinition - bun> < promoteByBusinessServices - bun> <businessService>bus-1</businessService> <businessService>bus-2</businessService> </promoteByBusinessServices - bun> < visibleTo - bun> ops.admin</visibleTo - bun> < bundleTasks - bun> <bundleTask> <name>win-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTask> </bundleTasks - bun> < bundleApplications - bun> <bundleApplication> <name>App-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleApplication> </bundleApplications - bun> < bundleTriggers - bun> <bundleTrigger> <name>manual-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> <bundleTrigger> <name>time-trigger-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleTrigger> </bundleTriggers - bun> < bundleCalendars - bun> <bundleCalendar> <name>cal-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCalendar> </bundleCalendars - bun> < bundleCustomDays - bun> <bundleCustomDay> <name>custome-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCustomDay> </bundleCustomDays - bun> < bundleVariables - bun> <bundleVariable> <name>var1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVariable> </bundleVariables - bun> < bundleBusinessServices - bun> <bundleBusinessService> <name>bus-1</name> <sysID>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleBusinessService> </bundleBusinessServices - bun> < bundleCredentials -bun> <bundleCredential> <name>sap-cred</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleCredential> </bundleCredentials -bun> < bundleAgentClusters - bun> <bundleAgentCluster> <name>Opswise - Default Windows Cluster</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleAgentCluster> </bundleAgentClusters - bun> < bundleVirtualResources - bun> <bundleVirtualResource> <name>VR-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleVirtualResource> </bundleVirtualResources - bun> < bundleScripts - bun> <bundleScript> <name>script-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleScript> </bundleScripts - bun> < bundleEmailTemplates - bun> <bundleEmailTemplate> <name>email-temp-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailTemplate> </bundleEmailTemplates - bun> < bundleEmailConnections - bun> <bundleEmailConnection> <name>Email-con-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleEmailConnection> </bundleEmailConnections - bun> < bundleDatabaseConnections - bun> <bundleDatabaseConnection> <name>DB-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleDatabaseConnection> </bundleDatabaseConnections - bun> < bundleSapConnections - bun> <bundleSapConnection> <name>SAP-conn-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSapConnection> </bundleSapConnections - bun> < bundlePeoplesoftConnections - bun> <bundlePeoplesoftConnection> <name>People-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundlePeoplesoftConnection> </bundlePeoplesoftConnections - bun> < bundleSnmpManagers - bun> <bundleSnmpManager> <name>snmp-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleSnmpManager> </bundleSnmpManagers - bun> < bundleUniversalTemplates - bun> <bundleUniversalTemplate> <name>univ-test-1</name> <sysId>0d7f03026a96451fbc3d7a8eecd641d5</sysId> </bundleUniversalTemplate> </bundleUniversalTemplates - bun> </bundle>

Expand

title	JSON Response

  {
    "retainSysIds": true,
    "name - bun": "bundle-1",
    "sysId - bun": "b52335345df646e5b597dc26df599344",
    "description - bun": "bundle test 1",
    "opswiseGroups - bun": [
      "bus-1",
      "bus-2"
    ],
    "defaultPromotionTarget - bun": "local",
    "excludeOnExistence - bun": "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 - bun": true,
    "promoteBundleDefinition - bun": true,
    "promoteByBusinessServices - bun": [
      "bus-1",
      "bus-2"
    ],
    "visibleTo - bun": "ops.admin",
    "bundleAgentClusters - bun": [
      {
        "name": "Opswise - Default Linux/Unix Cluster",
        "sysId": "0d7f03026a96451fbc3d7a8eecd641d5",
      },
      {
        "name": "Opswise - Default Windows Cluster",
        "sysId": "d3f8282f702544d69500928afbcc00f0",
      }
    ],
    "bundleApplications - bun": [
      {
        "name": "app-1",
        "sysId": "e12830a711c849388819230203e601d3",
      }
    ],
    "bundleBusinessServices - bun": [
      {
        "name": "bus-1",
        "sysId": "b939eedb63544517accd905cfdd13b22"
      }
    ],
    "bundleCalendars - bun": [
      {
        "name": "cal-1",
        "sysId": "655b9c498e574ace886b114f79d5933a"
      }
    ],
    "bundleCredentials -bun": [
      {
        "name": "cred-1",
        "sysId": "d04886ac74be43a0aa3faa8042f82cca"
      }
    ],
    "bundleCustomDays - bun": [
      {
        "name": "cust-1",
        "sysId": "1b0e9acedb98439a8319ac3cd51c21ba",
      }
    ],
    "bundleDatabaseConnections - bun": [
      {
        "name": "db-con-1",
        "sysId": "fc8223ece09f407bb9b5bb865574cb49"
      }
    ],
    "bundleEmailConnections - bun": [
      {
        "name": "email-conn",
        "sysId": "bd54eae4221a4f909454f7fa04c75efb",
      }
    ],
    "bundleEmailTemplates - bun": [
      {
        "name": "email-temp-1",
        "sysId": "5dce586a419448ee83fa121589d60a75"
      }
    ],
    "bundlePeoplesoftConnections - bun": [
      {
        "name": "ps-con-1",
        "sysId": "aac40dfd5c3242ae9bcaaf169a5468b9"
      }
    ],
    "bundleSapConnections - bun": [
      {
        "name": "sap-1",
        "sysId": "a4b0544fb668404ba10b2826b2e6db81"
      }
    ],
    "bundleScripts - bun": [
      {
        "name": "script-1",
        "sysId": "01e90371bed4473d87dad00148512f35",
      }
    ],
    "bundleSnmpManagers - bun": [
      {
        "name": "snmp-1",
        "sysId": "4bfa01f747ca4ad5b4ee9e073d643604"
      }
    ],
    "bundleTasks - bun": [
      {
        "name": "win-1",
        "sysId": "3b50f8c015d6494288328cfdb35d9ea7",
      }
    ],
    "bundleTriggers - bun": [
      {
        "name": "cron-trig-1",
        "sysId": "d2869f93a68547beb8e5b156d4fac99e",
      }
    ],
    "bundleUniversalTemplates - bun": [
      {
        "name": "uni-1",
        "sysId": "0ff4abb1d80c4f95b517dc073c9abd0c"
      }
    ],
    "bundleVariables - bun": [
      {
        "name": "var1",
        "sysId": "9988d78bf82e44dbae66cf0e8ec4b820"
      }
    ],
    "bundleVirtualResources - bun": [
      {
        "name": "VR-1",
        "sysId": "deeaf3e516ce485fac5fc2283022d904",
      }
    ],
    "exportReleaseLevel - bun": "7.2.0.0",
    "exportTable - bun": "ops_bundle"
  }

Anchor

	Promotion
	Promotion

...

	Description
URI	http://host_name/uc/resources/promote
HTTP Method	POST
Description	Promotes, without a bundle, one or more items of a specific type.
Example URI	http://localhost:8080/uc/resources/promote
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Promote : XML and JSON Examples.
Request Properties	See Promote : Properties.
Example Response	See Promote : XML and JSON Examples.

Bundleless Promotion: XML and JSON Examples

Examples

XML

JSON

Example Request

Expand

title	XML

<promote>
    <itemType - promo>Calendar</itemType - promo>
    <itemNames - promo>CAL_US,CAL_CAN</itemNames - promo>
    <promotionTargetName - promo>PT1</promotionTargetName - promo>
    <excludeOnExistence - promo>Custom Days</excludeOnExistence - promo>
    <followReferences - promo>false</followReferences - promo>
    <allowUnvTmpltChanges - promo>false</allowUnvTmpltChanges - promo>

</promote>

Expand

title	JSON

{
  " itemType - promo " : "Universal Template",
  " itemIds - promo " : "4e656d398d5f4ebd8d7df3210147c488",
  " promotionTargetId - promo " : "6330f82afab54273b9167a2b434a2424",
  " overrideUser - promo " : "testUser",
  " overridePassword - promo " : "testPassword1",
  " followReferences - promo " : true,
  " allowUnvTmpltChanges - promo " : true
}

Example Response

Expand

title	XML

<command-response>
    <type>promote</type>
    <success>true</success>
    <info>Successfully promoted 2 calendars and 1 referenced item to promotion target "PT1".</info>
    <errors></errors>
</command-response>

Expand

title	JSON

{
  "type": "promote",
  "success": true,
  "info": "Successfully promoted 1 universal template to promotion target \"PT1\".",
  "errors": ""
}

...

promotionTargetId

Y

(unless itemIds
or itemNames is specified)

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	itemType - promo
	itemType - promo

itemType

n/a

Item type for promotion item(s).

Valid Values:

One of the following (not case sensitive):

Trigger
Task
Calendar
Custom Day
Variable
Business Service
Credential
Agent Cluster
Virtual Resource
Script
Email Template
Email Connection
Database Connection
SAP Connection
PeopleSoft Connection
SNMP Manager
Application
Universal Template
Report
Widget
Dashboard

Y

Anchor

	itemIds - promo
	itemIds - promo

itemIds

n/a

IDs for promotion items.

Comma-separated list of promotion item IDs.

Y
(unless itemNames or items is specified)

itemNames

items

Anchor

	itemNames - promo
	itemNames - promo

itemNames

n/a

Names for promotion items.

Comma-separated list of promotion item names.

Y
(unless itemIds or items is specified)

itemIds

items

n/a

List of promotion items.

XML:

<items> <item> <name>reportTitle1</name> </item> <item> <name>reportTitle2</name> <user>userName</user> </item> <item> <name>reportTitle3</name> <group>groupName</group> </item> </items>

Code Block

language	text

JSON:

Code Block

language	text

  "items": [
        {
            "name": "reportTitle1"
        },  
        {
            "name": "reportTitle1",
            "user": "username",
            "group": ""
        },
        {
            "name": "reportTitle2",
            "user": null,
            "group": "group2"
        }
    ]

Y

(unless itemIds
or itemNames is specified)

itemIds

itemNames

Anchor

itemIds

itemNames

Anchor

	promotionTargetId - promo
	promotionTargetId - promo

promotionTargetId

n/a

ID of the Promotion Target.

Y
(unless promotionTargetName
is specified)

promotionTargetName

Anchor

	promotionTargetName - promo
	promotionTargetName - promo

promotionTargetName

Promotion Target

Name of the Promotion Target.

Y
(unless promotionTargetId
is specified)

promotionTargetId

Anchor

	overrideUser - promo
	overrideUser - promo

overrideUser

User

User name to use instead of the default User name for the Promotion Target.

Y
(if overridePassword
is specified)

Anchor

	overridePassword - promo
	overridePassword - promo

overridePassword

Password

User password to use instead of the default User password for the Promotion Target.

Y
(if overrideUser
is specified)

overrideToken

Personal Access Token

Personal Access Token to use instead of the default personal access token for the Promotion Target.

If both overrideToken and overrideUser+overridePassword are specified, overrideToken takes precedence and overrideUser+overidePassword will be ignored.

N

Anchor

	excluseOnExistence - promo
	excluseOnExistence - promo

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:

As String = Triggers, As Value = 1
As String = Tasks, As Value = 2
As String = Calendars, As Value = 4
As String = Custom Days, As Value = 8
As String = Variables As Value = 16
As String = Credentials, As Value = 64
As String = Agent Clusters, As Value = 128
As String = Virtual Resources, As Value = 256
As String = Scripts, As Value = 512
As String = Email Templates, As Value = 1024
As String = Email Connections As Value = 2048
As String = Database Connections, As Value = 4096
As String = SAP Connections, As Value = 8192
As String = SNMP Managers, As Value = 16384
As String = Applications, As Value = 32768
As String = PeopleSoft Connections, As Value = 65536
As String = Reports, As Value = 262144
As String = Widgets, As Value = 524288

N

Anchor

	followReferences - promo
	followReferences - promo

followReferences

Follow References

Dynamically include items in the promotion that are referenced by promotion items.

Valid values:

Yes,Y,true
No,N,false (default)

N

Anchor

	allUnvTmpltChanges - promo
	allUnvTmpltChanges - promo

allUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:

Yes,Y,true
No,N,false (default)

Note

title	Note

In order to promote Universal Template changes, the user must have the opsRoles and Permissions#ops_universal_template_admin role or the opsRoles and Permissions#ops_adminrole.

N

Anchor

	Items Properties
	Items Properties

...

	Description
URI	http://host_name/uc/resources/promotion/schedule/cancel
HTTP Method	POST
Description	Cancels the scheduled promotion of a Bundle.
URI Parameters	See Cancel a Scheduled Bundle Promotion : URI Parameters, below.
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example URI	http://localhost:8080/uc/resources/promotion/schedule/cancel?bundlename=BundleA&date=2018-12-10&time=10:00 http://localhost:8080/uc/resources/promotion/schedule/cancel?bundleid=8fc4fd900804418b84af7b33eb55eb09&date=2019-11-15&time=12:00 http://localhost:8080/uc/resources/promotion/schedule/cancel?scheduleid=1899e60df0db4152a4eefa46cf29e7d3
Example Response	See Cancel a Scheduled Bundle Promotion : XML and JSON Examples.

Anchor

	Cancel a Scheduled Bundle Promotion URI Parameters
	Cancel a Scheduled Bundle Promotion URI Parameters

...

Parameter	Description	Specifications	Required	Mutually Exclusive With
`scheduleid`	UUID of the promotion schedule.		N	`bundlename` and `bundleid`
`bundlename`	Name of the bundle.		N	`scheduleid` and `bundleid`
`bundleid`	UUID of the bundle.		N	`scheduleid` and `bundlename`
`date`	Date when the promotion was scheduled. Corresponds to the year, month, and day of the Scheduled Promotion Schedules#Scheduled Time field in a promotion schedule.	Format: yyyy-MM-dd (For example: 2018-11-14).	Y (If `bundlename` or `bundleid` is specified)
`time`	Time when the promotion was scheduled. Corresponds to the hour and minutes of the Scheduled Promotion Schedules#Scheduled Time field in a promotion schedule.	Format: HH:mm (For example: 22:00).	Y (If `bundlename` or `bundleid` is specified)

...

	Description
URI	http://host_name/uc/resources/promotion/schedule
HTTP Method	DELETE
Description	Deleted the scheduled promotion of a Bundle.
URI Parameters	See Delete a Scheduled Bundle Promotion : URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/promotion/schedule?bundlename=BundleA&date=2018-12-15&time=14:30 http://localhost:8080/uc/resources/promotion/schedule?bundleid=8fc4fd900804418b84af7b33eb55eb09&date=2018-12-15&time=17:00 http://localhost:8080/uc/resources/promotion/schedule?scheduleid=dd1de1b27848435cb852fb8807af6a30
Example Response	Status 200 Promotion schedule deleted successfully. Status 400 One of parameters scheduleid, bundleid, or bundlename required. Status 400 Both date, and time parameters required when bundleid, or bundlename specified. Status 400 Unable to parse at least one of the date (yyyy-MM-dd) and time (HH:mm) parameters. Status 403 Operation prohibited due to security constraints. Status 403 Promotion Schedule cannot be deleted while Running. Status 404 Unable to find bundle by the bundlename specified. Status 404 More than one qualifying promotion schedule found. Status 404 Unable to find qualifying promotion schedule.

...

Parameter	Description	Specifications	Required	Mutually Exclusive With
`scheduleid`	UUID of the promotion schedule.		N	`bundlename` and `bundleid`
`bundlename`	Name of the bundle.		N	`scheduleid` and `bundleid`
`bundleid`	UUID of the bundle.		N	`scheduleid` and `bundlename`
`date`	Date when the promotion was scheduled. Corresponds to the year, month, and day of the Scheduled Promotion Schedules#Scheduled Time field in a promotion schedule.	Format: yyyy-MM-dd (For example: 2018-11-14).	Y (If `bundlename` or `bundleid` is specified)
`time`	Time when the promotion was scheduled. Corresponds to the hour and minutes of the Scheduled Promotion Schedules#Scheduled Time field in a promotion schedule.	Format: HH:mm (For example: 22:00).	Y (If `bundlename` or `bundleid` is specified)

...

	Description
URI	http://host_name/uc/resources/bundle/promote
HTTP Method	POST
Description	Promote a Bundle or schedule the promotion of a Bundle.
Example URI	http://localhost:8080/uc/resources/bundle/promote
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Schedule Bundle Promotion : XML and JSON Examples.
Request Properties	See Schedule Bundle Promotion : Properties.
Example Response	See Schedule Bundle Promotion : XML and JSON Examples.

Anchor

	Promote a Bundle or Schedule a Bundle Promotion XML and JSON Examples
	Promote a Bundle or Schedule a Bundle Promotion XML and JSON Examples

...

Examples

XML

JSON

Example Request

Expand

title	XML

<bundle-promote>
   <id- SBC>a17c53a4975d4df59ddf4e6f1fb0b111</id- SBC>
   <promotionTargetName - SBC>testTarget</promotionTargetName - SBC>
   <overrideUser - SBC>testUser</overrideUser - SBC>
   <overridePassword - SBC>testPassword</overridePassword - SBC>
   <allowUnvTmpltChanges - SBC>true</allowUnvTmpltChanges - SBC>
   <schedule - SBC>true</schedule - SBC>
   <createSnapshot - SBC>true</createSnapshot - SBC>
   <date - SBC>2015-10-31</date - SBC>
   <time - SBC>22:00</time - SBC>
   <notificationOption - SBC>operation success</notificationOption - SBC>
</bundle-promote>

Expand

title	JSON

{
   "id": "1bd5a9ae80714523a858633df3c515bf",
   "promotionTargetName": "testTarget",
   "overrideUser - SBC": "testUser",   
   "overridePassword - SBC": "testPassword1",
   "allowUnvTmpltChanges - SBC": true,
   "schedule - SBC": true,
   "createSnapshot - SBC": true,
   "date - SBC": "2018-01-04",
   "time - SBC": "23:00",
   "notificationOption - SBC": "operation success"
}

Example Response

Expand

title	XML

<command-response>
   <type>schedule_promotion</type>
   <success>true</success>
   <info>Successfully scheduled the promotion of bundle "test" to promotion target "testTarget" for 2015-10-31 22:00:00 -0600.</info>
   <errors />
</command-response>

Expand

title	JSON

{
"type": "schedule_promotion",
"success": true,
"info": "Successfully scheduled the promotion of bundle "abc" to promotion target "testTarget" for 2018-01-04 23:00:00 -0600.",
"errors": ""
}

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	allowUnvTmpltChanges - SBC
	allowUnvTmpltChanges - SBC

allowUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:

Yes,Y,true
No,N,false

Note

title	Note

In order to promote Universal Template changes, the user must have the ops_universal_template_admin Roles and Permissions role or the ops_admin Roles and Permissions role.

N

Anchor

	createSnapshot - SBC
	createSnapshot - SBC

createSnapshot

Create Snapshot

Schedule the Bundle promotion using the current Bundle records.

Valid values:

Yes,Y,true
No,N,false

N

Anchor

	date - SBC
	date - SBC

date

Date

Date on which to promote the Bundle.

Y
(if schedule
is Yes,Y,true);
format is
yyyy-MM-dd.

Anchor

	id - SBC
	id - SBC

id

n/a

32-character sysid of the Bundle to be promoted.

Y
(unless name
is specified)

name

Anchor

	name - SBC
	name - SBC

name

Bundle Name

Name of the Bundle to be promoted.

Y
(unless id
is specified)

id

Anchor

	notificationOption - SBC
	notificationOption - SBC

notificationOption

System Notification

Installing Universal Controller#Configure System NotificationNotifications to send on success and/or failure of the promotion.

Valid values (not case sensitive):

operation Failure (default)
operation success/failure
operation success

N

Anchor

	overridePassword - SBC
	overridePassword - SBC

overridePassword

Password

User password to use instead of the default User password for the promotion target.

Y
(if overrideUser
is specified)

overrideToken

Personal Access Token

Personal Access Token to use instead of the default personal access token for the Promotion Target.

If both overrideToken and overrideUser+overridePassword are specified, overrideToken takes precedence and overrideUser+overidePassword will be ignored.

N

Anchor

	overrideUser - SBC
	overrideUser - SBC

overrideUser

User

User name to use instead of the default User name for the promotion target.

Y
(if overridePassword
is specified)

Anchor

	promotionTargetId - SBC
	promotionTargetId - SBC

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

Anchor

	promotionTargetName - SBC
	promotionTargetName - SBC

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

promotionTargetId

Anchor

	schedule - SBC
	schedule - SBC

schedule

Schedule

Indication of whether or not to schedule a Bundle promotion.

Valid values

Yes,Y,true
No,N,false.

Y

Anchor

	time - SBC
	time - SBC

time

Time

Time on which to promote the Bundle.

Default is 00:00.

N

...

	Description
URI	http://host_name/uc/resources/promotiontarget
HTTP Method	POST
Description	Creates a Creating Promotion TargetTargets.
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 206378998 Promotion Target Properties.
Example Response	Status 200 /OK Successfully created the promotion target with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

...

Examples

XML

JSON

Example Request

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?><promotionTarget retainSysIds="true"> <agentMappings - PT/> <authenticationMethod - PT>Basic</authenticationMethod - PT> <name - PT>test</ name - PT>
<description - PT/>
<opswiseGroups - PT>
<opswiseGroup>bus-1</opswiseGroup>
<opswiseGroup>bus-2</opswiseGroup>
</ opswiseGroups - PT>
<password - PT>********</ password - PT>
<sysId - PT>ed76d6c78f06402d882e155bfd42b98f</ sysId - PT>
<uri - PT>http://localhost:7070/uc</ uri - PT>
<user - PT>ops.admin</ user - PT>
</promotionTarget>

Expand

title	JSON

{ "agentMappings - PT": []," authenticationMethod - PT": "Basic",
"description - PT": null, "name - PT": "test", "opswiseGroups - PT": [ "bus-1", "bus-2" ], "password - PT": "********", "retainSysIds - PT": true, "sysId - PT": "ed76d6c78f06402d882e155bfd42b98f", "uri - PT": "http://localhost:7070/uc", "user - PT": "ops.admin" }

Anchor

	Promotion Target Properties
	Promotion Target Properties

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	agentMappings - PT
	agentMappings - PT

agentMappings

n/a

List of agentMapping details associated with the Controller

agentMapping details

N

Anchor

	authenticationMethod - PT
	authenticationMethod - PT

authenticationMethod

Authentication Method

Authentication method to use on the target cluster node of the universal controller.

Valid Values:

As String = Basic, As Value = 1
As String = Access Token, As Value = 2

Default is Basic (1).

N

Anchor

	description - PT
	description - PT

description

Description

Promotion Target description

String value of description

N

Anchor

	exportReleaseLevel - PT
	exportReleaseLevel - PT

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - PT
	exportTable - PT

exportTable

n/a

Record table information.

read only

N

Anchor

	name - PT
	name - PT

name

Name

Name for this Promotion Target.

String value of the promotion target name

Y

Anchor

	opswiseGroups - PT
	opswiseGroups - PT

opswiseGroups

Member Of Business Services

List of Business Services that this task belongs to

String value

N

Anchor

	password - PT
	password - PT

password

Password

Login password on the target cluster node of Universal Controller.

String value of password

N

Anchor

	retainSysIds - PT
	retainSysIds - PT

retainSysIds

n/a

Specification for whether or not the Create a Promotion Target web service will persist the sysId - PT property.

If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <script> element.

Valid values: true/false (default is true).

N

Anchor

	sourceAgents - PT
	sourceAgents - PT

sourceAgents

Source Agent

List of source agent names.

N

Anchor

	sysId - PT
	sysId - PT

sysId

n/a

System ID field in the database for this Prommotion Target record.

Persisted only if retainSysIds is set to true.

N

Anchor

	targetAgent - PT
	targetAgent - PT

targetAgent

Target Agent

Target agent name.

String value of the target agent name.

Y

token

Personal Access Token

if authenticationMethod = Access Token; the personal access token to use for authentication.

String value

N

Anchor

	type - PT
	type - PT

type

Type

Agent type.

String value of agent type.

(For example, Windows)

Y

Anchor

	uri - PT
	uri - PT

uri

URI

Uniform Resource Identifier (URI) used to locate the Promotion Target cluster node.

String value uri.

Y

Anchor

	user - PT
	user - PT

user

User

Login ID on the target cluster node of Universal Controller.

String value of user.

N

...

	Description
URI	http://host_name/uc/resources/promotiontarget
HTTP Method	PUT
Description	Updates a Creating Promotion TargetTargets.
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 Promotion Target : Example Request, below.
Properties	See 206378998 Promotion Target Properties.
Example Response	Status 200 /OK Successfully updated the promotion target with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

...

Examples

XML

JSON

Example Request

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTarget retainSysIds="true">
    <agentMappings - PT>
        <agentMapping>
            <sourceAgents - PT>
                <sourceAgent>SBUS30 - AGNT0005</sourceAgent>
            </sourceAgents - PT>
            <targetAgent - PT>SBUS30 - AGNT0005</targetAgent - PT>
            <type - PT>Windows</type - PT>
        </agentMapping>
    <authenticationMethod - PT>Basic</authenticationMethod - PT>

    <agentMappings - PT>
    <name - PT>test</name - PT> 
    <description - PT/> 
    <opswiseGroups - PT> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups - PT> 
    <password - PT>********</password - PT> 
    <sysId - PT>ed76d6c78f06402d882e155bfd42b98f</sysId - PT> 
    <uri - PT>http://localhost:7070/uc</uri - PT> 
    <user - PT>ops.admin</user - PT> 
</promotionTarget>

Expand

title	JSON

 {
    "agentMappings - PT": [

        {
            "sourceAgents - PT": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent - PT": "SBUS30 - AGNT0005",
            "type - PT": "Windows"
        }
    ],
    "authenticationMethod - PT": "Basic",

    "description - PT": null, 
    "name - PT": "test", 
    "opswiseGroups - PT": [ 
       "bus-1", 
       "bus-2" 
    ], 
    "password - PT": "********", 
    "retainSysIds - PT": true, 
    "sysId - PT": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri - PT": "http://localhost:7070/uc", 
    "user - PT": "ops.admin" 
}

Anchor

	List Promotion Targets
	List Promotion Targets

...

	Description
URI	http://host_name/uc/resources/promotiontarget/list
HTTP Method	GET
Description	Retrieve Creating Promotion TargetTargets 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 Create a Promotion Target Example Request, below.
Response Properties	See 206378998 Promotion Target Properties.

Anchor

	List Promotion Targets URI Parameters
	List Promotion Targets URI Parameters

...

List Promotion Targets: Example Response

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

Examples

XML

JSON

Example Response

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTargets>
  <promotionTarget exportReleaseLevel - PT="7.2.0.0" exportTable - PT="ops_promotion_target" retainSysIds="true">
    <agentMappings - PT>
        <agentMapping>
            <sourceAgents - PT>
                <sourceAgent>SBUS30 - AGNT0005</sourceAgent>
            </sourceAgents - PT>
            <targetAgent - PT>SBUS30 - AGNT0005</targetAgent - PT>
            <type - PT>Windows</type - PT>
        </agentMapping>
    <agentMappings - PT>
    <authenticationMethod - PT>Basic</authenticationMethod - PT>

    <name - PT>test</name - PT> 
    <description - PT/> 
    <opswiseGroups - PT> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups - PT> 
    <sysId - PT>ed76d6c78f06402d882e155bfd42b98f</sysId - PT> 
    <uri - PT>http://localhost:7070/uc</uri - PT> 
    <user - PT>ops.admin</user - PT> 
  </promotionTarget>
  <promotionTarget exportReleaseLevel - PT="7.2.0.0" exportTable exportTable- PT="ops_promotion_target" retainSysIds="true">
    <agentMappings - PT />
    <authenticationMethod - PT>Basic</authenticationMethod - PT>

    <name - PT>test</name - PT> 
    <description - PT/> 
    <opswiseGroups - PT> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups - PT> 
    <sysId - PT>ed76d6c78f06402d882e155bfd42b98f</sysId - PT> 
    <uri - PT>http://localhost:7070/uc</uri - PT> 
    <user - PT>ops.admin</user - PT> 
  </promotionTarget>
</promotionTargets>

Expand

title	JSON

 {
    "agentMappings - PT": [

        {
            "sourceAgents - PT": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent - PT": "SBUS30 - AGNT0005",
            "type - PT": "Windows"
        }
    ],
    "authenticationMethod - PT": "Basic",

    "description - PT": null, 
    "exportReleaseLevel - bun": "7.2.0.0",
    "exportTable - bun": "ops_promotion_target"
    "name - PT": "test", 
    "opswiseGroups - PT": [ 
       "bus-1", 
       "bus-2" 
    ], 
    "retainSysIds - PT": true, 
    "sysId - PT": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri - PT": "http://localhost:7070/uc", 
    "user - PT": "ops.admin" 
},
{

    "agentMappings - PT": [],
    "authenticationMethod - PT": "Basic",

    "description - PT": null, 
    "exportReleaseLevel - bun": "7.2.0.0",
    "exportTable - bun": "ops_promotion_target"
    "name - PT": "test", 
    "opswiseGroups - PT": [ 
       "bus-2" 
    ], 
    "retainSysIds - PT": true, 
    "sysId - PT": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri - PT": "http://localhost:7070/uc", 
    "user - PT": "ops.admin"

Anchor

	Delete a Promotion Target
	Delete a Promotion Target

...

	Description
URI	http://host_name/uc/resources/promotiontarget/
HTTP Method	DELETE
Description	Delete a specified Creating Promotion TargetTargets.
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 206378998 Promotion Target Properties.
Example Response	Status 200 /OK Promotion target deleted successfully.

...

	Description
URI	http://host_name/uc/resources/promotiontarget/
HTTP Method	GET
Description	Retrieve a specified Creating Promotion TargetTargets 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 Promotion Target : Example Response, below.
Response Properties	See 206378998 Promotion Target Properties.

Anchor

	Read a Promotion Target URI Parameters
	Read a Promotion Target URI Parameters

...

Read a Promotion Target: Example Response

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

Examples

XML

JSON

Example Request

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<promotionTarget exportReleaseLevel - PT="7.2.0.0"

exportTable - PT="ops_promotion_target" retainSysIds="true">
    <agentMappings - PT>
        <agentMapping>
            <sourceAgents - PT>
                <sourceAgent>SBUS30 - AGNT0005</sourceAgent>
            </sourceAgents - PT>
            <targetAgent - PT>SBUS30 - AGNT0005</targetAgent - PT>
            <type - PT>Windows</type - PT>
        </agentMapping>
    <agentMappings - PT>
    <authenticationMethod - PT>Basic</authenticationMethod - PT>

    <name - PT>test</name - PT> 
    <description - PT/> 
    <opswiseGroups - PT> 
        <opswiseGroup>bus-1</opswiseGroup> 
        <opswiseGroup>bus-2</opswiseGroup> 
    </opswiseGroups - PT> 
    <sysId - PT>ed76d6c78f06402d882e155bfd42b98f</sysId - PT> 
    <uri - PT>http://localhost:7070/uc</uri - PT> 
    <user - PT>ops.admin</user - PT> 
</promotionTarget>

Expand

title	JSON

 {
    "agentMappings - PT": [

        {
            "sourceAgents - PT": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent - PT": "SBUS30 - AGNT0005",
            "type - PT": "Windows"
        }
    ],
    "authenticationMethod - PT": "Basic",

    "description - PT": null, 
    "exportReleaseLevel - bun": "7.2.0.0",
    "exportTable - bun": "ops_promotion_target"
    "name - PT": "test", 
    "opswiseGroups - PT": [ 
       "bus-1", 
       "bus-2" 
    ], 
    "retainSysIds - PT": true, 
    "sysId - PT": "ed76d6c78f06402d882e155bfd42b98f", 
    "uri - PT": "http://localhost:7070/uc", 
    "user - PT": "ops.admin" 
}

Anchor

	Refresh Target Agents
	Refresh Target Agents

...

	Description
URI	http://host_name/uc/resources/promotiontarget/refreshtargetagents
HTTP Method	POST
Description	Refresh the target agents for a specified Creating Promotion TargetTargets.
URI Parameters	See Refresh Target Agents : URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/promotionTarget/refreshtargetagents?targetname=test http://localhost:8080/uc/resources/promotionTarget/refreshtargetagents?targetid=ed76d6c78f06402d882e155bfd42b98f
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	Successfully refreshed target agents for test-1

...

Versions Compared

Old Version 4

New Version 5

Key

Bundles

206378998

Promotion

Read a Bundle: Example Response

Bundleless Promotion: XML and JSON Examples

List Promotion Targets: Example Response

Read a Promotion Target: Example Response