Skip to main content

Bundles and Promotion Web Services

Universal Controller supports the following RESTful-based web services for Bundles and Promotion operations, which are listed alphabetically on this page under two categories:

Bundles​

Promotion​

Formatting specifications for each web service, including details about parameter requirements, are provided.

Bundles​

Bundle Report​

Description

URI

http://host_name/uc/resources/bundle/report

HTTP Method

GET

Description

Retrieve Bundle Report details using specific query parameters.

Example URI

URI Parameters

See Bundle Report: URI Parameters, below.

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See Bundle Report: Example Response, below.

Properties

See Bundle Properties.

Bundle Report: URI Parameters​

Parameter

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

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​

JSON
JSON
{
    "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"
      }
    ],
    "updated": "2021-07-13 17:05:00 -0400",
    "updatedBy": "Administrator",
    "created": "2021-07-13 15:42:34 -0400",
    "createdBy": "Administrator"
  }

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​

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

bundleUniversalEventTemplates

Universal Event Templates

Universal Event Templates Items to include

String value of Universal Event Templates

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

created

Created

Time when this bundle was created.

Read only

N

createdBy

Created By

User who created this bundle.

Read only

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

excludeRelated

n/a

For the Modify a Bundle web service; specification for whether or not to exclude related records from the update, even if they are provided in the request.

info

In XML, excludeRelated is specified as an attribute in the <bundle> element.

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

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

updated

Updated

Time when this bundle was last updated.

Read only

N

updatedBy

Updated By

User who last updated this bundle.

Read only

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

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​

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

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​

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

Updated On Or After

Include List of items created On/After the dae

String value of the date.

Y

Delete a Bundle​

Description

URI

http://host_name/uc/resources/bundle

HTTP Method

DELETE

Description

Deletes a Bundle.

URI Parameters

See Delete a Bundle: URI Parameters, below.

Example URI

Example Response

  • 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

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​

JSON
JSON
[ 
  {
    "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"
      }
    ],
    "updated": "2021-07-13 17:05:00 -0400",
    "updatedBy": "Administrator",
    "created": "2021-07-13 15:42:34 -0400",
    "createdBy": "Administrator",
    "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 Bundle 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​

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

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.

JSON
JSON
{
  "retainSysIds": true,
  "name": "bundle1",
  "sysId": "cf39bea48689411bb2af7e4f1727f633",
  "description": null,
  "opswiseGroups": [
      "d205b106324642409ca101c9dccb3de0",
      "fbdf165af97d4eb390d09f4ccd72a18c"
  ],
  "defaultPromotionTarget": null,
  "excludeOnExistence": null,
  "followReferences": false,
  "promoteBundleDefinition": true,
  "promoteByBusinessServices": [],
  "visibleTo": null,
  "bundleAgentClusters": [],
  "bundleApplications": [],
  "bundleBusinessServices": [],
  "bundleCalendars": [],
  "bundleCredentials": [],
  "bundleCustomDays": [],
  "bundleDatabaseConnections": [],
  "bundleEmailConnections": [],
  "bundleEmailTemplates": [],
  "bundleOAuthClients": [],
  "bundlePeoplesoftConnections": [],
  "bundleReports": [],
  "bundleSapConnections": [],
  "bundleScripts": [],
  "bundleSnmpManagers": [],
  "bundleTasks": [
      {
          "addedBy": "ops.admin",
          "name": "my-win",
          "sysId": "d372ea7ddce945d28be69792e52f93b1",
          "type": "Windows"
      }
  ],
  "bundleTriggers": [
      {
          "addedBy": "ops.admin",
          "name": "my-trigger",
          "sysId": "b4bcf3be572d4cb6b02891fc3489e2da",
          "type": "Time"
      }
  ],
  "bundleUniversalEventTemplates": [],
  "bundleUniversalTemplates": [],
  "bundleVariables": [],
  "bundleVirtualResources": [],
  "updated": "2021-07-13 17:05:00 -0400",
  "updatedBy": "Administrator",
  "created": "2021-07-13 15:42:34 -0400",
  "createdBy": "Administrator",
  "exportReleaseLevel": "8.0.0.0",
  "exportTable": "ops_bundle"
}

Promotion​

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

Example Request​

