Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
Table of Contents
maxlevel1

...

XML Request

JSON Request

Expand
titleXML Request

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

Expand
titleJSON Request

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

...

XML Request

JSON Request

Expand
titleXML Request

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

Expand
titleJSON Request

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

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
itemType - promo
itemType - promo
itemType

n/aItem 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
Y

Anchor
itemIds - promo
itemIds - promo
itemIds

n/aIDs for promotion items.Comma-separated list of promotion item IDs.Y
(unless itemNames
is specified)
itemNames

Anchor
itemNames - promo
itemNames - promo
itemNames

n/aNames for promotion items.

Comma-separated list of promotion item names.

Y
(unless itemIds
is specified)
itemIds

Anchor
promotionTargetId - promo
promotionTargetId - promo
promotionTargetId

n/aID 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

PasswordUser password to use instead of the default User password for the Promotion Target.
Y
(if overrideUser
is specified)

Anchor
excluseOnExistence - promo
excluseOnExistence - promo
excludeOnExistence

Exclude On ExistenceItem 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
N

Anchor
followReferences - promo
followReferences - promo
followReferences

Follow ReferencesDynamically 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 ChangesAllow the promotion to contain new or changed Universal Templates.

Valid values:

  • Yes,Y,true
  • No,N,false (default)
Note
titleNote

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

...