Jump to

• Request
• Response
• Examples

Get current HDR collections status

get

/rest/{version}/statistics/collections

Retrieves the current status of all Historical Data Records (HDR) collections and push receivers.

This API is only available for SBC and ESBC.

Request

Path Parameters

• version:
  REST API version string.
  Available values: v1.2

Header Parameters

• Authorization:
  The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

Back to Top

Response

200 Response

OK - Requested data is returned in response body

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

404 Response

Resource not found

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get current HDR collections status by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.1/statistics/collections"

Example of Accessing the API with Python

The following example shows how to get current HDR collections status by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/v1.1/statistics/collections"
resp = requests.get(url, headers=headers)

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <collectionStatus>
      <status>running</status>
      <groups>
        <group>
          <name>temperature</name>
          <bootState>disabled</bootState>
          <startTime>now</startTime>
          <endTime>never</endTime>
        </group>
      </groups>
      <push>
        <nextPush>2019-01-16T09:01:05-0500</nextPush>
        <subsequentPushMinutes>5</subsequentPushMinutes>
      </push>
      <pushReceivers>
        <pushReceiver>
          <address>10.4.4.4</address>
          <state>reachable</state>
        </pushReceiver>
      </pushReceivers>
    </collectionStatus>
  </data>
  <messages/>
  <links/>
</response>

Back to Top