[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Query By Image Reference
DescriptionQuery for application definitions by Image Reference(streamId, versionId) grouped by application name and version
Request
URLURL
https://cloud.vmwarehorizon.com/imagemgmt/v1/app-def/queryByImageReference
Query Parameters
Query Parameters
string
org_id
Optional
org_id
Request Body
Request Body
ApplicationDefinitionImageReferenceListRepresentation
of mimetype application/json
Required
applicationImageRefListRequest
{
"imageReferences": [
{}
]
}
string
orgId
Optional
OrgId is required for non-customer CSP token
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
PageAppDefResultsTO
of type application/json
Successfully queried app definitions
{
"content": [
{
"applicationImageReferences": [
{
"applicationDefinitionResponseTO": {
"appInventoryId": "string",
"createdAt": "string",
"icons": {
"key": {
"height": 0,
"iconHash": "string",
"icondata": "string",
"path": "string",
"width": 0
}
},
"id": "string",
"manualEntry": false,
"name": "string",
"orgId": "string",
"path": "string",
"publisher": "string",
"registeredExtensions": {
"extensions": [
{
"friendlyName": "string",
"value": "string"
}
],
"otherFileType": [
{
"friendlyName": "string",
"type": "string",
"value": "string"
}
]
},
"streamId": "string",
"updatedAt": "string",
"version": "string",
"versionId": "string"
},
"imageReference": {
"markerId": "string",
"modelVersion": 0,
"streamId": "string",
"versionId": "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"
}
]
}
],
"applicationReference": {
"icon": {
"key": {
"height": 0,
"iconHash": "string",
"icondata": "string",
"path": "string",
"width": 0
}
},
"name": "string",
"version": "string"
}
}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}
boolean
empty
Optional
boolean
first
Optional
boolean
last
Optional
integer as int32
number
Optional
integer as int32
numberOfElements
Optional
integer as int32
size
Optional
integer as int64
totalElements
Optional
integer as int32
totalPages
Optional
Errors
ErrorResponse
400
Bad request
ErrorResponse
401
Unauthorized
ErrorResponse
403
Forbidden
ErrorResponse
500
Failed to query app definitions
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"imageReferences":[{"markerId":"string","modelVersion":0,"streamId":"string","versionId":"string"}],"orgId":"string"}' https://cloud.vmwarehorizon.com/imagemgmt/v1/app-def/queryByImageReference
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: applicationImageRefListRequest
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
