TechLibrary

Table of Contents

Guide That Contains This Content

[+] Expand All

[-] Collapse All

Get Create On-Demand incident Job Results

Use this API to retrieve results of create on-demand incident 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 incident job.

Consumes

None

Produces

None

Response Elements

Element	Type	Description
uri	String	URI to the collection of create on-demand incident job results
total	Integer	Number of job results in the collection
jobResult	jobResult	A create on-demand incident job result
serviceNowDeviceID	Integer	ID of the Service Now device on which on-demand incident was requested
deviceHostName	String	Hostname of the device
profileName	String	Name of the event profile installed on the device
caseCCList	caseCCList	List of e-mail IDs of users who should be notified about the on-demand incident
email	String	List of e-mail IDs of users who should be notified about the on-demand incident.
priority	Enum	Priority of the on-demand incident. The possible values are: Critical High Medium Low
synopsis	String	Synopsis of the incident
problemDescription	String	Description of the incident
jobStatus	Enum	Status of the create on-demand incident job The possible values are: Success Failed Inprogress Not started
jobRemarks	String	Remarks about the create on-demand incident job
createCase	Boolean	Flag to indicate whether or not the incident is submitted to JSS for creating a case Possible values: true—The on-demand incident is submitted for creating a case false—The on-demand incident is not submitted for creating a case
collectLogFiles	Boolean	Flag to indicate whether or not log files should be collected for this on-demand incident Possible values: true—Log files are collected for the on-demand incident false—Log files are not collected for the on-demand incident
verifyCPUUsage	Boolean	Flag to indicate whether or not usage of device CPU must be verified while generating this on-demand incident Possible values: true—CPU usage is verified false—CPU usage is not verified

Sample Output

Sample XML Output

<create-ondemand-incident-job-results uri="/api/juniper/servicenow/device-management/devices/job-instances/5472256/ create-ondemand-incident-job-results" total="1">
<jobResult>
	<serviceNowDeviceID>7340140</serviceNowDeviceID>
	<deviceHostName>mx-480-sn1</deviceHostName>
	<profileName>General</profileName>
	<caseCCList>
		<email>apathodia@juniper.net</email>
		<email>biruk@juniper.net</email>
	</caseCCList>
	<priority>CRITICAL</priority>
	<synopsis> These are my synopsis comments here </synopsis>
	<problemDescription> These are my customer comments here </problemDescription>
	<jobStatus>INPROGRESS</jobStatus>
	<jobRemarks>
On-demand JMB was generated for device and will be available in the Incidents table under Service Central. Attachments/Log files generation is under process.
	</jobRemarks>
	<createCase>true</createCase>
	<collectLogFiles>true</collectLogFiles>
	<verifyCPUUsage>true</verifyCPUUsage>
</jobResult>
</create-ondemand-incident-job-results>

Sample JSON Output

{
  "create-ondemand-incident-job-results": {
    "uri": "/api/juniper/servicenow/device-management/devices/job-instances/5472256/ create-ondemand-incident-job-results",
    "total": "1",
    "jobResult": {
      "serviceNowDeviceID": "7340140",
      "deviceHostName": "mx-480-sn1",
      "profileName": "General",
      "caseCCList": {
        "email": [
          "apathodia@juniper.net",
          "biruk@juniper.net"
        ]
      },
      "priority": "CRITICAL",
      "synopsis": " These are my synopsis comments here ",
      "problemDescription": " These are my customer comments here ",
      "jobStatus": "INPROGRESS",
      "jobRemarks": "
On-demand JMB was generated for device and will be available in the Incidents table under Service Central. Attachments/Log files generation is under process.
",
      "createCase": "true",
      "collectLogFiles": "true",
      "verifyCPUUsage": "true"
    }
  }
}

TechLibrary

Related Documentation

Get Create On-Demand incident Job Results

Related Documentation

Modified: 2016-08-10