Panel | ||||
---|---|---|---|---|
|
...
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 |
|
...
Description | |
---|---|
URI | |
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 | |
Example Response |
|
...
Description | |
---|---|
URI | |
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 | |
Example Response |
|
...
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 |
|
...
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):
| Y | ||||||||||||
itemIds | n/a | IDs for promotion items. | Comma-separated list of promotion item IDs. | Y (unless itemNames or items is specified) |
| |||||||||||
itemNames | n/a | Names for promotion items. | Comma-separated list of promotion item names. | Y (unless itemIds or is specified) |
| |||||||||||
| n/a | List of promotion items. | XML:
JSON:
| Y (unless |
| |||||||||||
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) | |||||||||||||
| Personal Access Token | Personal Access Token to use instead of the default personal access token for the Promotion Target. | If both | 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:
| N | ||||||||||||
followReferences | Follow References | Dynamically include items in the promotion that are referenced by promotion items. | Valid values:
| N | ||||||||||||
| Allow Universal Template Changes | Allow the promotion to contain new or changed Universal Templates. | Valid values:
| N |
Anchor | ||||
---|---|---|---|---|
|
...
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| UUID of the promotion schedule. | N |
| |
| Name of the bundle. | N |
| |
| UUID of the bundle. | N |
| |
| Date when the promotion was scheduled. | Format: yyyy-MM-dd (For example: 2018-11-14). | Y | |
| Time when the promotion was scheduled. | Format: HH:mm (For example: 22:00). | Y |
...
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| UUID of the promotion schedule. | N |
| |
| Name of the bundle. | N |
| |
| UUID of the bundle. | N |
| |
| Date when the promotion was scheduled. | Format: yyyy-MM-dd (For example: 2018-11-14). | Y | |
| Time when the promotion was scheduled. | Format: HH:mm (For example: 22:00). | Y |
...
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:
| N | ||||||||||||
createSnapshot | Create Snapshot | Schedule the Bundle promotion using the current Bundle records. | Valid values:
| N | ||||||||||||
date | Date | Date on which to promote the Bundle. | Y | |||||||||||||
id | n/a | 32-character sysid of the Bundle to be promoted. | Y |
| ||||||||||||
name | Bundle Name | Name of the Bundle to be promoted. | Y |
| ||||||||||||
notificationOption | System Notification | System Notification to send on success and/or failure of the promotion. | Valid values (not case sensitive):
| N | ||||||||||||
overridePassword | Password | User password to use instead of the default User password for the promotion target. | Y | |||||||||||||
| Personal Access Token | Personal Access Token to use instead of the default personal access token for the Promotion Target. | If both | N | ||||||||||||
overrideUser | User | User name to use instead of the default User name for the promotion target. | Y | |||||||||||||
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 | 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 |
| |||||||||||
schedule | Schedule | Indication of whether or not to schedule a Bundle promotion. | Valid values
| Y | ||||||||||||
time | Time | Time on which to promote the Bundle. | Default is 00:00. | N |
...
Description | |
---|---|
URI | |
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 | |
Example Response |
|
...
Description | |
---|---|
URI | |
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 | |
Example Response |
|
...
Description | |
---|---|
URI | |
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 |
...
Description | |
---|---|
URI | |
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 | |
Example Response |
|
...
Description | |
---|---|
URI | |
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 |
...
Description | |
---|---|
URI | |
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 |
...