Retrieval /api/4 Documentation

HTTP API documentation

Limitations

These services currently only serve data from the sf-databuffer backend.

Currently available functionality:

• Query binned data
• Search channel

Query binned data

Method: GET

URL: https://data-api.psi.ch/api/4/binned

Query parameters:

• channelBackend (e.g. "sf-databuffer")
• channelName (e.g. "SLAAR-LSCP4-LAS6891:CH7:1")
• begDate (e.g. "2021-05-26T07:10:00.000Z")
• endDate (e.g. "2021-05-26T07:16:00.000Z")
• binCount (e.g. "6")

Request header: "Accept" must be "application/json"

CURL example:

curl -H 'Accept: application/json' 'https://data-api.psi.ch/api/4/binned?channelBackend=sf-databuffer
  &channelName=SLAAR-LSCP4-LAS6891:CH7:1&begDate=2021-05-25T00:00:00.000Z&endDate=2021-05-26T00:00:00.000Z&binCount=3'

Partial result

If the requested range takes longer time to retrieve, then a partial result with at least one bin is returned.

The partial result will contain the necessary information to send another request with a range that starts with the first not-yet-retrieved bin.

This information is provided by the continueAt and missingBins fields.

This enables the user agent to start the presentation to the user while updating the user interface as new bins are received.

Example:

{
  "continueAt": "2021-05-25T16:00:00.000Z",
  "missingBins": 2,
  "avgs": [
    340.87640380859375,
    340.7442321777344,
    340.58685302734375,
    341.04608154296875
  ],
  "counts": [
    143076,
    143077,
    143076,
    143076
  ],
  "maxs": [
    452,
    452,
    459,
    458
  ],
  "mins": [
    231,
    240,
    239,
    239
  ],
  "tsBinEdges": [
    "2021-05-25T00:00:00.000Z",
    "2021-05-25T04:00:00.000Z",
    "2021-05-25T08:00:00.000Z",
    "2021-05-25T12:00:00.000Z",
    "2021-05-25T16:00:00.000Z"
  ]
}

Complete result

If the result does not contain a continueAt key then the result is complete.

Finalised range

If the server can determine that no more data will be added to the requested time range then it will add the flag finalisedRange: true to the response.

Search channel

Method: GET

URL: https://data-api.psi.ch/api/4/search/channel

Query parameters:

• nameRegex (e.g. "LSCP.*6")
• sourceRegex (e.g. "178:9999")
• descriptionRegex (e.g. "celsius")

Request header: "Accept" must be "application/json"

CURL example:

curl -H 'Accept: application/json' 'https://data-api.psi.ch/api/4/search/channel?sourceRegex=CV.E.+37&nameRegex=120.+y2$'

Example result

{
  "channels": [
    {
      "name": "S10MA01-DBPM120:Y2",
      "source": "tcp://S20-CVME-DBPM2371:9000",
      "type": "Float32",
      "shape": [],
      "unit": "",
      "description": ""
    },
    {
      "name": "S20SY02-DBPM120:Y2",
      "source": "tcp://S20-CVME-DBPM2371:9000",
      "type": "Float32",
      "shape": [],
      "unit": "",
      "description": ""
    }
  ]
}

Feedback and comments very much appreciated!

dominik.werder@psi.ch

or please assign me a JIRA ticket.