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 an Auto Submit Policy

    Use this API to modify an auto submit policy.

    Note: You cannot modify the name of an auto submit policy.

    URI

    https://[host]/api/juniper/servicenow/autosubmit-policy-management/ autosubmitpolicies/{id}/modify (HTTP method = POST)

    Consumes

    • application/vnd.juniper.servicenow.autosubmit-policy-management. modifyAutoSubmitPolicy+xml;version=1;charset=UTF-8
    • application/vnd.juniper.servicenow.autosubmit-policy-management. modifyAutoSubmitPolicy+json;version=1;charset=UTF-8

    Request Elements

    Element

    Type

    Description

    devices

    devices

    Collection of devices to which the auto submit policy is applied

    device

    device

    A device to which the auto submit policy is applied

    uri

    String

    URI of the device

    href

    String

    Link to the device

    events

    event

    Collection of events for which the auto submit policy is applied

    allEvents

    Boolean

    Indicates if all the events should be included in the auto submit policy.

    Possible values:

    • true—All events that are supported by AI-Scripts are included in the auto submit policy.
    • false—All events that are supported by AI-Scripts are not included in the auto submit policy.

      If you set false for this option, you must specify the IDs of the events that you want to include in the auto submit policy.

    event

    event

    Event for which the auto submit policy is applied

    Note: This element need not be configured If allEvent element is set to true.

    id

    Integer

    ID of the event

    dampening

    String

    Dampening status of the event

    Possible values:

    • NONE—An Incident is created in Service Now for each occurrence of the event.
    • ALWAYS—No incident is created in Service Now after the first occurrence of the event.
    • Dampening interval—Time interval (between 1 hr to 120 hrs) for which an incident is not created for the event when the event recurs on a device.

    filters

    filter

    Collection of filters that are applied to the auto submit policy

    filter

    event

    A filter applied to the auto submit policy

    id

    Integer

    ID of the filter applied to the auto submit policy

    submitCaseOptions

    submitCaseOptions

    Options to submit an incident for creating a case in Juniper Support System (JSS)

    followUpMethod

    String

    Method to be used for follow-up of the case

    Possible values:

    • EMAIL_FULL_TEXT
    • EMAIL_SECURE_LINK
    • PHONE_CALL

    priority

    String

    Priority of the submitted incident

    Possible values—None, Critical, High, Medium, and Low

    associatedCoreFile

    Boolean

    Flag to indicate if the incident is created because of issues with the core file

    Possible values:

    • true—Incident is created because of issues with the core file
    • false—Incident is not created because of issues with the core file

    uploadCoreFiles

    Boolean

    Flag to indicate if the core files should be uploaded to JSS or Service Now Partner

    • true—Core files are uploaded to JSS or Service Now Partner
    • false—Core files are not uploaded to Service Now Partner

    synopsisComments

    String

    Synopsis of the event

    descriptionComments

    String

    Description of the event

    caseCCList

    caseCCList

    Collection of e-mail IDs to which the incident should be copied while submitting to JSS

    email

    String

    E-mail ID of users to whom incident should be copied while submitting to JSS

    domainId

    Integer

    ID of the domain to which the auto submit policy is to be created

    This is an optional element. If no domain ID is provided, the auto submit policy is created in the Global domain.

    Note: The create request fails if a user does not have access to the Global domain and if no domain ID is provided with the create request.

    Produces

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

    Response Elements

    Element

    Type

    Description

    msg

    String

    Status message of the modify auto submit policy job

    Sample Input

    Sample XML Input

    <autoSubmitPolicy>
     
       <devices>
          <device uri="/api/juniper/servicenow/device-management/devices/590809" href="/api/juniper/servicenow/device-management/devices/590809" />
       </devices>
       <events>
          <allEvents>true</allEvents>
          <event>
             <id>32770</id>
             <dampening>HR1</dampening>
          </event>
         </events>
       <filters>
    	<filter>
    	     <id>841243</id>
    	</filter>	
       </filters>
    
       <submitCaseOptions>
          <followUpMethod>EMAIL_FULL_TEXT</followUpMethod>
          <priority>Low</priority>
          <associatedCoreFile>true</associatedCoreFile>
          <uploadCoreFiles>false</uploadCoreFiles>
          <synopsisComments>synComm</synopsisComments>
          <descriptionComments>descComm</descriptionComments>
          <caseCCList>
             <email>test@test.com</email>
          </caseCCList>
       </submitCaseOptions>
    </autoSubmitPolicy>
    

    Sample JSON Input

    {
       "autoSubmitPolicy": {
          "devices": {
             "device": {
                "uri": "/api/juniper/servicenow/device-management/devices/590809",
                "href": "/api/juniper/servicenow/device-management/devices/590809"
             }
          },
          "events": {
             "allEvents": "true",
             "event": {
                "id": "32770",
                "dampening": "HR1"
             }
          },
          "filters": {
             "filter": {
                "id": "841243"
             }
          },
          "submitCaseOptions": {
             "followUpMethod": "EMAIL_FULL_TEXT",
             "priority": "Low",
             "associatedCoreFile": "true",
             "uploadCoreFiles": "false",
             "synopsisComments": "synComm",
             "descriptionComments": "descComm",
             "caseCCList": {
                "email": "test@test.com"
             }
          }
       }
    }
    

    Sample Output

    Sample XML Output

    <servicenowmsg>
    <msg>Policy modified successfully</msg>
    </servicenowmsg>
    

    Sample JSON Output

    {
       "servicenowmsg": {
          "msg": "Policy modified successfully"
       }
    }
    

    Modified: 2017-08-02