Get Request RMA Job Results
Use this API to retrieve results of Request Materials Authorization (RMA) jobs.
URI
http:// [host]/api/juniper/servicenow/device-management/devices/job-instances/[job-id]/ request-rma-job-results (HTTP method = GET)
URI Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
job-id | Integer | Yes | ID of the request RMA job |
Consumes
None
Produces
None
Response Elements
Element | Type | Description |
|---|---|---|
uri | String | URI of the collection of request RMA job results |
total | Integer | Number of results present in the collection |
jobResult | jobResulttring | A request RMA job result |
serviceNowDeviceID | Integer | ID of the Service Now device for which RMA was requested |
deviceHostName | String | Hostname of the device |
profileName | String | Name of the event profile installed on the device |
caseCCList | caseCCList | Collection of e-mail IDs of users who should be notified about the RMA incident |
String | E-mail ID of a userS | |
synopsis | String | Synopsis of the request RMA job |
problemDescription | String | Description of the request RMA job |
jobStatus | Enum | Status of the request RMA job The possible values are:
|
selectedDeviceComponents | String | Components of the device for which RMA is requested |
addressGroupId | String | ID of the address group to which the RMA is addressed |
createCase | Boolean | Flag to indicate whether or not the request RMA incident is submitted to JSS for creating a case Possible values:
|
collectLogFiles | Boolean | Flag to indicate whether or not log files should be collected for this request RMA incident Possible values:
|
verifyCPUUsage | Boolean | Flag to indicate whether or not usage of device CPU must be verified while generating this request RMA incident Possible values:
|
Sample Output
Sample XML Output
<request-rma-job-results uri="/api/juniper/servicenow/device-management/devices/job-instances/5373984/ request-rma-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> <selectedDeviceComponents> Routing Engine 0 Model Number: EX2200-24T-4G Routing Engine 0 Part Number: 750-026468 (REV 13) Routing Engine 0 SerialNumber: CW0210402769 CW0210402769 Routing Engine 0 Description: EX2200-24T-4G FPC 0 Model Number: EX2200-24T-4G FPC 0 Part Number: 750-026468 (REV 13) FPC 0 SerialNumber: CW0210402769 FPC 0 Description: EX2200-24T-4G </selectedDeviceComponents> <addressGroupId>0</addressGroupId> <createCase>true</createCase> <collectLogFiles>false</collectLogFiles> <verifyCPUUsage>true</verifyCPUUsage> </jobResult> </request-rma-job-results>
Sample JSON Output
{
"request-rma-job-results": {
"uri": "/api/juniper/servicenow/device-management/devices/job-instances/5373984/ request-rma-job-results", "total": "1",
"jobResult": {
"serviceNowDeviceID": "7340140",
"deviceHostName": "mx-480-sn1",
"profileName": "General",
"priority": "CRITICAL",
"synopsis": " These are my synopsis comments here ",
"problemDescription": " These are my customer comments here ",
"jobStatus": "INPROGRESS",
"selectedDeviceComponents": "
Routing Engine 0 Model Number: EX2200-24T-4G Routing Engine 0 Part Number: 750-026468 (REV 13) Routing Engine 0 SerialNumber: CW0210402769 CW0210402769 Routing Engine 0 Description: EX2200-24T-4G FPC 0 Model Number: EX2200-24T-4G FPC 0 Part Number: 750-026468 (REV 13) FPC 0 SerialNumber: CW0210402769 FPC 0 Description: EX2200-24T-4G
",
"addressGroupId": "0",
"createCase": "true",
"collectLogFiles": "false",
"verifyCPUUsage": "true"
}
}
}