VMware VCLOUD API 1.0 - API - Common Attributes; Complex Types

VMware, Inc. 143
Chapter 8 XML Representations in the vCloud API
Complex Types
XMLelementsdefinedbythevCloud APIareinstancesofcomplextypes.Formostelements,thecomplextype
nameistheelementnameconcatenatedwiththestringType(forexample,theOrgelementisaninstanceof
OrgType,thevDCelementisaninstanceofVdcType,andsoon).Inmost
ofthesecases,theschema
representationoftheelementprovidesanadequatereferencefortheunderlyingcomplextype.
Therearealsoafewgenerictypesofwhichmanydifferentkindsofelementcanbeaninstance.Becausethese
typesarenotassociatedwithaparticularkindofelement,weprovide
schemainformationforthemhere.
EntityType
ThisisthebasecomplextypeforelementssuchasOrg,vDC,andvApp.
IpAddressType
TheIpAddressTypeimposesapatternontheprimitivexs:stringtype.ThepatterndefinesanIPv4address:
<xs:pattern value =
"((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0
-9][0-9]|[1-9][0-9]|[0-9])"/>
Attributesofthistypeareinvalidunlesstheyconformtothepattern
ReferenceType
Manycontainerelementsarepopulatedwithreferencestocontainedobjects.Eachreferenceconsistsofa
hyperlink,anoptionalmediatype,andaname.
Common Attributes
ElementssuchasOrg,Catalog,andvDChaveanumberofcommonattributes.Withtheexceptionofname,
noneoftheseattributesarerequiredinrequestbodies,andareignoredifincluded.Allofthemareincluded
inresponsebodies.
xs:long Numericvalueintherange‐9223372036854775808to9223372036854775807.
xs:int Numericvalueintherange‐2147483648to2147483647.
xs:string Anycharacterdata.
Table 8-2. Primitive XML Data Types Used by the vCloud API (Continued)
Value Description
Schema
Name Min Max Type Description
name 11 xs:string Nameoftheobject
Description 0 1 xs:string Optionaldescriptionoftheobject
Tasks 0 1 TasksInProgressType Read‐onlycontainerforTaskelements.Eachelementin
thecontainerrepresentsaqueued,running,orfailedtask
ownedbythisobject.Successfullycompletedtasksarenot
listed.
Schema
Name Min Max Type Description
href 1 1 xs:anyURI Hyperlinktothereferencedobject
type 0 1 xs:string Objecttype,expressedasthemediatypeoftheXML
representingoftheobject
name 01 xs:string Nameofthereferencedobject.