Title page Alcatel-Lucent 5620 SERVICE AWARE MANAGER | 13.0 R7 APPLICATIONAPI DEVELOPER GUIDE 3HE-10590-AAAA-TQZZA Issue 1 | December 2015 Legalnotice Legalnotice Alcatel,Lucent,Alcatel-LucentandtheAlcatel-LucentlogoaretrademarksofAlcatel-Lucent.Allothertrademarksarethepropertyoftheirrespective owners. Theinformationpresentedissubjecttochangewithoutnotice.Alcatel-Lucentassumesnoresponsibilityforinaccuraciescontainedherein. Copyright©2015Alcatel-Lucent.Allrightsreserved. Disclaimers Alcatel-Lucentproductsareintendedforcommercialuses.Withouttheappropriatenetworkdesignengineering,theymustnotbesold,licensedorotherwise distributedforuseinanyhazardousenvironmentsrequiringfail-safeperformance,suchasintheoperationofnuclearfacilities,aircraftnavigationor communicationsystems,airtrafficcontrol,directlife-supportmachines,orweaponssystems,inwhichthefailureofproductscouldleaddirectlytodeath, personalinjury,orseverephysicalorenvironmentaldamage.Thecustomerherebyagreesthattheuse,sale,licenseorotherdistributionoftheproductsfor anysuchapplicationwithoutthepriorwrittenconsentofAlcatel-Lucent,shallbeatthecustomer'ssolerisk.Thecustomerherebyagreestodefendandhold Alcatel-Lucentharmlessfromanyclaimsforloss,cost,damage,expenseorliabilitythatmayariseoutoforinconnectionwiththeuse,sale,licenseorother distributionoftheproductsinsuchapplications. Thisdocumentmaycontaininformationregardingtheuseandinstallationofnon-Alcatel-Lucentproducts.Pleasenotethatthisinformationisprovidedasa courtesytoassistyou.WhileAlcatel-Lucenttriestoensurethatthisinformationaccuratelyreflectsinformationprovidedbythesupplier,pleaserefertothe materialsprovidedwithanynon-Alcatel-Lucentproductandcontactthesupplierforconfirmation.Alcatel-Lucentassumesnoresponsibilityorliabilityfor incorrectorincompleteinformationprovidedaboutnon-Alcatel-Lucentproducts. However,thisdoesnotconstitutearepresentationorwarranty.ThewarrantiesprovidedforAlcatel-Lucentproducts,ifany,aresetforthincontractual documentationenteredintobyAlcatel-Lucentanditscustomers. ThisdocumentwasoriginallywritteninEnglish.IfthereisanyconflictorinconsistencybetweentheEnglishversionandanyotherversionofadocument, theEnglishversionshallprevail. Contents About this document Purpose ..............................................................................................................................................................................................vv Documentsupport..........................................................................................................................................................................vv Howtocomment ............................................................................................................................................................................vv Part I: Getting started 1 Getting started Overview......................................................................................................................................................................................11--11 Part II: Applications and OSS 2 Applications overview Overview......................................................................................................................................................................................22--11 Applications................................................................................................................................................................................22--11 ApplicationsAPI .......................................................................................................................................................................22--22 3 OSS communication with applications Overview......................................................................................................................................................................................33--11 OSScommunication ................................................................................................................................................................33--11 Workflowtoaccessanapplicationresource ...................................................................................................................33--33 Part III: OSS domains 4 Network and service assurance Overview......................................................................................................................................................................................44--11 FaultManagement....................................................................................................................................................................44--11 .................................................................................................................................................................................................................................... 5620SAM iii 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 Contents .................................................................................................................................................................................................................................... Part IV: Appendices 5 Error handling Overview......................................................................................................................................................................................55--11 Errorhandling ............................................................................................................................................................................55--11 6 Application RESTAPI examples Overview......................................................................................................................................................................................66--11 Examples......................................................................................................................................................................................66--11 .................................................................................................................................................................................................................................... iv 5620SAM 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 About this document Aboutthisdocument Purpose The5620SAMApplicationAPIDeveloperGuideprovidesinformationtohelpOSS developerscreatebusinessapplicationswhichinteractwith5620SAMapplicationsin ordertoperformvariousnetworkmanagementfunctions. Document support CustomerdocumentationandproductsupportURLs: Customerdocumentationwelcomepage • https://infoproducts.alcatel-lucent.com/cgi-bin/doc_welc.pl Technicalsupport • http://support.alcatel-lucent.com How to comment Documentationfeedback • [email protected] ................................................................................................................................................................................................................................... 5620SAM v 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 Aboutthisdocument .................................................................................................................................................................................................................................... .................................................................................................................................................................................................................................... vi 5620SAM 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 Part I: Getting started Overview Purpose ThisvolumeprovidesanoverviewofOSSapplicationdevelopmentandOpenInterfaces ProfessionalServices. Contents Chapter1,Gettingstarted 1-1 ................................................................................................................................................................................................................................... 5620SAM I-1 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 Gettingstarted Overview .................................................................................................................................................................................................................................... .................................................................................................................................................................................................................................... I-2 5620SAM 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 1 1Getting started Overview About this guide ThisguideprovidesinformationtohelpOSSdeveloperscreatebusinessapplications whichinteractwith5620SAMapplicationsinordertoperformvariousnetwork managementfunctions. Before you begin Alcatel-LucentrecommendsthatyoudothefollowingbeforeyoustartyourOSS applicationdevelopment: • reviewtherequirementsforlicensesfortheapplicationwithwhichyouplanto integrate • understandOSSinterfacesingeneralandknowledgeofthefollowingtechnologies, whicharebeyondthescopeofthisguide: – HTTP(S)–HyperTextTransferProtocol(Secure) – RESTarchitecture–RepresentationalStateTransfer – JSON– JavascriptObjectNotation – oAuth2.0 – applications Open Interfaces Professional Services TheAlcatel-LucentOIPS(OpenInterfacesProfessionalServices)portfolioprovidesOSS developerssupporthowtointegratewithoursuiteofapplications. OSSintegrationinitiativesincludeprojectreview,designconsultation,development support,andtrainingforintegrationprojects. ................................................................................................................................................................................................................................... 5620SAM 1-1 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015 Gettingstarted Overview .................................................................................................................................................................................................................................... Keyelementsofeachserviceofferinginclude: • Designconsultationandhigh-levelprojectreviews.Extensivesoftwaredesign consultationprovidesarchitecturalreviewofaproposeddesignandguidanceon whetherthedesignmethodologyissuitedtotheproposedapplicationgiven Alcatel-Lucentexperiencewiththeplatformandinterface. • softwaredevelopmentsupportandtechnicalguidance • samplecodethatprovideexamplestofacilitaterapidOSSintegration • OSSproducttrainingthatminimizesprojectdowntimeandoptimizesdevelopment efficiency Alcatel-LucentOIPScancustomizethesupportcontentandcontractlengthtomeetthe uniquedevelopmentrequirementsofserviceproviders. .................................................................................................................................................................................................................................... 1-2 5620SAM 3HE-10590-AAAA-TQZZA13.0R7 Issue1 December2015
Description: