patch
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | LIST |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Attribute | Value |
---|---|
Type | STRING |
Nillable | false |
Expressions Allowed | false |
Storage | runtime |
Access Type | read-only |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
input-stream-index | INT | false | false | 0 | The index into the operation's attached input streams of the input stream that contains the zipped patch file that should be uploaded to the server to apply the patch. |
override-all | BOOLEAN | false | false | false | True to bypass any content verification on the miscellaneous items changed by the patch. |
override-modules | BOOLEAN | false | false | false | True to bypass any content verification on the modules affected by the patch. |
override | LIST | false | false | List of the miscellaneous items in the patch that can be overridden on the server whether the item reports a conflict or not. | |
preserve | LIST | false | false | List of the miscellaneous items that must be preserved and not modified by applying the patch. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
patch-id | STRING | false | false | The identifier of the patch | |
verbose | BOOLEAN | false | false | false | Optional, default is false and results in brief info about the patch, true to include detailed information about the layer and add-on patches included into the patch. |
{
"patch-id" => {
"type" => STRING,
"description" => "The identifier of the patch",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"type" => {
"type" => STRING,
"description" => "Type of the patch (one-off or cumulative)",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"identity-name" => {
"type" => STRING,
"description" => "The name of the target identity",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"identity-version" => {
"type" => STRING,
"description" => "The version of the target identity",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"description" => {
"type" => STRING,
"description" => "Description of the patch",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"link" => {
"type" => STRING,
"description" => "An optional link for more information about the patch",
"expressions-allowed" => false,
"required" => false,
"nillable" => true,
"min-length" => 1L,
"max-length" => 2147483647L
},
"elements" => {
"type" => LIST,
"description" => "Patch elements",
"expressions-allowed" => false,
"required" => false,
"nillable" => true,
"min-length" => 0L,
"max-length" => 2147483647L,
"value-type" => {
"patch-id" => {
"type" => STRING,
"description" => "The identifier of the patch element",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"type" => {
"type" => STRING,
"description" => "The type of the element provider (layer or add-on)",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"name" => {
"type" => STRING,
"description" => "The name of the element provider",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
},
"description" => {
"type" => STRING,
"description" => "The description of the patch element",
"expressions-allowed" => false,
"required" => true,
"nillable" => false,
"min-length" => 1L,
"max-length" => 2147483647L
}
}
}
}
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
patch-id | STRING | true | false | The ID of the patch to rollback. | |
rollback-to | BOOLEAN | false | false | false | If the patch to rollback is a one-off patch, it signifies that the rollback operation will also rollback all the other one-off patches that have been applied on top of the patch to rollback. |
reset-configuration | BOOLEAN | true | false | The rollback operation will update the installation configurations and reset the snapshots that were taken when the patch was applied. | |
override-all | BOOLEAN | false | false | false | True to bypass any content verification on the miscellaneous items changed by the patch that is rolled back. |
override-modules | BOOLEAN | false | false | false | True to bypass any content verification on the modules affected by the patch that is rolled back. |
override | LIST | false | false | List of the miscellaneous items that can be overridden on the server when the patch is rolled back whether the item reports a conflict or not. | |
preserve | LIST | false | false | List of the miscellaneous items that must be preserved and not modified by rolling back the patch. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
reset-configuration | BOOLEAN | true | false | The rollback operation will update the installation configurations and reset the snapshots that were taken when the patch was applied. | |
override-all | BOOLEAN | false | false | false | True to bypass any content verification on the miscellaneous items changed by the patch that is rolled back. |
override-modules | BOOLEAN | false | false | false | True to bypass any content verification on the modules affected by the patch that is rolled back. |
override | LIST | false | false | List of the miscellaneous items that can be overridden on the server when the patch is rolled back whether the item reports a conflict or not. | |
preserve | LIST | false | false | List of the miscellaneous items that must be preserved and not modified by rolling back the patch. |
Request Parameter | Type | Required | Expressions Allowed | Default value | Description |
---|---|---|---|---|---|
exclude-aged-out | BOOLEAN | false | false | false | Whether to filter out patches that have been removed by the ageout-history operation. |