Get All PHDs by PHD Device Configuration ID
Use this API to retrieve metadata information of product health data (PHD) collected from a device.
URI
https://[host]/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/ {phdDeviceConfigurationsId}/phds (HTTP method = GET)
URI Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
phdDeviceConfigurationsId | Integer | Yes | ID of the device in a PHDC configuration from which PHD metadata information is to be retrieved |
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 |
device | String | Device from which the PHD was collected |
phd | phd | A PHD file |
key | Integer | ID of 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 created |
readStatus | String | Status of reading PHD from the device to create PHD file Possible values:
|
uploadStatus | String | Status of uploading PHD files to Juniper Support System (JSS)
|
phdcName | String | Name of the PHDC configuration through which the PHD was collected |
Sample Output
Sample XML Output
<phds uri="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643/phds" size="2">
<device href="/api/juniper/servicenow/device-management/devices/35116" key="35116"/>
<phd key="917811" href="/api/juniper/servicenow/device-analysis/phds/917811">
<fileName>ex-4200-sn1_phdc_jmb_ais_health_20150404_102011.txt</fileName>
<fileSize>N/A</fileSize>
<receivedTime>2015-07-26 20:32:43 UTC</receivedTime>
<readStatus>Not Received</readStatus>
<uploadStatus>Not Uploaded</uploadStatus>
<phdcName>EX-Group</phdcName>
</phd>
<phd key="917845" href="/api/juniper/servicenow/device-analysis/phds/917845">
<fileName>ex-4200-sn1_phdc_jmb_ais_health_20150404_112009.txt</fileName>
<fileSize>N/A</fileSize>
<receivedTime>2015-07-26 21:32:45 UTC</receivedTime>
<readStatus>Not Received</readStatus>
<uploadStatus>Not Uploaded</uploadStatus>
<phdcName>EX-Group</phdcName>
</phd>
Sample JSON Output
{
"phds": {
"@uri": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643/phds",
"@size": "2",
"device": {
"@href": "/api/juniper/servicenow/device-management/devices/35116",
"@key": "35116"
},
"phd": [
{
"@key": "917811",
"@href": "/api/juniper/servicenow/device-analysis/phds/917811",
"fileName": "ex-4200-sn1_phdc_jmb_ais_health_20150404_102011.txt",
"fileSize": "N/A",
"receivedTime": "2015-07-26 20:32:43 UTC",
"readStatus": "Not Received",
"uploadStatus": "Not Uploaded",
"phdcName": "EX-Group"
},
{
"@key": "917845",
"@href": "/api/juniper/servicenow/device-analysis/phds/917845",
"fileName": "ex-4200-sn1_phdc_jmb_ais_health_20150404_112009.txt",
"fileSize": "N/A",
"receivedTime": "2015-07-26 21:32:45 UTC",
"readStatus": "Not Received",
"uploadStatus": "Not Uploaded",
"phdcName": "EX-Group"
},
]
}
}