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 All PHDCs

    Use this API to retrieve all product health data collection (PHDC) configurations present in Junos Space Service Now.

    URI

    https://[host] /api/juniper/servicenow/phdc-management/phdcs (HTTP method = GET)

    Consumes

    None

    Produces

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

    Response Elements

    Element

    Type

    Description

    uri

    String

    Link to the PHDC configuration collection

    size

    Integer

    Number of records in the PHDC collection

    PHDC

    PHDC

    A PHDC configuration

    key

    Integer

    ID of the PHDC configuration

    href

    String

    Link to a PHDC configuration

    domainId

    Integer

    ID of the domain to which the PHDC configuration belongs

    domainName

    String

    Name of the domain to which the PHDC configuration belongs

    name

    String

    Name of the PHDC configuration

    startTime

    String

    Date and time configured in the PHDC configuration to start collecting product health data (PHD) from devices

    endTime

    String

    Date and time configured in the PHDC configuration to end collecting product health data (PHD) from devices

    lastModifiedTime

    String

    Date and time the PHDC configuraiton was last modified

    status

    String

    Status of the PHDC configuration

    Possible values:

    • Scheduled—PHD is scheduled to be collected from all the managed devices assigned to the PHDC configuration at the scheduled time.
    • Starting—PHD collection is starting on all the devices included in the PHDC configuration.
    • Running—PHD is currently being collected from all the devices included in the configuration.
    • Stopping—PHD collection is currently being stopped from one or more devices included in the configuration.
    • Completed—PHD collection is complete on all devices included in the configuration.
    • Aborting—PHD collection is being aborted from all devices included in the configuration.
    • Failed—PHD collection failed to be start on all devices, stop or aborted in one or more devices included in the configuration.
    • Aborted—PHD collection is aborted on all the devices included in the configuration.

    devicesCount

    Integer

    Number of devices included in the PHDC configuration

    createdBy

    String

    Username of user who configured the PHDC configuration

    domainId

    Integer

    ID of the domain to which a PHDC is assigned

    Sample Output

    Sample XML Output

    <phdcs uri="/api/juniper/servicenow/phdc-management/phdcs" size="2">
       <phdc key="35638" uri="/api/juniper/servicenow/phdc-management/phdcs/35638" href="/api/juniper/servicenow/phdc-management/phdcs/35638">
          <domainId>2</domainId>
          <domainName>Global</domainName>
          <name>EX-Group</name>
          <startTime>2015-07-24 23:02:02 UTC</startTime>
          <endTime>2015-08-23 23:02:02 UTC</endTime>
          <lastModifiedTime>2015-07-24 23:02:50 UTC</lastModifiedTime>
          <status>Running</status>
          <devicesCount>2</devicesCount>
          <createdBy>super</createdBy>
           <domainId>10</domainId>
       </phdc>
       <phdc key="35697" uri="/api/juniper/servicenow/phdc-management/phdcs/35697" href="/api/juniper/servicenow/phdc-management/phdcs/35697">
          <domainId>2</domainId>
          <domainName>Global</domainName>
          <name>SRX-Group</name>
          <startTime>2015-07-24 23:29:44 UTC</startTime>
          <endTime>2015-07-26 04:03:17 UTC</endTime>
          <lastModifiedTime>2015-07-24 23:29:44 UTC</lastModifiedTime>
          <status>Aborted</status>
          <devicesCount>1</devicesCount>
          <createdBy>super</createdBy>
    	 <domainId>10</domainId>
       </phdc>
      </phdcs>
    

    Sample JSON Output

    {
      "phdcs": {
        "@uri": "/api/juniper/servicenow/phdc-management/phdcs/",
        "@size": "2",
        "phdc": [
          {
            "@key": "35638",
            "@uri": "/api/juniper/servicenow/phdc-management/phdcs/35638",
            "@href": "/api/juniper/servicenow/phdc-management/phdcs/35638",
            "domainId": 2,
            "domainName": "Global",
            "name": "EX-Group",
            "startTime": "2015-07-24 23:02:02 UTC",
            "endTime": "2015-08-23 23:02:02 UTC",
            "lastModifiedTime": "2015-07-24 23:02:50 UTC",
            "status": "Running",
            "devicesCount": 2,
            "createdBy": "super",
    	   "domainId":"10"
    
          },
          {
            "@key": "35697",
            "@uri": "/api/juniper/servicenow/phdc-management/phdcs/35697",
            "@href": "/api/juniper/servicenow/phdc-management/phdcs/35697",
            "domainId": 2,
            "domainName": "Global",
            "name": "SRX-Group",
            "startTime": "2015-07-24 23:29:44 UTC",
            "endTime": "2015-07-26 04:03:17 UTC",
            "lastModifiedTime": "2015-07-24 23:29:44 UTC",
            "status": "Aborted",
            "devicesCount": 1,
            "createdBy": "super",
    	   "domainId":"10"
    
          }
         ]
        }
    

    Modified: 2016-08-10