Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Modify Global Settings

    Use this API to modify the global settings configured in Junos Space Service Now.

    URI

    https://[host]/api/juniper/servicenow/global-setting-management/updateGlobalSettings (HTTP method = PUT)

    Consumes

    • application/vnd.juniper.servicenow.global-setting-management.globalSettings+ xml;version=1;charset=UTF-8
    • application/vnd.juniper.servicenow.global-setting-management.globalSettings+ json;version=1;charset=UTF-8

    Request Elements

    Element

    Type

    Description

    outboundEmailAddress

    String

    E-mail address used for sending e-mails or notifications

    dampeningPeriod

    String

    Time period for which no incidnet is created in Service Now when the same event recurs on the device

    deviceSnapshotPurgeTimeInDays

    String

    Number of days for which device snapshots are stored in the Service Now database before they are deleted

    notSubmittedIncidentPurgeTime

    Integer

    Number of days incidents submitted to JSS are stored in the Service Now database before they are deleted

    submittedIncidentPurgeTime

    Integer

    Number of days incidents that are not submitted to JSS are stored in the Service Now database before they are deleted

    collectLogFiles

    Boolean

    Flag to specify if log files should be collected from all devices

    Possible values:

    • true—Log files are collected from all devices in Service Now
    • false—Log files are not collected from any device in Service Now

    shareProfileInformation

    Boolean

    Flag to specify if Service Now-related information should be shared with JSS for tracking purposes

    Possible values:

    • true—Service Now-related information is shared with JSS
    • false—Service Now-related information is not shared with JSS

    Note: This element is not available in Offline mode.

    connectionStatus

    String

    Status of connection between Service Now and Juniper Support System (JSS) or Service Now partner (in case of End Customer mode)

    Possible values—Success, or the reason for connection failure

    maxDaysForAutoSubmitIncident

    Integer

    Number of days after which an incident is not submitted to JSS by using autosubmit policies

    Produces

    • application/vnd.juniper.servicenow.global-setting-management.servicenowmsg +xml;version=1
    • application/vnd.juniper.servicenow.global-setting-management.servicenowmsg +json;version=1

    Response Elements

    Element

    Type

    Description

    msg

    String

    Status message of the modify global settings job

    Sample Input

    Sample XML Input

    <globalSettings>
    <outboundEmailAddress>servicenow@juniper.net</outboundEmailAddress>
    <dampeningPeriod>None</dampeningPeriod>
    <deviceSnapshotPurgeTimeInDays>60</deviceSnapshotPurgeTimeInDays>
    <notSubmittedIncidentPurgeTime>120</notSubmittedIncidentPurgeTime>
    <submittedIncidentPurgeTime>120</submittedIncidentPurgeTime>
    <collectLogFiles>true</collectLogFiles>
    <shareProfileInformation>true</shareProfileInformation>
    <maxDaysForIncidentSubmissionInAutoSubmitPolicy>3</maxDaysForIncidentSubmissionInAutoSubmitPolicy>
    </globalSettings>

    Sample JSON Input

    {
       "globalSettings": {
          "outboundEmailAddress": "servicenow@juniper.net",
          "dampeningPeriod": "None",
          "deviceSnapshotPurgeTimeInDays": "60",
          "notSubmittedIncidentPurgeTime": "120",
          "submittedIncidentPurgeTime": "120",
          "collectLogFiles": "false",
          "shareProfileInformation": "true",
          "maxDaysForIncidentSubmissionInAutoSubmitPolicy": "3"
       }
    }

    Sample Output

    Sample XML Output

    <servicenowmsg>
    <msg>Global Settings updated successfully</msg>
    </servicenowmsg>
    

    Sample JSON Output

    {
      "servicenowmsg": { "msg": "Global Settings updated successfully" }
    }
    

    Modified: 2016-08-11