Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Export PHD by ID

 

Use this API to export information about a product health data (PHD) file to an Excel file.

URI

https://[host]/api/juniper/servicenow/device-analysis/phds/{phdId}/export (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

phdId

Integer

Yes

ID of the PHD file whose information is to be exported

Consumes

None

Produces

application/octet-stream

The Excel file contains the following fields:

Field

Description

File Name

Name of the PHD file

PHDC Name

Name of the PHDC configuration through which PHD was collected and the PHD files created

Size (Bytes)

Size of the PHD file in Bytes

Received (UTC)

Date and time the PHD was read from the device

Read Status

Status of reading PHD from the device to create PHD file

Possible values:

  • Not Received—Service Now has not yet collected PHD from the device.

  • Success—Service Now has successfully collected PHD from the device.

  • Failure—Service Now failed to collect PHD from the device.

  • No Longer Available—PHD is no longer available on the device.

  • Successfully Deleted—PHD is successfully deleted from the device after collecting by Service Now

  • Reading from Device—Service Now is currently reading PHD from the device.

  • Read Complete—Service Now has completed reading PHD from the device.

  • Processing—Service Now is processing the PHD to create PHD files.

Upload Status

Status of uploading PHD files to Juniper Support System (JSS)

  • Not Uploaded—Service Now has not yet uploaded PHD files to JSS.

  • Success—Service Now has successfully uploaded PHD files to JSS.

  • Failure—Upload of PHD files to JSS failed.

  • Uploading—Service Now is currently uploading PHD files to JSS.

Remarks

Remarks about PHD file

Related Documentation