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

Patch App Version

Description

Patch an existing application version with certain attributes of the application versionIf org is not provided, it will use the org from the authentication context.

Request

Request

URL

URL


patch
https://cloud.vmwarehorizon.com/av-appies/v1/app-versions/{appVersionId}
Copy

Path Parameters

Path Parameters

string
appVersionId Required

App Version Id

appVersionId example
"e7421121-d052-4fd9-861f-7ce57246134e"

Query Parameters

Query Parameters

string
org_id Optional

Organization ID: non-super users can only access their own organization

org_id example
"5c2409df-a307-4a04-b558-fb0693d42890"

Request Body

Request Body

AppVersionPatchDataDto of mimetype application/json Required

Schema for Appversion Patch. All fields are optional. Only the fields containing values are patched

{
	"data": {
		"applicationId": "da891c6b-3ac6-491b-9c79-c58788819500",
		"bundleGuid": "da891c6b-3ac6-491b-9c79-c58788819500",
		"deliveryFormat": "APP_VOLUMES",
		"deliveryMode": "ONDEMAND",
		"description": "MS Office 2013 for windows",
		"lifecycleStage": "UNPACKAGED",
		"name": "Office2019",
		"packagerNotes": "Packaged for compatability checking",
		"version": "16.0.10386.20017"
	}
}
data Optional

Internal Schema for Appversion Patch. All fields are optional. Only the fields containing values are patched. AppVersion is the particular version of software installed/captured in a given capture session. As part of the Cloud native capture only one AppVersion can be part of a Package. AppVersion was called in the past as “App Bundle” in the 3.x terminology. This is uniquely identified by a uuid which is generated during the capture session. With application package merge, it is possible to have the same AppVersion in multiple packages and also that single Package can have more than one AppVersion contained in it. Eg: “Microsoft Office 2013 sp1” can be the application version which can be captured under a virtual application named “Microsoft Office”, and this version can reside on a package “Microsoft_Office_2013_SP1_Clean.vhd”

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns AppVersionDto of type */*
{
    "applicationId": "da891c6b-3ac6-491b-9c79-c58788819500",
    "bundleGuid": "da891c6b-3ac6-491b-9c79-c58788819500",
    "createdAt": "2022-07-11T07:44:49.619+00:00",
    "deliveryFormat": "APP_VOLUMES",
    "deliveryMode": "ONDEMAND",
    "description": "MS Office 2013 for windows",
    "id": "e7421121-d052-4fd9-861f-7ce57246134e",
    "lifecycleStage": "UNPACKAGED",
    "location": "US",
    "markerIds": [
        "CURRENT"
    ],
    "name": "Office2019",
    "orgId": "e7421121-d052-4fd9-861f-7ce57246134e",
    "packagerNotes": "Packaged for compatability checking",
    "updatedAt": "2022-07-11T07:44:49.619+00:00",
    "version": "16.0.10386.20017"
}
application Optional

Schema Representation for Application. Application is the Virtual Application container which will be created by the administrator to store the diffrent application packages captured or imported to be stored under. This will act as a grouping for different versions of the same software, so that the administrator can mark one of the application versions using a marker and that can be used in an assignment. Eg: “Microsoft Office” will be created as an application which is the virtual application container which will contain “Microsoft Office 2013 sp1” as an application version under it, “Microsoft_Office_2013_SP1_Clean.vhd” can be the application package containing the particular application version


string
applicationId Optional

Application Id of AppVersion


string
bundleGuid Optional

Bundle guid of AppVersion


string
createdAt Optional

This represents the timestamp at which the object was created


string
deliveryFormat Optional

Delivery Format, APP_VOLUMES is used if this field is empty


string
deliveryMode Optional

Delivery mode of AppVersion, It can be either CLASSIC or ONDEMAND. CLASSIC is the default

Possible values are: CLASSICONDEMAND


string
description Optional

Description of AppVersion


string
id Optional

This represents the unique Id of the Object


string
lifecycleStage Optional

Stages of AppVersion, starting with UNPACKAGED which the system sets during application capture followed by NEW when capture is completed and Then TESTED,PUBLISHED and finally RETIRED when its no longer used.

Possible values are: NEWPUBLISHEDRETIREDTESTEDUNPACKAGED


string
location Optional

This represents the location


array of string
markerIds Optional

string
name Optional

Name of AppVersion


operatingSystem Optional

Data Structure related to OperatingSystem. OperatingSystem is the version of the Operating system on which the AppVersion is associated with which only they are captured or compatible with. Eg: AppVersion “Microsoft Office 2013 sp1” is capture on and compatible with “Windows 7 (64)”


string
orgId Optional

This represents the organization Id


string
packagerNotes Optional

Notes added during the capture process or updated externally during pre-processing via metadata.


array of PackageDto
packages Optional

Schema for Package. Package is a physical file which might be of the format of VHD or VMDK based on the deployment platform used. This is the Physical file which will contain the AppVersion which is the Software installed/captured on a single capture session. Package file will reside on a file share when it is captured in case of Azure. With application package merge, it is possible for single Package to have more than one AppVersion contained in it. Eg: “Microsoft_Office_2013_SP1_Clean.vhd” can be an application package file which can contain the application version “Microsoft Office 2013 sp1”. Also this file will recide on a staging file share coressponding to the node/pod where it is captured.


array of ProgramDto
programs Optional

Schema for Program. Program is the software component installed part of the capture session and which is detected by the App volumes capture agent as a seperate program based on variuos criteria predefined. Each program will have its own icon.Eg: “Microsoft Excel” can be a program isntalled as part of the application software version “Microsoft Office 2013 sp1”


string
status Optional

Possible values are: DELETE_FAILEDPENDING_DELETE


string
updatedAt Optional

This represents the latest timestamp at which the object was updated


string
version Optional

Custom version of AppVersion

Errors

Errors

ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


ErrorResponse
404

Not Found

Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"data":{"applicationId":"da891c6b-3ac6-491b-9c79-c58788819500","bundleGuid":"da891c6b-3ac6-491b-9c79-c58788819500","deliveryFormat":"APP_VOLUMES","deliveryMode":"ONDEMAND","description":"MS Office 2013 for windows","lifecycleStage":"UNPACKAGED","name":"Office2019","packagerNotes":"Packaged for compatability checking","version":"16.0.10386.20017"}}' https://cloud.vmwarehorizon.com/av-appies/v1/app-versions/e7421121-d052-4fd9-861f-7ce57246134e
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?