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:

...

Bundles

63543229

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

Anchor
Bundle Report URI Parameters
Bundle Report URI Parameters
Bundle Report: URI Parameters

...

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

...

	Description
URI	http://host_name/uc/resources/bundle/bybusinessservices
HTTP Method	POST
Description	Creates a Bundle.
Example URI	http://localhost:8080/uc/resources/bundle/bybusinessservices
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Create a Bundle By Business Services: Example Request, below.
Properties	See 63543229 Create a Bundle By Business Services Properties.
Example Response	Status 200 Successfully created bundle "bundle-by-service2" with 1 item(s).

...

	Description
URI	http://host_name/uc/resources/bundle/bydate
HTTP Method	POST
Description	Creates a Bundle.
Example URI	http://localhost:8080/uc/resources/bundle/bydate
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Create a Bundle By Date: Example Request, below.
Properties	See 63543229 Create a Bundle By Date Properties.
Example Response	Status 200 Successfully created bundle "bundle-by-service2" with 1 item(s).

...

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

Anchor
List Bundles Request Parameters
List Bundles Request Parameters
List Bundles Request Parameters

...

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

...

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

Anchor
Read a Bundle URI Parameters
Read a Bundle URI Parameters
Read a Bundle: URI Parameters

...

Anchor
Bundleless Promotion Properties
Bundleless Promotion Properties
Bundleless Promotion: Properties

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

Y

Anchor

	itemIds - promo
	itemIds - promo

itemIds

n/a

IDs for promotion items.

Comma-separated list of promotion item IDs.

Y
(unless itemNames
is specified)

itemNames

Anchor

	itemNames - promo
	itemNames - promo

itemNames

n/a

Names for promotion items.

Comma-separated list of promotion item names.

Y
(unless itemIds
is specified)

itemIds

AnchorpromotionTargetId - promopromotionTargetId - promopromotionTargetIdn

items

n/a

ID of the Promotion Target AnchorpromotionTargetName - promopromotionTargetName

List of promotion items.

Y
(unless promotionTargetName
is specified)promotionTargetName

XML:

Code Block

language	text

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

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

	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

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 theops_universal_template_admin role or the ops_adminrole.

N

Anchor
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion

...

	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 63543229 Promotion Target Properties.
Example Response	Status 200 /OK Successfully created the promotion target with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

...

	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 63543229 Promotion Target Properties.
Example Response	Status 200 /OK Successfully updated the promotion target with sysId 0b6e87e4aa4a410eb1b5875d8fe40985.

...

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

Anchor
List Promotion Targets URI Parameters
List Promotion Targets URI Parameters
List Promotion Targets: URI Parameters

...

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

Anchor
Read a Promotion Target URI Parameters
Read a Promotion Target URI Parameters
Read a Promotion Target: URI Parameters

...

Versions Compared

Old Version 2

New Version 3

Key

Bundles

63543229

Promotion

Anchor
Bundle Report URI Parameters
Bundle Report URI Parameters
Bundle Report: URI Parameters

Anchor
List Bundles Request Parameters
List Bundles Request Parameters
List Bundles Request Parameters

Anchor
Read a Bundle URI Parameters
Read a Bundle URI Parameters
Read a Bundle: URI Parameters

Anchor
Bundleless Promotion Properties
Bundleless Promotion Properties
Bundleless Promotion: Properties

Anchor
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion

Anchor
List Promotion Targets URI Parameters
List Promotion Targets URI Parameters
List Promotion Targets: URI Parameters

Anchor
Read a Promotion Target URI Parameters
Read a Promotion Target URI Parameters
Read a Promotion Target: URI Parameters

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

Bundles

63543229

Promotion

AnchorBundle Report URI ParametersBundle Report URI ParametersBundle Report: URI Parameters

AnchorList Bundles Request ParametersList Bundles Request ParametersList Bundles Request Parameters

AnchorRead a Bundle URI ParametersRead a Bundle URI ParametersRead a Bundle: URI Parameters

AnchorBundleless Promotion PropertiesBundleless Promotion PropertiesBundleless Promotion: Properties

AnchorCancel a Scheduled Bundle PromotionCancel a Scheduled Bundle PromotionCancel a Scheduled Bundle Promotion

AnchorList Promotion Targets URI ParametersList Promotion Targets URI ParametersList Promotion Targets: URI Parameters

AnchorRead a Promotion Target URI ParametersRead a Promotion Target URI ParametersRead a Promotion Target: URI Parameters

Anchor
Bundle Report URI Parameters
Bundle Report URI Parameters
Bundle Report: URI Parameters

Anchor
List Bundles Request Parameters
List Bundles Request Parameters
List Bundles Request Parameters

Anchor
Read a Bundle URI Parameters
Read a Bundle URI Parameters
Read a Bundle: URI Parameters

Anchor
Bundleless Promotion Properties
Bundleless Promotion Properties
Bundleless Promotion: Properties

Anchor
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion
Cancel a Scheduled Bundle Promotion

Anchor
List Promotion Targets URI Parameters
List Promotion Targets URI Parameters
List Promotion Targets: URI Parameters

Anchor
Read a Promotion Target URI Parameters
Read a Promotion Target URI Parameters
Read a Promotion Target: URI Parameters