JSON
JSON
{
  "itemType": "Universal Template",
  "itemIds": "4e656d398d5f4ebd8d7df3210147c488",
  "promotionTargetId": "6330f82afab54273b9167a2b434a2424",
  "overrideUser": "testUser",
  "overridePassword": "testPassword1",
  "followReferences": true,
  "allowUnvTmpltChanges": true,
  "promotionDescription": "description for the promotion"
}

Example Response​

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

Bundleless Promotion: Properties​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

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

itemIds

n/a

IDs for promotion items.

Comma-separated list of promotion item IDs.

Y
(unless itemNamesor itemsis specified)

itemNames

items

itemNames

n/a

Names for promotion items.

Comma-separated list of promotion item names.

Y
(unless itemIds or itemsis specified)

itemIds

items

items

n/a

List of promotion items.

XML
XML
<items>
        <item>
            <name>reportTitle1</name>
        </item>  
         <item>
            <name>reportTitle2</name>
            <user>userName</user>
        </item>
        <item>
            <name>reportTitle3</name>
            <group>groupName</group>
        </item>                  
    </items>
JSON
JSON
"items": [
        {
            "name": "reportTitle1"
        },  
        {
            "name": "reportTitle1",
            "user": "username",
            "group": ""
        },
        {
            "name": "reportTitle2",
            "user": null,
            "group": "group2"
        }
    ]

Y

(unless itemIds
or itemNames is specified)

itemIds

itemNames

promotionTargetId

n/a

ID of the Promotion Target.

Y
(unless promotionTargetName is specified)

promotionTargetName

promotionTargetName

Promotion Target

Name of the Promotion Target.

Y
(unless promotionTargetId is specified)

promotionTargetId

overrideUser

User

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

Y
(if overridePassword is specified)

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

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

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

allUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:

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

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

N

promotionDescription

Promotion Description

Description of the promotion.

String value of the promotion description. Maximum length is 255 characters.

N

Bundleless Promotion: Items Properties​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

name

n/a

Name for a promotion item.

Y

user

n/a

User Id (Username) of a user.

N

group

group

n/a

Name of a user group.

For a dashboard or report visible to multiple groups, you can specify any one of the visibility groups.

N

user

Cancel a Scheduled Bundle Promotion​

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

Example Response

See Cancel a Scheduled Bundle Promotion: XML and JSON Examples.

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 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 Time field in a promotion schedule.

Format: HH:mm (For example: 22:00).

Y
(If bundlename or
bundleid is specified)

Cancel a Scheduled Bundle Promotion: XML and JSON Examples​

JSON
JSON
{
    "type": "schedule_promotion",
    "success": true,
    "info": "",
    "errors": ""
}

OR

{
    "type": "schedule_promotion",
    "success": false,
    "info": "",
    "errors": "The promotion schedule can only be cancelled while in a Scheduled status."
}

Delete a Scheduled Bundle Promotion​

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

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.

Delete 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 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 Time field in a promotion schedule.

Format: HH:mm (For example: 22:00).

Y
(If bundlename or
bundleid is specified)

List Scheduled Bundle Promotions​

Description

URI

http://host_name/uc/resources/promotion/schedule/list

HTTP Method

GET

Description

Retrieve information on all scheduled promotions.

Example URI

http://localhost:8080/uc/resources/promotion/schedule/list

Authentication

Basic/Token

Produces Content-Type

application/json

URI Parameters

See List Scheduled Bundle Promotions: URI Parameters, below.

Example Response

  • Status 200
    • Successful response.
      JSON
      JSON
      [
        {
            "allowUnvTmpltChanges": "false",
            "bundleName": "bun-1",
            "created": "2025-12-08 15:04:56 -0500",
            "createdBy": "ops.admin",
            "notificationOption": "Operation Failure",
            "promotionDescription": null,
            "promotionTargetName": "local-8080",
            "scheduledBy": "ops.admin",
            "scheduledTime": "2025-12-12 12:00:00 -0500",
            "snapshotTime": null,
            "status": "Scheduled",
            "statusDescription": null,
            "sysId": "48f714ebd4d54e76baef4b5c1379ffc6",
            "updated": "2025-12-08 15:13:42 -0500",
            "updatedBy": "ops.admin",
            "useSnapshot": false
        },
        {
            "allowUnvTmpltChanges": "true",
            "bundleName": "bun-1",
            "created": "2025-12-08 10:07:01 -0500",
            "createdBy": "ops.admin",
            "notificationOption": "Operation Failure",
            "promotionDescription": "test1",
            "promotionTargetName": "local-8080",
            "scheduledBy": "ops.admin",
            "scheduledTime": "2025-12-08 11:00:00 -0500",
            "snapshotTime": null,
            "status": "Failure",
            "statusDescription": "Promotion of bundle \"bun-1\" failed with the following error(s): Cluster node information could not be determined for the promotion target (Connection refused: connect).",
            "sysId": "4f6eb6a15b91455f934d0219c4038d83",
            "updated": "2025-12-08 11:00:03 -0500",
            "updatedBy": "ops.admin",
            "useSnapshot": false
        }
      ]
  • Status 503
    • Service Unavailable Response

List Scheduled Bundle Promotions: URI Parameters​

Property

Description

Specifications

Required

Mutually Exclusive With

bundleid

32-character sysid of the Bundle to be promoted.

N

bundlename

bundlename

Bundle Name

Name of the Bundle to be filtered.

bundleid

promotiontargetid

ID of the Controller cluster node on which to promote the Bundle.

Promotion Target of the specified Bundle.

N

promotionTargetName

promotiontargetname

Name of the Controller cluster node on which to promote the Bundle.

Promotion Target of the specified Bundle.

N

promotionTargetId

status

Status of the scheduled promotion.

N

Promote a Bundle or Schedule a Bundle Promotion​

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.

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

Example Request​

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

Example Response​

JSON
JSON
{
    "type": "schedule_promotion",
    "success": true,
    "info": "Successfully scheduled the promotion of bundle \"bun-1\" to promotion target \"local-8080\" for 2025-12-08 12:00:00 -0500.",
    "errors": "",
    "promotionSchedule": {
        "allowUnvTmpltChanges": "true",
        "bundleName": "bun-1",
        "created": "2025-12-12 20:49:01 -0500",
        "createdBy": "ops.admin",
        "notificationOption": "Operation Failure",
        "promotionDescription": "test1",
        "promotionTargetName": "local-8080",
        "scheduledBy": "ops.admin",
        "scheduledTime": "2025-12-08 12:00:00 -0500",
        "snapshotTime": null,
        "status": "Scheduled",
        "statusDescription": null,
        "sysId": "b0b7ae44ce664aaaae05277818116bcd",
        "updated": "2025-12-12 20:49:01 -0500",
        "updatedBy": "ops.admin",
        "useSnapshot": false
    }
}

Promote a Bundle or Schedule a Bundle Promotion: Properties​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

allowUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:

  • Yes,Y,true
  • No,N,false
info

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

N

createSnapshot

Create Snapshot

Schedule the Bundle promotion using the current Bundle records.

Valid values:

  • Yes,Y,true
  • No,N,false

N

date

Date

Date on which to promote the Bundle.

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

id

n/a

32-character sysid of the Bundle to be promoted.

Y
(unless name
is specified)

name

name

Bundle Name

Name of the Bundle to be promoted.

Y
(unless id
is specified)

id

notificationOption

System Notification

System Notification to send on success and/or failure of the promotion.

Valid values (not case sensitive):

  • operation Failure (default)
  • operation success/failure
  • operation success

N

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

overrideUser

User

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

Y
(if overridePassword
is specified)

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

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

schedule

Schedule

Indication of whether or not to schedule a Bundle promotion.

Valid values

  • Yes,Y,true
  • No,N,false.

Y

time

Time

Time on which to promote the Bundle.

Default is 00:00.

N

promotionDescription

Promotion Description

Description of the promotion.

String value of the promotion description. Maximum length is 255 characters.

N

Reschedule a Bundle Promotion​

Description

URI

http://host_name/uc/resources/promotion/schedule/{scheduleId}

HTTP Method

PUT

Description

Re-Schedule a specified scheduled promotion bundle.

Example URI

http://localhost:8080/uc/resources/promotion/schedule/48f714ebd4d54e76baef4b5c1379ffc6

Authentication

Basic/Token

Consumes Content-Type

application/json

Produces Content-Type

application/json

Request Properties

See Reschedule a Bundle Promotion: Properties.

