Service Automation REST API Reference PDF
Preview Service Automation REST API Reference
Service Automation REST API Reference Release 16.1R1 Modified:2018-04-18 Copyright©2018,JuniperNetworks,Inc. JuniperNetworks,Inc. 1133InnovationWay Sunnyvale,California94089 USA 408-745-2000 www.juniper.net JuniperNetworks,theJuniperNetworkslogo,Juniper,andJunosareregisteredtrademarksofJuniperNetworks,Inc.and/oritsaffiliatesin theUnitedStatesandothercountries.Allothertrademarksmaybepropertyoftheirrespectiveowners. JuniperNetworksassumesnoresponsibilityforanyinaccuraciesinthisdocument.JuniperNetworksreservestherighttochange,modify, transfer,orotherwiserevisethispublicationwithoutnotice. ServiceAutomationRESTAPIReference 16.1R1 Copyright©2018JuniperNetworks,Inc.Allrightsreserved. Theinformationinthisdocumentiscurrentasofthedateonthetitlepage. YEAR2000NOTICE JuniperNetworkshardwareandsoftwareproductsareYear2000compliant.JunosOShasnoknowntime-relatedlimitationsthroughthe year2038.However,theNTPapplicationisknowntohavesomedifficultyintheyear2036. ENDUSERLICENSEAGREEMENT TheJuniperNetworksproductthatisthesubjectofthistechnicaldocumentationconsistsof(orisintendedforusewith)JuniperNetworks software.UseofsuchsoftwareissubjecttothetermsandconditionsoftheEndUserLicenseAgreement(“EULA”)postedat https://www.juniper.net/support/eula/.Bydownloading,installingorusingsuchsoftware,youagreetothetermsandconditionsofthat EULA. ii Copyright©2018,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.........................37 GenerateaPBNReport..............................................39 GenerateanEOLReport.............................................42 ShowAllPBNsforaDevice...........................................44 Chapter3 PBNManagementAPIs............................................49 PBNManagementRESTAPIOverview..................................49 GetAllTargetedPBNs...............................................50 GetDetailsofaTargetedPBN.........................................52 AssignanOwnerforaTargetedPBN...................................54 ScanTargetedPBNsforImpact.......................................56 FlagaTargetedPBNtoUsers.........................................57 DeleteaTargetedPBN...............................................59 Chapter4 PBNReportManagementAPIs......................................61 PBNReportManagementRESTAPIOverview............................61 GetAllPBNReportsinServiceInsight..................................62 GetInformationaboutaPBNReport...................................64 RegenerateaPBNReport............................................66 ExportaPBNReport................................................68 DeleteaPBNReport................................................69 Copyright©2018,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...................................103 GetGlobalSettingsConfiguration.....................................104 ModifyGlobalSettings..............................................107 ChangeServiceNowOperatingModetoOffline.........................109 ChangeServiceNowOperatingModetoEndCustomerorDirect............110 TestConnectionwithJSSorServiceNowPartner.........................112 GetAllSNMPConfiguration..........................................113 GetSNMPConfigurationbyID........................................115 AddanSNMPConfiguration..........................................117 UpdateanSNMPConfiguration.......................................119 DeleteanSNMPConfiguration........................................121 Modify SNMP Traps ................................................122 GetSNMPTrapAttributes...........................................124 GetDetailsofanSNMPTrapAttribute.................................126 GetCoreFileUploadConfiguration....................................129 ModifyaCoreFileConfiguration......................................130 UpdateCoreFileConfigurationinEndCustomerMode....................132 CheckSFTPConnectionStatus.......................................133 GetDirectiveFileDetails.............................................134 UploadtheDirectiveFile.............................................135 Refresh the Directive File ............................................136 RestoretheDirectiveFile............................................136 Download the Directive File ..........................................137 Chapter8 Organization APIs ................................................139 OrganizationManagementRESTAPIOverview..........................139 GetAllOrganizationsinServiceNow...................................141 GetanOrganizationbySpecifyingitsSiteName......................143 GetanOrganizationbySpecifyingaPartialSiteName.................144 iv Copyright©2018,JuniperNetworks,Inc. TableofContents GetinformationaboutanOrganization.................................145 AddanOrganization................................................147 Check Organization Status ...........................................151 GetInformationAboutSites..........................................153 GetJMBFilterLevelsInfo............................................156 GetCaseSubmissionValues.........................................157 Modify an Organization .............................................158 AssociateanAddressGroupwithanOrganization........................162 DeleteanOrganizationbyOrganizationID..............................164 AddanEndCustomerOrganizationinPartnerProxyMode.................165 ModifyanEnd-CustomerOrganizationinPartnerProxyMode..............168 UpdateCoreFileInformationforanEndCustomer........................172 View Organization Messages .........................................175 Chapter9 Device Group Management APIs ...................................179 DeviceGroupManagementRESTAPIOverview..........................179 CreateaDeviceGroup..............................................180 GetAllDeviceGroups...............................................184 GetInformationAboutaDeviceGroup.................................185 ModifyaDeviceGroup..............................................188 AssociateaDevicewithaDeviceGroup.................................191 DeleteaDeviceGroup..............................................194 Chapter10 Device Management APIs .........................................197 DeviceManagementRESTAPIOverview...............................197 DeviceManagementRESTAPI....................................197 GetAllDevicesinServiceNow.......................................200 GetInformationAboutaDevice......................................203 Export all Devices .................................................209 Export Device Inventory .............................................210 AddaDevicetoServiceNow.........................................212 AssociateaDevicewithaDeviceGroup................................215 CreateOn-DemandIncident..........................................217 InstallanEventProfileonaDevice.....................................221 UninstallanEventProfilefromaDevice................................223 RequestRMAIncident..............................................225 CreateanOn-DemandDeviceSnapshot...............................229 GetCreateOn-DemandincidentJobResults............................231 GetCreateOn-DemandDeviceSnapshotJobResults....................234 GetRequestRMAJobResults........................................237 CheckFTPServerforaDevice.......................................240 ConfigureMaintenanceMode........................................242 ViewExposureofaDevice...........................................245 ViewContractInformationforaServiceNowDevice......................247 DeleteaDevicefromServiceNow....................................248 Chapter11 Event Profile APIs ................................................251 EventProfileManagementRESTAPIOverview..........................251 GetAllEventProfiles...............................................253 GetInformationAboutanEventProfile................................255 Copyright©2018,JuniperNetworks,Inc. v ServiceAutomationRESTAPIReference CreateanEventProfile.............................................260 InstallEventProfileonDevices.......................................263 ExportAllEventProfilesbyType......................................266 ExportEventProfilesbyIDandType..................................268 ImportEventProfilesfromaFile......................................270 GetImportEventProfilesJobDetails..................................273 GetEventProfilesImportJobResults..................................276 CloneanEventProfile..............................................278 SetanEventProfileastheDefaultEventProfile..........................281 Chapter12 ScriptBundleAPIs...............................................283 ScriptBundleManagementRESTAPIOverview.........................283 GetAllScriptBundles..............................................284 GetInformationAboutaScriptBundle................................286 GetAllEventScriptsinaScriptBundle................................290 AddaScriptBundletoServiceNow...................................292 SetaScriptBundleastheDefaultScriptBundle.........................294 InstallScriptBundleonaDevice......................................295 UninstallScriptBundlefromaDevice.................................299 DeleteaScriptBundle..............................................302 Chapter13 Incident Management APIs .......................................305 IncidentManagementRESTAPIOverview..............................305 GetAllIncidentsinServiceNow......................................307 GetanIncidentbyIncidentID.........................................312 GetIncidentbyCustomerTrackingNumber.............................326 DeleteanIncidentbyIncidentID......................................329 ExportaJMBintheHTMLorXMLFormat...............................331 Save a Case ......................................................332 Submit a Case ....................................................337 GettheLocationofaCaseinCaseManager............................343 AssignanOwnertoanincident.......................................344 FlaganIncidenttoUsers............................................346 ExporttheSummaryofanIncidenttoExcel............................348 CreateaCaseforanEnd-CustomerIncident............................349 UploadCoreFilesforanIncident......................................351 GetAttachmentDetailsbyIncidentID.................................353 CloseanEnd-CustomerCase........................................355 Update an End-Customer Case ......................................356 UploadAttachmenttoIncidentbyUsingSCP...........................358 UploadAttachmenttoIncidentbyUsingHTTP..........................359 DownloadLogFilesandJMBofanIncident.............................361 DownloadallAttachmentsofanIncident..............................362 DownloadanAttachmentofanIncident...............................362 GetUser-UploadedAttachmentsbyIncidentID.........................363 DownloadanUser-UploadedAttachmentofanIncident..................365 Chapter14 Tech Support Case APIs ..........................................367 TechSupportCaseManagementRESTAPIOverview.....................367 GetAllTechSupportCases..........................................368 vi Copyright©2018,JuniperNetworks,Inc. TableofContents GetInformationAboutaTechnicalSupportCase.........................371 UpdateaTechnicalSupportCasebyCaseID............................374 UploadAttachmenttoCasebyUsingSCP..............................376 UploadAttachmenttoCasebyUsingHTTP.............................378 ViewaTechSupportCaseinCaseManager.............................379 Chapter15 EndCustomerCaseAPIs..........................................381 ServiceNowEndCustomerCaseManagementRESTAPIOverview..........381 GetAllEnd-customerCases.........................................382 GetInformationAboutanEnd-CustomerCase..........................384 ViewanEnd-CustomerCaseinCaseManager...........................387 Chapter16 DeviceSnapshotAPIs............................................389 DeviceSnapshotManagementRESTAPIOverview......................389 GetAllDeviceSnapshotsinServiceNow...............................390 GetDeviceSnapshotInfobyDeviceID.................................393 ExportDeviceSnapshotInformationbyDeviceID........................397 GetAttachmentDetailsbyDeviceSnapshotID..........................397 DownloadAllAttachmentsofaDeviceSnapshot........................399 DownloadDeviceSnapshotAttachmentbyID..........................400 DeleteDeviceSnapshotbyDeviceSnapshotID.........................400 GetUploadStatusofDeviceSnapshotAttachments.....................402 ViewDeviceSnapshotsinOriginalorFilteredFormat.....................409 GetUser-UploadedAttachmentsforaTechSupportCasebyID............410 DownloadanUser-UploadedAttachmentofanTechnicalSupportCase.....412 Chapter17 Auto Submit Policy APIs ..........................................413 AutosubmitPolicyManagementRESTAPIOverview.....................413 GetAllAutoSubmitPoliciesinServiceNow.............................415 GetInformationAboutanAutoSubmitPolicy...........................418 CreateanAutoSubmitPolicy........................................422 AssignanAutoSubmitPolicytoDevices...............................426 GetDevicesAssociatedWithanAutoSubmitPolicy......................428 GetEventsAssociatedwithanAutoSubmitPolicy.......................430 ChangeStatusofanAutoSubmitPolicy...............................433 ChangetheDampeningStatusofanAutoSubmitPolicy..................434 ExportIncidentReportofAutoSubmitPolicies..........................435 DeleteanAutoSubmitPolicy........................................437 Chapter18 CertificateAPIs..................................................439 CertificateManagementRESTAPIOverview............................439 GetAllCertificates.................................................440 GetaCertificatebyCertificateID.....................................442 AddaCertificatetoServiceNow.....................................444 DeleteCertificatebyID.............................................445 Chapter19 AddressGroupAPIs..............................................447 AddressGroupManagementRESTAPIOverview........................447 GetAllAddressGroups.............................................449 GetanAddressGroupbyAddressGroupID.............................451 CreateanAddressGroup............................................454 Copyright©2018,JuniperNetworks,Inc. vii ServiceAutomationRESTAPIReference ModifyanAddressGroup...........................................458 AssociateDevicestoanAddressGroup................................461 RemoveDevicesfromanAddressGroup...............................465 GetAllEndCustomerAddressGroups.................................469 GetEndCustomerAddressGroupsbyID...............................472 Chapter20 JMBErrorManagementAPIs.......................................477 JMBErrorManagementRESTAPIOverview.............................477 GetAllJMBswithErrors.............................................478 GetaJMBwithErrorInformationbyJMBID.............................480 DeleteaJMBwithErrors.............................................481 ExportaJMBwithErrors............................................482 Chapter21 Device Analysis APIs .............................................485 DeviceAnalysisRESTAPIOverview...................................485 Get All BIOS Validations ............................................487 GetBIOSValidationbyID...........................................490 DeleteBIOSValidationbyID.........................................493 ExportAllBIOSValidations..........................................494 ExportBIOSValidationbyID.........................................496 ViewBIOSLegalNotice.............................................498 AcceptBIOSLegalNotice...........................................499 ConfigureBIOSValidationOnDevices.................................500 ConfigureBIOSValidationonNewlyDiscoveredDevices..................503 GetAllDevicesinaPHDCConfiguration...............................506 GetAllDevicesHavingPHD.........................................509 GetPHDCConfigurationofaDevicebyPHDDeviceConfigurationID.........512 GetAllPHDsbyPHDDeviceConfigurationID............................514 ExportAllPHDsbyDeviceID.........................................518 GetPHDbyID.....................................................519 DownloadPHDbyID...............................................523 DeletePHDbyID..................................................524 ExportPHDbyID..................................................526 ExportAllDevicesHavingProductHealthData..........................527 Chapter22 ProductHealthDataCollectionAPIs................................531 ProductHealthDataCollectionManagementRESTAPIOverview...........531 Get All PHDCs ....................................................533 GetDetailsofaPHDCConfiguration..................................536 CreateaPHDCConfiguration........................................539 ModifyaPHDCConfiguration........................................542 DisableDevicesinaPHDCConfiguration...............................545 RetryPHDConDevices.............................................547 AbortaPHDCConfiguration.........................................549 DeleteaPHDCConfiguration........................................550 ExportAllDevicesinaPHDC.........................................551 GetAllPHDsbyPHDCIDandPHDDeviceConfigurationID................552 ExportAllPHDsbyPHDCIDandPHDDeviceConfigurationID..............557 viii Copyright©2018,JuniperNetworks,Inc. TableofContents Chapter23 E-mail Template APIs ............................................559 E-mailTemplateManagementRESTAPIOverview......................559 Get All E-mail Templates ...........................................560 GetDetailsofanEmailTemplate.....................................562 ModifyanE-mailTemplate..........................................565 RestoreanE-mailTemplatetoitsDefault..............................567 Chapter24 Information APIs .................................................571 InformationManagementRESTAPIOverview...........................571 GetAllInformationMessages........................................572 Get Information Message Details .....................................574 AssignOwnershiptoanInformationMessage...........................577 AssignanInformationMessagetoanEndCustomer......................578 FlaganInformationMessagetoUsers.................................580 Delete an Information Message ......................................582 Chapter25 ServiceNowNotificationAPIs.....................................585 ServiceNowNotificationManagementRESTAPIOverview................585 ChangeStatusofaServiceNowNotification...........................586 CopyaServiceNowNotification......................................591 CreateaServiceNowNotification.....................................597 GetAllNotificationsinServiceNow...................................601 DeleteaNotification...............................................604 EditFilterandActionofaNotification.................................605 Copyright©2018,JuniperNetworks,Inc. ix ServiceAutomationRESTAPIReference x Copyright©2018,JuniperNetworks,Inc.
Description:The list of books you might like
