ebook img

Service Automation REST API Reference PDF

602 Pages·2016·4.79 MB·English
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview Service Automation REST API Reference

Service Automation REST API Reference Modified:2016-06-23 Copyright©2016,JuniperNetworks,Inc. JuniperNetworks,Inc. 1133InnovationWay Sunnyvale,California94089 USA 408-745-2000 www.juniper.net Copyright©2016,JuniperNetworks,Inc.Allrightsreserved. JuniperNetworks,Junos,Steel-BeltedRadius,NetScreen,andScreenOSareregisteredtrademarksofJuniperNetworks,Inc.intheUnited Statesandothercountries.TheJuniperNetworksLogo,theJunoslogo,andJunosEaretrademarksofJuniperNetworks,Inc.Allother trademarks,servicemarks,registeredtrademarks,orregisteredservicemarksarethepropertyoftheirrespectiveowners. JuniperNetworksassumesnoresponsibilityforanyinaccuraciesinthisdocument.JuniperNetworksreservestherighttochange,modify, transfer,orotherwiserevisethispublicationwithoutnotice. ServiceAutomationRESTAPIReference Copyright©2016,JuniperNetworks,Inc. Allrightsreserved. Theinformationinthisdocumentiscurrentasofthedateonthetitlepage. YEAR2000NOTICE JuniperNetworkshardwareandsoftwareproductsareYear2000compliant.JunosOShasnoknowntime-relatedlimitationsthroughthe year2038.However,theNTPapplicationisknowntohavesomedifficultyintheyear2036. ENDUSERLICENSEAGREEMENT TheJuniperNetworksproductthatisthesubjectofthistechnicaldocumentationconsistsof(orisintendedforusewith)JuniperNetworks software.UseofsuchsoftwareissubjecttothetermsandconditionsoftheEndUserLicenseAgreement(“EULA”)postedat http://www.juniper.net/support/eula.html.Bydownloading,installingorusingsuchsoftware,youagreetothetermsandconditionsof thatEULA. ii Copyright©2016,JuniperNetworks,Inc. Table of Contents AbouttheDocumentation............................................xv DocumentationandReleaseNotes.................................xv SupportedPlatforms.............................................xv Documentation Conventions ......................................xv DocumentationFeedback........................................xvii RequestingTechnicalSupport....................................xviii Self-HelpOnlineToolsandResources..........................xviii OpeningaCasewithJTAC....................................xviii Chapter1 Overview .........................................................21 ServiceAutomationRESTAPIOverview.................................21 ServiceNowRESTAPIs..............................................24 ServiceInsightRESTAPIs............................................28 Part1 ServiceInsightRESTAPIs Chapter2 ExposureAnalyzerAPIs............................................33 ExposureAnalyzerRESTAPIOverview..................................33 GetAllDevicesinServiceInsight.......................................34 GetInformationaboutaDeviceinServiceInsight.........................36 GenerateaPBNReport..............................................39 GenerateanEOLReport.............................................42 ShowAllPBNsforaDevice...........................................43 Chapter3 PBNManagementAPIs............................................49 PBNManagementRESTAPIOverview..................................49 GetAllTargetedPBNs...............................................50 GetDetailsofaTargetedPBN.........................................52 AssignanOwnerforaTargetedPBN...................................54 ScanTargetedPBNsforImpact.......................................56 FlagaTargetedPBNtoUsers.........................................57 DeleteaTargetedPBN...............................................58 Chapter4 PBNReportManagementAPIs......................................61 PBNReportManagementRESTAPIOverview............................61 GetAllPBNReportsinServiceInsight..................................62 GetInformationaboutaPBNReport...................................64 RegenerateaPBNReport............................................66 Export a PBN Report ................................................67 DeleteaPBNReport................................................68 Copyright©2016,JuniperNetworks,Inc. iii ServiceAutomationRESTAPIReference Chapter5 EOLReportManagementAPIs......................................71 EOLReportManagementRESTAPIOverview.............................71 GetAllEOLReports.................................................72 GetInformationaboutanEOLReport...................................74 RegenerateanEOLReport............................................75 ExportanEOLReporttoanExcelFile...................................77 DeleteanEOLReport................................................78 Chapter6 Service Insight Notification APIs ....................................81 ServiceInsightNotificationManagementRESTAPIOverview................81 GetAllServiceInsightNotifications....................................82 CreateaServiceInsightNotification....................................84 CopyaServiceInsightNotification.....................................87 ChangeStatusofaServiceInsightNotification...........................90 EditFiltersandActionsofaServiceInsightNotification....................94 DeleteaServiceInsightNotification....................................97 Part2 ServiceNowRESTAPIs Chapter7 GlobalSettingAPIs...............................................101 GlobalSettingsManagementRESTAPIOverview........................101 GetGlobalSettingsInformationLink...................................102 GetGlobalSettingsConfiguration.....................................104 ModifyGlobalSettings..............................................106 ChangeServiceNowOperatingModetoOffline.........................108 ChangeServiceNowOperatingModetoEndCustomerorDirect............109 TestConnectionwithJSSorServiceNowPartner.........................111 Get All SNMP Configuration ..........................................112 GetSNMPConfigurationbyID........................................113 AddanSNMPConfiguration..........................................115 Update an SNMP Configuration .......................................117 DeleteanSNMPConfiguration........................................119 Modify SNMP Traps ................................................120 Get SNMP Trap Attributes ...........................................123 GetDetailsofanSNMPTrapAttribute.................................125 GetCoreFileUploadConfiguration....................................128 ModifyaCoreFileConfiguration......................................129 UpdateCoreFileConfigurationinEndCustomerMode.....................131 CheckSFTPConnectionStatus.......................................132 Chapter8 Organization APIs ................................................135 OrganizationManagementRESTAPIOverview..........................135 GetAllOrganizationsinServiceNow...................................137 GetanOrganizationbySpecifyingitsSiteName......................139 GetanOrganizationbySpecifyingaPartialSiteName.................140 GetinformationaboutanOrganization.................................141 AddanOrganization................................................143 CheckOrganizationStatus...........................................147 Get Information About Sites .........................................148 GetJMBFilterLevelsInfo............................................152 iv Copyright©2016,JuniperNetworks,Inc. TableofContents GetCaseSubmissionValues.........................................153 Modify an Organization .............................................154 AssociateanAddressGroupwithanOrganization........................157 DeleteanOrganizationbyOrganizationID..............................159 AddanEndCustomerOrganizationinPartnerProxyMode.................161 ModifyanEnd-CustomerOrganizationinPartnerProxyMode..............164 UpdateCoreFileInformationforanEndCustomer........................167 ViewOrganizationMessages..........................................171 Chapter9 Device Group Management APIs ...................................173 DeviceGroupManagementRESTAPIOverview..........................173 Create a Device Group ..............................................174 GetAllDeviceGroups...............................................178 GetInformationAboutaDeviceGroup.................................179 ModifyaDeviceGroup..............................................182 AssociateaDevicewithaDeviceGroup................................185 DeleteaDeviceGroup..............................................188 Chapter10 DeviceManagementAPIs..........................................191 DeviceManagementRESTAPIOverview................................191 DeviceManagementRESTAPI....................................191 GetAllDevicesinServiceNow........................................194 GetInformationAboutaDevice.......................................197 ExportallDevices..................................................203 ExportDeviceInventory.............................................204 AddaDevicetoServiceNow.........................................206 CreateOn-DemandIncident.........................................209 InstallanEventProfileonaDevice....................................213 UninstallanEventProfilefromaDevice................................216 RequestRMAIncident...............................................217 CreateanOn-DemandDeviceSnapshot................................221 GetCreateOn-DemandincidentJobResults............................223 GetCreateOn-DemandDeviceSnapshotJobResults....................226 GetRequestRMAJobResults........................................229 CheckFTPServerforaDevice........................................232 ConfigureMaintenanceMode........................................234 ViewExposureofaDevice...........................................237 ViewContractInformationforaServiceNowDevice......................239 Chapter11 Event Profile APIs ................................................241 EventProfileManagementRESTAPIOverview..........................241 GetAllEventProfiles...............................................242 GetInformationAboutanEventProfile................................245 Create an Event Profile .............................................250 InstallEventProfileonDevices.......................................253 ExportAllEventProfilesbyType......................................255 ExportEventProfilesbyIDandType...................................258 ImportEventProfilesfromaFile......................................260 GetImportEventProfilesJobDetails..................................263 GetEventProfilesImportJobResults..................................266 Copyright©2016,JuniperNetworks,Inc. v ServiceAutomationRESTAPIReference CloneanEventProfile..............................................268 SetanEventProfileastheDefaultEventProfile..........................271 Chapter12 Script Bundle APIs ...............................................273 ScriptBundleManagementRESTAPIOverview.........................273 Get All Script Bundles ..............................................274 GetInformationAboutaScriptBundle.................................276 GetAllEventScriptsinaScriptBundle................................280 AddaScriptBundletoServiceNow...................................282 SetaScriptBundleastheDefaultScriptBundle.........................284 InstallScriptBundleonaDevice......................................285 UninstallScriptBundlefromaDevice.................................289 DeleteaScriptBundle..............................................292 Chapter13 Incident Management APIs .......................................295 IncidentManagementRESTAPIOverview..............................295 GetAllIncidentsinServiceNow......................................297 GetanIncidentbyIncidentID........................................302 GetIncidentbyCustomerTrackingNumber.............................317 DeleteanIncidentbyIncidentID......................................320 ExportaJMBintheHTMLorXMLFormat...............................321 Save a Case ......................................................322 Submit a Case ....................................................327 GettheLocationofaCaseinCaseManager............................334 AssignanOwnertoanincident.......................................335 FlaganIncidenttoUsers............................................337 ExporttheSummaryofanIncidenttoExcel............................339 CreateaCaseforanEnd-CustomerIncident............................340 UploadCoreFilesforanIncident......................................342 DownloadallAttachmentsofanIncident..............................344 CloseanEnd-CustomerCase........................................345 Update an End-Customer Case ......................................346 UploadAttachmenttoIncidentbyUsingSCP...........................347 UploadAttachmenttoIncidentbyUsingHTTP..........................349 DownloadLogFilesandJMBofanIncident.............................351 Chapter14 Tech Support Case APIs ..........................................353 TechSupportCaseManagementRESTAPIOverview.....................353 GetAllTechSupportCases..........................................354 GetInformationAboutaTechnicalSupportCase........................357 UpdateaTechnicalSupportCasebyCaseID...........................360 UploadAttachmenttoCasebyUsingSCP..............................362 UploadAttachmenttoCasebyUsingHTTP............................364 ViewaTechSupportCaseinCaseManager.............................365 Chapter15 EndCustomerCaseAPIs..........................................367 ServiceNowEndCustomerCaseManagementRESTAPIOverview.........367 GetAllEnd-customerCases.........................................368 GetInformationAboutanEnd-CustomerCase..........................370 ViewanEnd-CustomerCaseinCaseManager...........................374 vi Copyright©2016,JuniperNetworks,Inc. TableofContents Chapter16 Device Snapshot APIs ............................................377 DeviceSnapshotManagementRESTAPIOverview.......................377 GetAllDeviceSnapshotsinServiceNow...............................378 GetDeviceSnapshotInfobyDeviceID.................................381 ExportDeviceSnapshotInformationbyDeviceID........................385 DownloadAllAttachmentsofaDeviceSnapshot........................385 DeleteDeviceSnapshotbyDeviceSnapshotID.........................386 GetUploadStatusofDeviceSnapshotAttachments.....................387 ViewDeviceSnapshotsinOriginalorFilteredFormat.....................395 Chapter17 AutoSubmitPolicyAPIs..........................................397 AutosubmitPolicyManagementRESTAPIOverview.....................397 GetAllAutoSubmitPoliciesinServiceNow............................399 GetInformationAboutanAutoSubmitPolicy...........................402 CreateanAutoSubmitPolicy........................................406 AssignanAutoSubmitPolicytoDevices...............................410 GetDevicesAssociatedWithanAutoSubmitPolicy......................412 GetEventsAssociatedwithanAutoSubmitPolicy.......................414 ChangeStatusofanAutoSubmitPolicy................................417 ChangetheDampeningStatusofanAutoSubmitPolicy..................418 ExportIncidentReportofAutoSubmitPolicies..........................419 DeleteanAutoSubmitPolicy.........................................421 Chapter18 Certificate APIs ..................................................423 CertificateManagementRESTAPIOverview............................423 GetAllCertificates.................................................424 GetaCertificatebyCertificateID.....................................426 AddaCertificatetoServiceNow......................................428 DeleteCertificatebyID.............................................430 Chapter19 AddressGroupAPIs..............................................433 AddressGroupManagementRESTAPIOverview........................433 GetAllAddressGroups.............................................435 GetanAddressGroupbyAddressGroupID.............................437 Create an Address Group ...........................................440 ModifyanAddressGroup...........................................444 AssociateDevicestoanAddressGroup................................447 RemoveDevicesfromanAddressGroup................................451 GetAllEndCustomerAddressGroups.................................456 GetEndCustomerAddressGroupsbyID...............................459 Chapter20 JMBErrorManagementAPIs......................................463 JMBErrorManagementRESTAPIOverview............................463 GetAllJMBswithErrors............................................464 GetaJMBwithErrorInformationbyJMBID.............................465 DeleteaJMBwithErrors............................................467 ExportaJMBwithErrors............................................468 Chapter21 DeviceAnalysisAPIs..............................................471 DeviceAnalysisRESTAPIOverview....................................471 Get All BIOS Validations ............................................473 Copyright©2016,JuniperNetworks,Inc. vii ServiceAutomationRESTAPIReference GetBIOSValidationbyID...........................................476 DeleteBIOSValidationbyID.........................................479 ExportAllBIOSValidations..........................................480 ExportBIOSValidationbyID.........................................482 ViewBIOSLegalNotice.............................................484 AcceptBIOSLegalNotice...........................................485 ConfigureBIOSValidationOnDevices.................................486 ConfigureBIOSValidationonNewlyDiscoveredDevices..................489 GetAllDevicesinaPHDCConfiguration................................491 GetAllDevicesHavingPHD.........................................495 GetPHDCConfigurationofaDevicebyPHDDeviceConfigurationID........498 GetAllPHDsbyPHDDeviceConfigurationID...........................500 ExportAllPHDsbyDeviceID........................................504 Get PHD by ID ....................................................505 DownloadPHDbyID...............................................509 Delete PHD by ID ..................................................510 ExportPHDbyID...................................................512 ExportAllDevicesHavingProductHealthData..........................513 Chapter22 ProductHealthDataCollectionAPIs................................517 ProductHealthDataCollectionManagementRESTAPIOverview...........517 GetAllPHDCs.....................................................519 GetDetailsofaPHDCConfiguration...................................522 CreateaPHDCConfiguration........................................526 ModifyaPHDCConfiguration........................................528 DisableDevicesinaPHDCConfiguration...............................531 RetryPHDConDevices.............................................532 AbortaPHDCConfiguration.........................................534 Delete a PHDC Configuration ........................................535 ExportAllDevicesinaPHDC.........................................536 GetAllPHDsbyPHDCIDandPHDDeviceConfigurationID................537 ExportAllPHDsbyPHDCIDandPHDDeviceConfigurationID..............542 Chapter23 E-mail Template APIs ............................................545 E-mailTemplateManagementRESTAPIOverview.......................545 Get All E-mail Templates ...........................................546 GetDetailsofanEmailTemplate.....................................548 Modify an E-mail Template ..........................................551 RestoreanE-mailTemplatetoitsDefault..............................553 Chapter24 InformationAPIs.................................................557 InformationManagementRESTAPIOverview...........................557 GetAllInformationMessages........................................558 GetInformationMessageDetails.....................................560 AssignOwnershiptoanInformationMessage...........................563 AssignanInformationMessagetoanEndCustomer......................565 FlaganInformationMessagetoUsers.................................566 Delete an Information Message ......................................568 viii Copyright©2016,JuniperNetworks,Inc. TableofContents Chapter25 ServiceNowNotificationAPIs......................................571 ServiceNowNotificationManagementRESTAPIOverview.................571 ChangeStatusofaServiceNowNotification............................572 CopyaServiceNowNotification......................................577 CreateaServiceNowNotification....................................583 GetAllNotificationsinServiceNow...................................587 DeleteaNotification...............................................590 EditFilterandActionofaNotification..................................591 Part2 Index Index ........................................................601 Copyright©2016,JuniperNetworks,Inc. ix ServiceAutomationRESTAPIReference x Copyright©2016,JuniperNetworks,Inc.

Description:
Script Bundle Management REST API Overview . You use standard HTTP methods to access the Service Now and Service Insight APIs. For example uri:'/api/juniper/servicenow/device-management/devices/163840',. hostName:'mx480-2-re0',. serialNumber:'JN11AFF42AFB', product:'MX480',.
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.