Example Response

  • Status 200
    • Successful response.
      JSON
      JSON
      {
          "status": "success",
          "info": [
              {
                  "message": "Successfully rescheduled the promotion of bundle \"bun-1\" to promotion target \"local-8080\" from 2025-12-20 00:00:00 -0500 to 2025-12-20 00:00:00 -0500."
              }
           ],
           "promotionSchedule": {
                "allowUnvTmpltChanges": "false",
                "bundleName": "bun-1",
                "created": "2025-12-12 18:19:10 -0500",
                "createdBy": "ops.admin",
                "notificationOption": "Operation Success/Failure",
                "promotionDescription": null,
                "promotionTargetName": "local-8080",
                "scheduledBy": "ops.admin",
                "scheduledTime": "2025-12-20 00:00:00 -0500",
                "snapshotTime": "2025-12-12 18:19:10 -0500",
                "status": "Scheduled",
                "statusDescription": null,
                "sysId": "96f62f6f622e4320b9111bf8479e5ec0",
                "updated": "2025-12-12 20:32:17 -0500",
                "updatedBy": "ops.admin",
                "useSnapshot": true
            }
      }
  • Status 503
    • Service Unavailable Response

Reschedule a Bundle Promotion: Properties​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

allowUnvTmpltChanges

Allow Universal Template Changes

Allow the promotion to contain new or changed Universal Templates.

Valid values:

  • Yes,Y,true
  • No,N,false
info

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

N

date

Date

Date on which to promote the Bundle.

Format: yyyy-MM-dd (For example: 2018-11-14).

Y
(if schedule
is Yes,Y,true)

notificationOption

System Notification

System Notification to send on success and/or failure of the promotion.

Valid values (not case sensitive):

  • operation Failure (default)
  • operation success/failure
  • operation success

N

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

overrideUser

User

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

Y
(if overridePassword
is specified)

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

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

time

Time

Time on which to promote the Bundle.

Default is 00:00.

N

promotionDescription

Promotion Description

Description of the promotion.

String value of the promotion description. Maximum length is 255 characters.

N

Create a Promotion Target​

Description

URI

  • http://host_name/uc/resources/promotiontarget

HTTP Method

POST

Description

Creates a Promotion Target.

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 Promotion Target Properties.

Example Response

  • Status 200 /OK
    Successfully created the promotion target with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

Create a Promotion Target: Example Request​

info

All of the mapping agents will be automatically mapped when you execute the Refresh Target Agent command, so the mapping agents included in the request will be ignored.

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

Promotion Target Properties​

Property

UI Field Name

Description

Specifications

Required

agentMappings

n/a

List of agentMapping details associated with the Controller

agentMapping details

N

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

description

Description

Promotion Target description

String value of description

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

name

Name

Name for this Promotion Target.

String value of the promotion target name

Y

opswiseGroups

Member Of Business Services

List of Business Services that this task belongs to

String value

N

password

Password

Login password on the target cluster node of Universal Controller.

String value of password

N

retainSysIds

n/a

Specification for whether or not the Create a Promotion Target web service will persist the sysId 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.
info

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

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

N

sourceAgents

Source Agent

List of source agent names.

info

sourceAgents is not supported for the Create web service. You can only read or modify existing Source Agent mappings.

List of source agent names.

N

sysId

n/a

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

Persisted only if retainSysIds is set to true.

N

targetAgent

Target Agent

Target agent name.

info

targetAgent is not supported for the Create web service. You can only read or modify existing Target Agent mappings.

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

type

Type

Agent type.

String value of agent type.

(For example, Windows)

Y

uri

URI

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

String value uri.

Y

user

User

Login ID on the target cluster node of Universal Controller.

String value of user.

N

Modify a Promotion Target​

Modify a Promotion Target is used for updating the promotion target details and source agent details of the mapping agent details.

You can map multiple source agents to a specific target agent, but you cannot add the same source agents for more than one target agent.

Description

URI

  • http://host_name/uc/resources/promotiontarget

HTTP Method

PUT

Description

Updates a Promotion Target.

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 Target: Example Request, below.

Properties

See Promotion Target Properties.

Example Response

  • Status 200 /OK
    Successfully updated the promotion target with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

Modify a Promotion Target: Example Request​

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

List Promotion Targets​

List Promotion Targets allows the retrieval of promotion target details based on provided search criteria.

Description

URI

http://host_name/uc/resources/promotiontarget/list

HTTP Method

GET

Description

Retrieve Promotion Target 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, below.

Response Properties

See Promotion Target Properties.

List Promotion Targets: URI Parameters​

Property

UI Field Name

Description

Specifications

Required

