[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Patch Version

Description

Submit Version update request. Supports updating description and markers of Version.

Marker update will trigger pool updates if the request is accepted and moved existing marker to this version.

Pool updates happen asynchronously and can be tracked via marker status.

Request

Request

URL

URL


patch
https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}
Copy

Path Parameters

Path Parameters

string
imageId Required

imageId


string
versionId Required

versionId


Query Parameters

Query Parameters

string
org_id Optional

Org Id of the Version to be updated.


Request Body

Request Body

VersionPatchTO of mimetype application/json Required

versionPatchTO

{
	"description": "string",
	"markers": [
		{
			"createdAt": "string",
			"errorCode": "UPDATES_FAILED",
			"errorDetails": "string",
			"errorDetailsParameters": {
				"key": "string"
			},
			"id": "0123456789",
			"imageId": "0123456789",
			"name": "HRLite,HRPro",
			"nextVersionId": "0123456789",
			"orgId": "0123456789",
			"status": "IN_PROGRESS",
			"templateCount": 0,
			"updatedAt": "string",
			"versionId": "0123456789"
		}
	]
}
string
description Optional

Description to be updated for the Version


array of MarkerTO
markers Optional

Markers to be added/updated to the Version.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns VersionTO of type application/json

Successfully accepted Version update request

{
    "id": "0123456789",
    "lastTriggeredAction": "IMPORT",
    "orgId": "0123456789",
    "sourceType": "AZURE_MARKET_PLACE",
    "state": "PUBLISHED",
    "status": "AVAILABLE",
    "streamId": "0123456789",
    "versionHistory": [
        "1.0.0",
        "2.0.0"
    ],
    "versionType": "MAJOR"
}
string as date-time
createdAt Optional

Timestamp of record creation


string
description Optional

Description of this version of the image


string
id Optional

Unique record ID


string
lastTriggeredAction Optional

Indicates the last action performed on the version

Possible values are: CLONEDELETEIMPORTPUBLISHUNPUBLISH


array of MarkerTO
markers Optional

Markers associated with Version


string
name Optional

Version name


options Optional

string
orgId Optional

Org ID that owns this record


string
os Optional

OS name for this version. If this value is null at version level, value from Image can be referred.


string
sourceType Optional

Indicates source type of the version

Possible values are: AKKA_CUSTOM_VMAKKA_MARKET_PLACEAKKA_SIGAZURE_CUSTOM_VMAZURE_MARKET_PLACEAZURE_SIGCOPIED_FROM_VERSIONIMPORTED_VMSUPLOADEDVSPHERE_CATALOG


string
sourceVersionId Optional

Indicates the specific version in the current stream that was used to create this version if any


string
state Optional

Indicates state of the version

Possible values are: NOT_READYPARTIALLY_PUBLISHEDPUBLISHEDUNPUBLISHED


string
status Optional

Indicates the status of the version based on its stage in import or publish workflow

Possible values are: AVAILABLEDELETINGDISABLEDFAILEDIMPORT_COMPLETEIMPORT_IN_PROGRESSPARTIALLY_AVAILABLEPENDINGPUBLISH_IN_PROGRESSREPLICATION_IN_PROGRESS


string
streamId Optional

Stream id that this version belong to.


string as date-time
updatedAt Optional

Timestamp of last record modification


integer as int64
version Optional

Record version (internal)


array of string
versionHistory Optional

Indicates lineage of all versions preceding this version


string
versionType Optional

Indicates version type

Possible values are: MAJORMINORPATCH


versionValidationDetails Optional
Errors

Errors

400

Bad request


401

Unauthorized


403

Forbidden


404

Not Found


409

Conflict


500

Failed to validate or submit Version update request

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"description":"string","markers":[{"createdAt":"string","errorCode":"UPDATES_FAILED","errorDetails":"string","errorDetailsParameters":{"key":"string"},"id":"0123456789","imageId":"0123456789","name":"HRLite,HRPro","nextVersionId":"0123456789","orgId":"0123456789","status":"IN_PROGRESS","templateCount":0,"updatedAt":"string","versionId":"0123456789"}]}' https://cloud.vmwarehorizon.com/imagemgmt/v1/images/{imageId}/versions/{versionId}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: versionPatchTO


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?