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

    Get Information About an Auto Submit Policy

    Use this API to retrieve a specific auto submit policy from Junos Space Service Now.

    URI

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

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the auto submit policy for which information is to be retrieved

    Consumes

    None

    Produces

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

    Response

    Element

    Type

    Description

    uri

    String

    URI of the auto submit policy

    key

    Integer

    ID of the auto submit policy

    incidentsSubmitted

    InIeger

    Number of incidents submitted through this auto submit policy.

    devices

    Integer

    Number of devices associated with the auto submit policy.

    events

    Integer

    Number of events associated with the auto submit policy.

    name

    String

    Auto submit policy name.

    createdBy

    String

    Username of person that created this auto submit policy.

    enabled

    Boolean

    Flag to indicate whether or not the auto submit policy can be used to submit incidents to JSS or Service Now partner automatically

    Possible values:

    • true—The auto submit policy is can be used to submit incidents
    • false—The auto submit policy cannot be used to submit incidents

    dampeningEnabled

    Boolean

    Flag to indicate whether or not incidents that are created for recurring events should be ignored

    Possible values:

    • true—Incidents generated for recurring events are ignored
    • false—Incidents generated for recurring events are submitted to JSS or Serivce Now partner

    method

    String

    Method applicable to the auto submit policy

    devices

    device

    Collection of devices to which the auto submit policy is applied

    device

    device

    A device to which the auto submit policy is applied

    id

    Integer

    Device unique identifier

    hostName

    String

    Device hostname

    events

    event

    Collection of events included in the auto submit policy

    uri

    String

    Link to the collection of events included in the auto submit policy

    size

    Integer

    Number of events in the collection

    domainId

    Integer

    ID of the domain in which the auto submit policy is created

    Sample Output

    Sample XML Output

    <autosubmitpolicy uri="/api/juniper/servicenow/autosubmit-policy-management/ autosubmitpolicies/720896" key=”720896”> 
            <incidentsSubmitted>0</incidentsSubmitted>
            <devices>3</devices>
            <events>5</events>
            <name>test1</name>
            <createdBy>super</createdBy>
            <enabled>true</enabled>
            <dampeningEnabled>true</dampeningEnabled>
    	   <domainId>10</domainId>
            <method href="/api/juniper/servicenow/ autosubmitpolicies/720896/associateDevices" rel="Associate auto submit case to devices"/>
            <devices uri="/api/juniper/servicenow/autosubmit-policy-management/ autosubmitpolicies/720896/devices">
                    <device href="/api/juniper/servicenow/device-management/devices/360448">
                            <id>360448</id>
                            <hostName>EX4200.24T.180</hostName>
                    </device>
                    <device href="/api/juniper/servicenow/device-management/devices/360449">
                            <id>360449</id>
                            <hostName>ex-4200.50.182</hostName>
                    </device>
            </devices>
            <events uri="/api/juniper/servicenow/autosubmit-policy-management/autosubmitpolicies /720896/events">
    </autosubmitpolicy>
    

    Sample JSON Output

    {
        "autosubmitpolicy":{
            "@uri":"/api/juniper/servicenow/autosubmit-policy-management/ autosubmitpolicies/720896",
            "@key":"720896",
            "incidentssubmitted":"0",
            "devices":{
                "@size":"3",
                "@uri":"/api/juniper/servicenow/autosubmit-policy-management/ autosubmitpolicies/720896/devices",
                "device":[
                     {
                         "@href":"/api/juniper/servicenow/device-management/devices/360448",
                         "id":"360448",
                         "hostname":"EX4200.24T.180"
                     },
                     {
                         "@href":"/api/juniper/servicenow/device-management/devices/360449",
                         "id":"360449",
                         "hostname":"ex-4200.50.182"
                     }
                ]
            },
            "events":{
                "@size":"5",
                "@uri":"/api/juniper/servicenow/autosubmit-policy-management/autosubmitpolicies 	/720896/events"
             },
            "name":"test1",
            "createdby":"super",
            "enabled":"true",
            “dampeningEnabled”:”true”
     	   "domainId":"10"
            "method":{
                "@href":"/api/juniper/servicenow/autosubmitpolicies/720896/associateDevices",
                "rel":"Associate auto submit case to devices"
            }
        }
    

    Response Status Code

    Message

    Description

    204 Not Found

    Invalid auto submit policy ID specified

    Modified: 2016-08-10