targetname

N/A

Request parameter targetname

String value of the target name.

Wildcards are supported.

N

businessServices

N/A

Request parameter businessServices.

String value of the business service

N

List Promotion Targets: Example Response​

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

JSON
JSON
{
    "agentMappings": [
        {
            "sourceAgents": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent": "SBUS30 - AGNT0005",
            "type": "Windows"
        }
    ],
    "authenticationMethod": "Basic",
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_promotion_target"
    "name": "test",
    "opswiseGroups": [
       "bus-1",
       "bus-2"
    ],
    "retainSysIds": true,
    "sysId": "ed76d6c78f06402d882e155bfd42b98f",
    "uri": "http://localhost:7070/uc",
    "user": "ops.admin"
},
{
    "agentMappings": [],
    "authenticationMethod": "Basic",
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_promotion_target"
    "name": "test",
    "opswiseGroups": [
       "bus-2"
    ],
    "retainSysIds": true,
    "sysId": "ed76d6c78f06402d882e155bfd42b98f",
    "uri": "http://localhost:7070/uc",
    "user": "ops.admin"
}

Delete a Promotion Target​

Delete a Promotion Target allows the deletion of a specified promotion target.

Description

URI

http://host_name/uc/resources/promotiontarget/

HTTP Method

DELETE

Description

Delete a specified Promotion Target.

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 Promotion Target Properties.

Example Response

  • Status 200 /OK
    Promotion target deleted successfully.

Delete Promotion Target: URI Parameters​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive

targetname

n/a

Request parameter targetname.

String value of the promotion target name

Y
(unless targetid
is specified)

targetid

targetid

n/a

Request parameter targetid.

String value of the promotion target sysId

Y
(unless targetname
is specified)

targetname

Read a Promotion Target​

Read a Promotion Target allows the reading of promotion target details based on a specified targetid or targetname.

Description

URI

http://host_name/uc/resources/promotiontarget/

HTTP Method

GET

Description

Retrieve a specified Promotion Target 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 Target: Example Response, below.

Response Properties

See Promotion Target Properties.

Read a Promotion Target: URI Parameters​

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive

targetname

n/a

Request parameter targetname.

String value of the promotion target name

Y
(unless targetid
is specified)

targetid

targetid

n/a

Request parameter targetid.

String value of the promotion target sysId

Y
(unless targetname
is specified)

targetname

Read a Promotion Target: Example Response​

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

JSON
JSON
{
    "agentMappings": [
        {
            "sourceAgents": [
                "SBUS30 - AGNT0005"
            ],
            "targetAgent": "SBUS30 - AGNT0005",
            "type": "Windows"
        }
    ],
    "authenticationMethod": "Basic",
    "description": null,
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_promotion_target"
    "name": "test",
    "opswiseGroups": [
       "bus-1",
       "bus-2"
    ],
    "retainSysIds": true,
    "sysId": "ed76d6c78f06402d882e155bfd42b98f",
    "uri": "http://localhost:7070/uc",
    "user": "ops.admin"
}

Refresh Target Agents​

Refresh Promotion Target Agents allows the refreshing of the target Controller agents mapped to the promotion target.

Description

URI

  • http://host_name/uc/resources/promotiontarget/refreshtargetagents

HTTP Method

POST

Description

Refresh the target agents for a specified Promotion Target.

URI Parameters

See Refresh Target Agents: URI Parameters, below.

Example URI

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Successfully refreshed target agents for test-1

Refresh Target Agents: URI Parameters​

Property

Description

Specifications

Required

Mutually Exclusive

targetname

Name for this Promotion Target.

String value of the promotion target name passed as query parameter.

Y
(unless targetid
is specified)

targetid

targetid

Promotion Target sysId.

String value of the promotion target sysId passed as query parameter.

Y
(unless targetname
is specified)

targetname

token

Override Personal Access Token on the target cluster node of Universal Controller.

String value of personal access token, passed as request body.
If both token and username+password are specified, token takes precedence and username+password will be ignored.

N

username

Override Login ID on the target cluster node of Universal Controller.

String value of user, passed as request body.

Y
(if password is specified)

password

Override Login password on the target cluster node of Universal Controller.

String value of password, passed as request body.

Y
(if username is specified)

Refresh Target Agents: Example Request​

JSON
JSON
{ 
    "password": "1234",
    "username": "ops.admin"
}