Sift | Docs
APIReferenceREST (HTTP/JSON)Panel configuration service

CreatePanelConfiguration

Creates a panel configuration.

POST
/api/v1/panel-configurations

Request Body

application/jsonRequired

name
Required
string

panelType
Required
string

Default: "PANEL_TYPE_UNSPECIFIED"Value in: "PANEL_TYPE_UNSPECIFIED" | "PANEL_TYPE_TIMESERIES" | "PANEL_TYPE_TABLE" | "PANEL_TYPE_FFT" | "PANEL_TYPE_GEO_MAP" | "PANEL_TYPE_SCATTER_PLOT" | "PANEL_TYPE_FILE_VIEWER" | "PANEL_TYPE_HISTOGRAM"

channelConfigurations
Required
array<object>

chartSettingsobject

curl -X POST "<API_URL>/api/v1/panel-configurations" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "panelType": "PANEL_TYPE_UNSPECIFIED",
    "channelConfigurations": [
      {
        "name": "string",
        "type": "PLOTTED_CHANNEL_TYPE_UNSPECIFIED",
        "color": "string",
        "channelSettings": {},
        "bitFieldIndex": 0,
        "bitFieldElement": {
          "name": "string",
          "index": 0,
          "bitCount": 0
        },
        "expression": "string",
        "expressionChannelReferences": [
          "string"
        ]
      }
    ],
    "chartSettings": {}
  }'

A successful response.

{
  "panelConfiguration": {
    "panelConfigurationId": "string",
    "versionId": "string",
    "version": 0,
    "changeMessage": "string",
    "name": "string",
    "panelType": "PANEL_TYPE_UNSPECIFIED",
    "channelConfigurations": [
      {
        "name": "string",
        "type": "PLOTTED_CHANNEL_TYPE_UNSPECIFIED",
        "color": "string",
        "channelSettings": {},
        "bitFieldIndex": 0,
        "bitFieldElement": {
          "name": "string",
          "index": 0,
          "bitCount": 0
        },
        "expression": "string",
        "expressionChannelReferences": [
          "string"
        ]
      }
    ],
    "chartSettings": {},
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "archivedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string"
  }
}

Previous

ListNotifications GET

Next

GetPanelConfiguration GET