Service Now and Service Insight REST API Reference PDF
Preview Service Now and Service Insight REST API Reference
Service Now and Service Insight REST API Reference Release 17.2R1 Modified:2019-03-29 Copyright©2019,JuniperNetworks,Inc. JuniperNetworks,Inc. 1133InnovationWay Sunnyvale,California94089 USA 408-745-2000 www.juniper.net JuniperNetworks,theJuniperNetworkslogo,Juniper,andJunosareregisteredtrademarksofJuniperNetworks,Inc.intheUnitedStates andothercountries.Allothertrademarks,servicemarks,registeredmarks,orregisteredservicemarksarethepropertyoftheirrespective owners. JuniperNetworksassumesnoresponsibilityforanyinaccuraciesinthisdocument.JuniperNetworksreservestherighttochange,modify, transfer,orotherwiserevisethispublicationwithoutnotice. ServiceNowandServiceInsightRESTAPIReference 17.2R1 Copyright©2019JuniperNetworks,Inc.Allrightsreserved. Theinformationinthisdocumentiscurrentasofthedateonthetitlepage. YEAR2000NOTICE JuniperNetworkshardwareandsoftwareproductsareYear2000compliant.JunosOShasnoknowntime-relatedlimitationsthroughthe year2038.However,theNTPapplicationisknowntohavesomedifficultyintheyear2036. ENDUSERLICENSEAGREEMENT TheJuniperNetworksproductthatisthesubjectofthistechnicaldocumentationconsistsof(orisintendedforusewith)JuniperNetworks software.UseofsuchsoftwareissubjecttothetermsandconditionsoftheEndUserLicenseAgreement(“EULA”)postedat https://support.juniper.net/support/eula/.Bydownloading,installingorusingsuchsoftware,youagreetothetermsandconditionsof thatEULA. ii Copyright©2019,JuniperNetworks,Inc. Table of Contents About the Documentation ...........................................xvii Documentation and Release Notes ................................xvii Documentation Conventions .....................................xvii Documentation Feedback ........................................xix Requesting Technical Support .....................................xx Self-HelpOnlineToolsandResources...........................xx CreatingaServiceRequestwithJTAC...........................xxi Chapter1 Overview .........................................................23 ServiceAutomationRESTAPIOverview.................................23 ServiceNowRESTAPIs..............................................26 ServiceInsightRESTAPIs............................................29 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©2019,JuniperNetworks,Inc. iii ServiceNowandServiceInsightRESTAPIReference 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.....................................88 ChangeStatusofaServiceInsightNotification...........................90 EditFiltersandActionsofaServiceInsightNotification....................94 DeleteaServiceInsightNotification....................................97 Part2 ServiceNowRESTAPIs Chapter7 GlobalSettingAPIs...............................................101 GlobalSettingsManagementRESTAPIOverview........................102 GetGlobalSettingsInformationLink...................................103 GetGlobalSettingsConfiguration.....................................104 ModifyGlobalSettings..............................................107 ChangeServiceNowOperatingModetoOffline.........................109 ChangeServiceNowOperatingModetoEndCustomerorDirect.............111 TestConnectionwithJSSorServiceNowPartner.........................112 GetAllSNMPConfiguration..........................................113 GetSNMPConfigurationbyID........................................115 AddanSNMPConfiguration..........................................117 UpdateanSNMPConfiguration.......................................119 DeleteanSNMPConfiguration........................................121 Modify SNMP Traps ................................................122 Get SNMP Trap Attributes ...........................................125 GetDetailsofanSNMPTrapAttribute..................................127 GetCoreFileUploadConfiguration....................................129 ModifyaCoreFileConfiguration.......................................131 UpdateCoreFileConfigurationinEndCustomerMode....................133 CheckSFTPConnectionStatus.......................................134 GetDirectiveFileDetails.............................................135 UploadtheDirectiveFile.............................................136 RefreshtheDirectiveFile.............................................137 RestoretheDirectiveFile............................................138 DownloadtheDirectiveFile..........................................139 GetAdvancedGlobalSettingsConfiguration............................139 UpdateAdvancedGlobalSettingsConfiguration.........................142 iv Copyright©2019,JuniperNetworks,Inc. TableofContents Chapter8 Organization APIs ................................................147 OrganizationManagementRESTAPIOverview..........................147 GetAllOrganizationsinServiceNow...................................149 GetanOrganizationbySpecifyingitsSiteName......................151 GetanOrganizationbySpecifyingaPartialSiteName.................152 GetinformationaboutanOrganization.................................153 AddanOrganization................................................156 Check Organization Status ..........................................160 GetInformationAboutSites..........................................161 GetJMBFilterLevelsInfo............................................164 GetCaseSubmissionValues.........................................166 ModifyanOrganization..............................................167 AssociateanAddressGroupwithanOrganization........................170 DeleteanOrganizationbyOrganizationID...............................173 AddanEndCustomerOrganizationinPartnerProxyMode.................174 ModifyanEnd-CustomerOrganizationinPartnerProxyMode...............177 UpdateCoreFileInformationforanEndCustomer........................181 ViewOrganizationMessages.........................................184 Chapter9 Device Group Management APIs ...................................187 DeviceGroupManagementRESTAPIOverview..........................187 CreateaDeviceGroup..............................................188 GetAllDeviceGroups...............................................192 GetInformationAboutaDeviceGroup.................................194 ModifyaDeviceGroup..............................................198 AssociateaDeviceGroupwithDevices.................................201 DeleteaDeviceGroup..............................................204 Chapter10 DeviceManagementAPIs.........................................207 DeviceManagementRESTAPIOverview...............................207 Device Management REST API ...................................207 GetAllDevicesinServiceNow........................................210 GetInformationAboutaDevice.......................................213 ExportallDevices..................................................219 ExportDeviceInventory.............................................220 AddaDevicetoServiceNow.........................................222 AssociateaDevicewithaDeviceGroup................................225 Create On-Demand Incident .........................................227 InstallanEventProfileonaDevice....................................232 UninstallanEventProfilefromaDevice................................235 Request RMA Incident ..............................................237 CreateanOn-DemandDeviceSnapshot................................241 ConfigureAdvancedParameterSettings...............................244 GetCreateOn-DemandincidentJobResults............................246 GetCreateOn-DemandDeviceSnapshotJobResults....................250 GetRequestRMAJobResults........................................252 ConfigureMaintenanceMode........................................255 ViewExposureofaDevice...........................................257 ViewContractInformationforaServiceNowDevice......................259 Copyright©2019,JuniperNetworks,Inc. v ServiceNowandServiceInsightRESTAPIReference DeleteaDevicefromServiceNow.....................................261 Chapter11 EventProfileAPIs................................................263 EventProfileManagementRESTAPIOverview..........................263 GetAllEventProfiles...............................................265 GetInformationAboutanEventProfile................................267 CreateanEventProfile..............................................272 InstallEventProfileonDevices.......................................277 ExportAllEventProfilesbyType.....................................280 ExportEventProfilesbyIDandType...................................282 ImportEventProfilesfromaFile......................................284 GetImportEventProfilesJobDetails..................................287 GetEventProfilesImportJobResults..................................290 CloneanEventProfile..............................................293 SetanEventProfileastheDefaultEventProfile.........................295 Chapter12 Script Bundle APIs ...............................................297 ScriptBundleManagementRESTAPIOverview.........................297 GetAllScriptBundles..............................................298 GetInformationAboutaScriptBundle................................300 GetAllEventScriptsinaScriptBundle................................304 AddaScriptBundletoServiceNow...................................306 SetaScriptBundleastheDefaultScriptBundle.........................308 InstallScriptBundleonaDevice.....................................309 UninstallScriptBundlefromaDevice..................................313 DeleteaScriptBundle..............................................316 Chapter13 IncidentManagementAPIs........................................319 IncidentManagementRESTAPIOverview..............................320 GetAllIncidentsinServiceNow.......................................321 GetanIncidentbyIncidentID........................................325 GetIncidentbyCustomerTrackingNumber.............................339 DeleteanIncidentbyIncidentID......................................342 ExportaJMBintheHTMLorXMLFormat..............................344 Save a Case ......................................................345 SubmitaCase....................................................350 GettheLocationofaCaseinCaseManager............................356 AssignanOwnertoanincident.......................................358 FlaganIncidenttoUsers............................................360 ExporttheSummaryofanIncidenttoExcel............................362 CreateaCaseforanEnd-CustomerIncident............................363 UploadCoreFilesforanIncident.....................................365 GetAttachmentDetailsbyIncidentID.................................367 CloseanEnd-CustomerCase........................................369 UpdateanEnd-CustomerCase.......................................371 UploadAttachmenttoIncidentbyUsingSCP...........................372 UploadAttachmenttoIncidentbyUsingHTTP..........................374 DownloadLogFilesandJMBofanIncident.............................375 DownloadallAttachmentsofanIncident..............................376 DownloadanAttachmentofanIncident...............................377 vi Copyright©2019,JuniperNetworks,Inc. TableofContents GetUser-UploadedAttachmentsbyIncidentID.........................378 DownloadanUser-UploadedAttachmentofanIncident..................379 CollectAdditionalInformationforanIncident...........................380 ModifyConfigurationforCollectingAdditionalInformationforanIncident....382 ViewCommandsUsedforCollectingAdditionalInformationforanIncident..384 GetAllAdditionalInformationAttachmentsofanIncident................386 DownloadanAttachmentContainingAdditionalInformationforanIncident..388 DownloadAllAttachmentsContainingAdditionalInformationforan Incident ......................................................388 GetDetailsAboutCollectAdditionalInformationJobforanIncident.........389 AssociateanIncidenttoanExistingCase...............................391 Chapter14 Incident Filter Management APIs ..................................395 IncidentFilterManagementRESTAPIOverview.........................395 GetAllIncidentFilters..............................................397 GetInformationAboutanIncidentFilter...............................400 CreateaBasicIncidentFilter.........................................406 CreatinganAdvancedIncidentFilter...................................411 EncodingPERLFileofanIncidentFilter.............................411 CreatingtheAdvancedIncidentFilter...............................412 Decoding Perl File ..............................................415 ModifyaBasicIncidentFilter.........................................416 ModifyanAdvancedIncidentFilter....................................421 DeleteAllorSelectedIncidentFilters..................................425 DeleteanIncidentFilter.............................................427 EnableAllorSelectedIncidentFilters.................................428 EnableanIncidentFilter............................................430 DisableAllorSelectedIncidentFilters..................................431 DisableanIncidentFilter............................................433 Reorder Incident Filters .............................................434 ExportAllorSelectedIncidentFilters..................................436 ImportIncidentFilters..............................................438 SuppressedEventManagementRESTAPIOverview.....................439 GetAllSuppressedEvents..........................................440 GetaSuppressedEvent............................................444 DeleteSuppressedEvents...........................................447 CreateIncidentforSuppressedEvents.................................449 ExportaSuppressedEventJMB.......................................451 Chapter15 TechSupportCaseAPIs..........................................453 TechSupportCaseManagementRESTAPIOverview.....................453 GetAllTechSupportCases..........................................454 GetInformationAboutaTechnicalSupportCase........................457 UpdateaTechnicalSupportCasebyCaseID...........................460 UploadAttachmenttoCasebyUsingSCP..............................462 UploadAttachmenttoCasebyUsingHTTP............................464 ViewaTechSupportCaseinCaseManager............................466 CollectAdditionalInformationforaTechnicalSupportCase...............467 ModifyConfigurationforCollectingAdditionalInformationforaTechnical Support Case .................................................469 Copyright©2019,JuniperNetworks,Inc. vii ServiceNowandServiceInsightRESTAPIReference ViewCommandsUsedforCollectingAdditionalInformationforaTechnical Support Case ..................................................471 GetAllAdditionalInformationAttachmentsforaTechnicalSupportCase....473 DownloadanAttachmentContainingAdditionalInformationforaTechnical Support Case .................................................475 DownloadAllAttachmentsContainingAdditionalInformationforaTechnical Support Case .................................................475 GetDetailsAboutCollectAdditionalInformationJobforaTechnicalSupport Case.........................................................476 Chapter16 EndCustomerCaseAPIs..........................................479 ServiceNowEndCustomerCaseManagementRESTAPIOverview.........479 GetAllEnd-customerCases.........................................480 GetInformationAboutanEnd-CustomerCase..........................482 ViewanEnd-CustomerCaseinCaseManager..........................486 GetAllAttachmentsforanEndCustomerCase.........................487 DownloadaSpecificAttachmentforanEndCustomerCase...............489 DownloadAllAttachmentsforanEndCustomerCase....................489 Chapter17 Device Snapshot APIs ............................................491 DeviceSnapshotManagementRESTAPIOverview.......................491 GetAllDeviceSnapshotsinServiceNow...............................492 GetDeviceSnapshotInformationbyDeviceID..........................495 ExportDeviceSnapshotInformationbyDeviceID........................499 GetAttachmentDetailsbyDeviceSnapshotID.........................500 DownloadAllAttachmentsofaDeviceSnapshot........................501 DownloadDeviceSnapshotAttachmentbyID..........................502 DeleteDeviceSnapshotbyDeviceSnapshotID.........................503 GetUploadStatusofDeviceSnapshotAttachments.....................504 ViewDeviceSnapshotsinOriginalorFilteredFormat......................511 GetUser-UploadedAttachmentsforaTechSupportCasebyID.............512 DownloadanUser-UploadedAttachmentofanTechnicalSupportCase.....514 Chapter18 Auto Submit Policy APIs ..........................................515 AutoSubmitPolicyManagementRESTAPIOverview.....................515 GetAllAutoSubmitPoliciesinServiceNow.............................517 GetInformationAboutanAutoSubmitPolicy...........................521 CreateanAutoSubmitPolicy........................................526 ModifyanAutoSubmitPolicy........................................531 AssignanAutoSubmitPolicytoDevices...............................536 GetDevicesAssociatedWithanAutoSubmitPolicy......................538 GetEventsAssociatedwithanAutoSubmitPolicy.......................540 ChangeStatusofanAutoSubmitPolicy...............................544 ChangetheDampeningStatusofanAutoSubmitPolicy..................545 ExportIncidentReportofAutoSubmitPolicies..........................546 DeleteanAutoSubmitPolicy........................................547 Chapter19 AutoSubmitFilterAPIs...........................................549 AutoSubmitFilterManagementRESTAPIOverview.....................549 GetAllAutoSubmitFilters...........................................551 viii Copyright©2019,JuniperNetworks,Inc. TableofContents GetInformationAboutanAutoSubmitFilter............................554 CreateaBasicAutoSubmitFilter.....................................560 CreateanAdvancedAutoSubmitFilter................................566 EncodingPERLFileofanAutoSubmitFilter.........................566 CreatinganAdvancedAutoSubmitFilter...........................567 Decoding Perl File ..............................................571 ModifyaBasicAutoSubmitFilter.....................................572 ModifyanAdvancedAutoSubmitFilter................................577 DeleteanAutoSubmitFilter.........................................581 DeleteAllorSelectedAutoSubmitFilters..............................582 EnableAllorSelectedAutoSubmitFilters..............................584 EnableanAutoSubmitFilter........................................586 DisableAllorSelectedAutoSubmitFilters.............................587 DisableanAutoSubmitFilter........................................589 ReorderAutoSubmitFilters.........................................590 ExportAllorSelectedAutoSubmitFilters..............................592 ImportAutoSubmitFilters..........................................594 Chapter20 Certificate APIs ..................................................597 CertificateManagementRESTAPIOverview............................597 GetAllCertificates.................................................598 GetaCertificatebyCertificateID.....................................600 AddaCertificatetoServiceNow.....................................602 DeleteCertificatebyID.............................................604 Chapter21 AddressGroupAPIs..............................................607 AddressGroupManagementRESTAPIOverview........................607 GetAllAddressGroups.............................................609 GetanAddressGroupbyAddressGroupID..............................611 CreateanAddressGroup............................................614 ModifyanAddressGroup............................................618 AssociateDevicestoanAddressGroup.................................621 RemoveDevicesfromanAddressGroup...............................625 GetAllEndCustomerAddressGroups.................................630 GetEndCustomerAddressGroupsbyID...............................633 Chapter22 JMB Error Management APIs ......................................637 JMBErrorManagementRESTAPIOverview.............................637 GetAllJMBswithErrors.............................................638 GetaJMBwithErrorInformationbyJMBID.............................640 DeleteaJMBwithErrors.............................................641 ExportaJMBwithErrors............................................643 Chapter23 Device Analysis APIs .............................................645 DeviceAnalysisRESTAPIOverview...................................645 Get All BIOS Validations ............................................647 GetBIOSValidationbyID...........................................650 DeleteBIOSValidationbyID.........................................653 ExportAllBIOSValidations..........................................654 ExportBIOSValidationbyID.........................................656 Copyright©2019,JuniperNetworks,Inc. ix ServiceNowandServiceInsightRESTAPIReference ViewBIOSLegalNotice.............................................658 AcceptBIOSLegalNotice...........................................659 ConfigureBIOSValidationOnDevices.................................660 ConfigureBIOSValidationonNewlyDiscoveredDevices..................663 GetAllDevicesinaPHDCConfiguration...............................666 GetAllDevicesHavingPHD.........................................669 GetPHDCConfigurationofaDevicebyPHDDeviceConfigurationID.........672 GetAllPHDsbyPHDDeviceConfigurationID...........................675 ExportAllPHDsbyDeviceID.........................................678 GetPHDbyID.....................................................679 DownloadPHDbyID...............................................683 DeletePHDbyID..................................................684 ExportPHDbyID..................................................686 ExportAllDevicesHavingProductHealthData..........................687 Chapter24 ProductHealthDataCollectionAPIs...............................691 ProductHealthDataCollectionManagementRESTAPIOverview...........691 Get All PHDCs ....................................................693 GetDetailsofaPHDCConfiguration..................................696 CreateaPHDCConfiguration........................................699 ModifyaPHDCConfiguration........................................702 DisableDevicesinaPHDCConfiguration...............................705 Retry PHDC on Devices .............................................707 AbortaPHDCConfiguration.........................................709 DeleteaPHDCConfiguration.........................................710 ExportAllDevicesinaPHDC.........................................712 GetAllPHDsbyPHDCIDandPHDDeviceConfigurationID.................713 ExportAllPHDsbyPHDCIDandPHDDeviceConfigurationID..............717 Chapter25 E-mailTemplateAPIs.............................................721 E-mailTemplateManagementRESTAPIOverview.......................721 GetAllE-mailTemplates............................................722 GetDetailsofanEmailTemplate.....................................724 Modify an E-mail Template ..........................................727 RestoreanE-mailTemplatetoitsDefault..............................729 Chapter26 InformationAPIs.................................................733 InformationManagementRESTAPIOverview...........................733 GetAllInformationMessages........................................734 Get Information Message Details .....................................736 AssignOwnershiptoanInformationMessage...........................739 AssignanInformationMessagetoanEndCustomer......................741 FlaganInformationMessagetoUsers.................................742 DeleteanInformationMessage.......................................744 Chapter27 ServiceNowNotificationAPIs.....................................747 ServiceNowNotificationManagementRESTAPIOverview................747 ChangeStatusofaServiceNowNotification............................748 CopyaServiceNowNotification......................................753 CreateaServiceNowNotification.....................................759 x Copyright©2019,JuniperNetworks,Inc.
Description:The list of books you might like
