6.2.2

VMware, Inc. 63
Appendix B ADM API Tutorial
Bulk API
TheBulkAPIprovidesyouwiththepossibilityofqueryingtheADMwithmoresophisticatedfilters,and
browsingtheresultsetbymeansofpagination.Theresultsaredeliveredinsubsets(pages)ofapredefined
sizeandformattedinXMLCIM.ThisAPIisintendedforthosecaseswhereanapplication
intendstobrowse
onfinely‐filteredsegmentoftheADMʹsdata.
The Bulk API works as follows
1 Createthefilterobjectandselectthelevelofgranularityoftheresults.
2 Callquery( )withthefilterobjectandobtainthetaskUUIDinstringform.
3AfterthetaskisFINISHED,youcanretrievethemaximumamountof
pagesavailableinthisresultsetby
callinggetPageAmount( ).
4Atthismoment,thereisaniteratorinADMthatyoucancontrolbythefollowingcalls,andtheresults
retrievedfromthem:
a hasNextPage( )
b getNextPage()
5Afterfinishingretrievalofallthedatawiththespecificquery,youmustcallcloseQuery() toreleaseall

resourcesassociatedwiththisquery.
Web Services API
ThepreferredmethodtoaccessADMʹsAPIisthroughthewebservicesAPI,whichprovidesfora
standardizedwayofcommunicationandhighinteroperability.ThisAPIisnotlockedinagivenprogramming
language.
ADMoffersadescriptionoftheAPIinamachine‐readabledocumentformattedinWebServices
Description
Language(WSDL).Withthisdocument,automatedtoolsavailableforthepopularprogramminglanguages
cancreatethelow‐levelcodenecessarytoaccesstransparentlythefunctionalityprovidedbytheADM.