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

UpdatePanelConfiguration

Updates an existing panel configuration using using the list of fields specified in `update_mask`.

PATCH
/api/v1/panel-configurations/{panelConfiguration.panelConfigurationId}

Request Body

application/jsonRequired

panelConfiguration
Required
The panel configuration to update.

The panel configuration to update.

updateMask
Required
string

The list of fields to be updated. The fields available to be updated are name, panel_type, channel_configurations, and chart_settings.

Path Parameters

panelConfiguration.panelConfigurationId
Required
string

curl -X PATCH "<API_URL>/api/v1/panel-configurations/string" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "panelConfiguration": {
      "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"
    },
    "updateMask": "string"
  }'

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

ListPanelConfigurations GET

Next

Ping Service_ Ping GET