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
|
items
| n/a | List of promotion items. | XML:
Code Block |
---|
| <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 |
---|
| "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 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)
| N |
|