5.5

files
An array of file objects that includes all the files that represent the item.
Each file object is represented as an array with two elements:
name
The name of the file.
hrefs
An array of pathnames to the file. Must contain a
single pathname to the file from the root of the
endpoint, written as a URL fragment.
properties
An array of additional properties of the item. Must be empty.
The following example shows a typical item descriptor for an OVF package.
{
"version" : "1",
"id" : "urn:uuid:b63c9bbe-3614-4153-82fd-d5f4916a1327",
"name" : "template1",
"created" : "2012-09-14T22:18:12.858Z",
"description" : "Added with VMware Ovf Tool.",
"type" : "vcsp.ovf",
"files" : [ {
"name" : "descriptor.ovf",
"size" : 9985,
"hrefs" : [ "descriptor.ovf" ]
}, {
"name" : "vm-3fe8a95b-ccd1-4816-b4ed-d631f3e2bbf3-disk-0.vmdk",
"size" : 833536,
"hrefs" : [ "vm-3fe8a95b-ccd1-4816-b4ed-d631f3e2bbf3-disk-0.vmdk" ]
} ],
} "properties" : {
}
}
Responses
VCSP clients retrieve catalog files, including the descriptor and the endpoint index, with GET requests. The
endpoint must return one of the following responses:
n
HTTP status 200 (OK) followed by the file content
n
HTTP status 503 (Service unavailable) followed by a document that provides additional information.
This document has media type application/json, and provides values for the following keys:
status
Status of the requested file.
progress
File generation progress, expressed as an integer in the range 0 to 100.
message
An error message describing any errors that prevented the file from being
generated.
The client continues to make GET requests until it receives either a 200 response or a 503 response with a
nonempty message.
For example, an in-progress operation could return the following response.
{
"status" : "",
"progress" : 10
}
vCloud API Programming Guide
218 VMware, Inc.