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 Create On-Demand Device Snapshot Job Results

    Use this API to retrieve results of create on-demand device snapshot jobs.

    URI

    http:// [host]/api/juniper/servicenow/device-management/devices/job-instances/[job-id]/ create-ondemand-incident-job-results (HTTP method = GET)

    URI Parameters

    Parameter

    Type

    Required

    Description

    job-id

    Integer

    Yes

    ID of the create on-demand device snapshot job

    Consumes

    None

    Produces

    None

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI to the collection of create on-demand device snapshot job results.

    total

    Integer

    Number of job results in the collection

    jobResult

    jobResult

    A create on-demand device snapshot job result

    serviceNowDeviceID

    Integer

    ID of the Service Now device on which on-demand device snapshot was requested

    deviceHostName

    String

    Hostname of the Service Now device

    jobStatus

    Enum

    Status of the create on-demand device snapshot job

    The possible values are:

    • Success
    • Failed
    • Inprogress
    • Not started

    jobRemarks

    String

    Remarks about the create on-demand device snapshot job

    createCase

    Boolean

    Flag to indicate whether or not the device snapshot incident is submitted to JSS for creating a case

    Possible values:

    • true—The on-demand device snapshot incident is submitted for creating a case
    • false—The on-demand device snapshot incident is not submitted for creating a case

    verifyCPUUsage

    Boolean

    Flag to indicate whether or not usage of device CPU must be verified while generating this on-demand device snapshot incident

    Possible values:

    • true—CPU usage is verified
    • false—CPU usage is not verified

    Sample Output

    Sample XML Output

    <create-ondemand-device-snapshot-job-results uri="/api/juniper/servicenow/device-management/devices/job-instances/5472256/ create-ondemand-device-snapshot-job-results" total="1">
    	<jobResult>
    		<serviceNowDeviceID>7340140</serviceNowDeviceID>
    		<deviceHostName>mx-480-sn1</deviceHostName>
    		<jobStatus>SUCCESS</jobStatus>
    		<jobRemarks>
    On-demand JMB was generated for device and will be available in the Incidents table under Service Central.
    		</jobRemarks>
    		<createCase>true</createCase>
    		<verifyCPUUsage>true</verifyCPUUsage>
    	</jobResult>
    </create-ondemand-device-snapshot-job-results>
    

    Sample JSON Output

    {
      "create-ondemand-device-snapshot-job-results": {
        "uri": "/api/juniper/servicenow/device-management/devices/job-instances/5472256/ create-ondemand-device-snapshot-job-results",
        "total": "1",
        "jobResult": {
          "serviceNowDeviceID": "7340140",
          "deviceHostName": "mx-480-sn1",
          "jobStatus": "SUCCESS",
          "jobRemarks": "
    On-demand JMB was generated for device and will be available in the Incidents table under Service Central.
    ",
          "createCase": "true",
          "verifyCPUUsage": "true"
        }
      }
    }
    

    Modified: 2016-08-09