Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get All PHDs by PHDC ID and PHD Device Configuration ID

 

Use this API to retrieve metadata information of product health data (PHD) collected from a device identified by the device’s PHD Device configuration ID, that is part of a Product Health Data Collection (PHDC) configuration, identified by the its PHDC ID.

URI

https://[host]/api/juniper/servicenow/phdc-management/phdcs/{phdcId} /phdDeviceConfigurations/{phdDeviceConfigurationId}/phds (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

phdcid

Integer

Yes

ID of the PHDC configuration through which the PHD was collected

phdDeviceConfigurationsId

Integer

Yes

ID of the device in the PHDC configuration from which the PHD was collected

Consumes

None

Produces

  • application/vnd.juniper.servicenow.device-analysis.phds+json;version=1

  • application/vnd.juniper.servicenow.device-analysis.phds+xml;version=1

Response Elements

Element

Type

Description

uri

String

URI of the PHD collection

size

Integer

Number of records present in the collection

device

Device

Device from which the PHD was collected

href

String

Link to the device

key

Integer

ID of the device

phdc

PHDC

PHDC configuration through which the PHD was collected

href

String

Link to the PHDC

key

Integer

ID of the PHDC

phdDeviceConfiguration

phdDeviceConfiguration

PHDC configuration of the device from which PHD was collected

href

String

Link to the PHDC configuration of the device

key

Integer

ID of the PHDC configuration of the device

phd

phd

A PHD file

key

Integer

Unique ID of the PHD

href

String

Link to the PHD file

fileName

String

Name of the PHD file

fileSize

Integer

Size of the PHD file in Bytes

receivedTime

String

Date and time the PHD file was received

readStatus

String

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.

uploadStatus

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.

phdcName

Name of the PHDC configuration through which the PHD was collected

Sample Output

Sample XML Output

Sample JSON Output