Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Get PHD by ID

    Use this API to retrieve metadata information about a product health data (PHD) file.

    URI

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

    URI Parameters

    Parameter

    Type

    Required

    Description

    phdId

    Integer

    Yes

    ID of the PHD file for which metadata information is to be retrieved

    Consumes

    None

    Produces

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

    Response Elements

    Element

    Type

    Description

    uri

    String

    URI of the PHD file

    id

    Integer

    ID of the PHD file

    method

    String

    Method applicable to the PHD file

    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

    fileName

    String

    Name of the collected PHD file

    fileSize

    Integer

    Size of the PHDC 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:

    • 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

    String

    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.

    Sample Output

    Sample XML Output

    <phd uri="/api/juniper/servicenow/device-analysis/phds/65539">
       <id>65539</id>
       <method href="/api/juniper/servicenow/device-analysis/phds/65539/download"/>
       <method href="/api/juniper/servicenow/device-analysis/phds/65539/export"/>
       <device href="/api/juniper/servicenow/device-management/devices/35116" key="35116"/>
       <phdc href="/api/juniper/servicenow/phdc-management/phdcs/35638" key="35638"/>
       <phdConfiguration href="/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643" key="35643"/>
       <fileName>ex-4200-sn1_phdc_jmb_ais_health_20150402_135541.txt</fileName>
       <fileSize>N/A</fileSize>
       <receivedTime>2015-07-25 00:08:15 UTC</receivedTime>
       <readStatus>Success</readStatus>
       <uploadStatus>Success</uploadStatus>
    </phd>
    

    Sample JSON Output

    {
      "phd": {
        "@uri": "/api/juniper/servicenow/device-analysis/phds/65539",
        "id": 65539,
        "method": [
          {
            "@href": "/api/juniper/servicenow/device-analysis/phds/65539/download"
          },
          {
            "@href": "/api/juniper/servicenow/device-analysis/phds/65539/export"
          }
        ],
        "device": {
          "@href": "/api/juniper/servicenow/device-management/devices/35116",
          "@key": "35116"
        },
        "phdc": {
          "@href": "/api/juniper/servicenow/phdc-management/phdcs/35638",
          "@key": "35638"
        },
        "phdConfiguration": {
          "@href": "/api/juniper/servicenow/device-analysis/phdDeviceConfigurations/35643",
          "@key": "35643"
        },
        "fileName": "ex-4200-sn1_phdc_jmb_ais_health_20150402_135541.txt",
        "fileSize": "N/A",
        "receivedTime": "2015-07-25 00:08:15 UTC",
        "readStatus": "Success",
        "uploadStatus": "Success"
      }
    }
    

    Modified: 2016-08-10