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

ListPanelConfigurations

Retrieves panel configurations using an optional filter.

GET
/api/v1/panel-configurations

Query Parameters

pageSizeinteger

The maximum number of panel configurations to return. The service may return fewer than this value. If unspecified, at most 50 panel configurations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListPanelConfigurations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPanelConfigurations must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string Available fields to filter by are 'name', 'created_date', and 'modified_date'. For further information about how to use CELs, please refer to this guide.

orderBystring

How to order the retrieved panel configurations. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name. If left empty, items are ordered by name in ascending order (alphabetical). For more information about the format of this field, read this Example: "name"

curl -X GET "<API_URL>/api/v1/panel-configurations?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "panelConfigurations": [
    {
      "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"
    }
  ],
  "nextPageToken": "string"
}

Previous

GetPanelConfiguration GET

Next

UpdatePanelConfiguration PATCH