Skip to main content
PATCH
/
api
/
v1
/
panel-configurations
/
{panelConfiguration.panelConfigurationId}
UpdatePanelConfiguration
curl --request PATCH \
  --url https://your-sift-api-url.com/api/v1/panel-configurations/{panelConfiguration.panelConfigurationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "panelConfiguration": {
    "versionId": "<string>",
    "version": 123,
    "changeMessage": "<string>",
    "name": "<string>",
    "panelType": "PANEL_TYPE_UNSPECIFIED",
    "channelConfigurations": [
      {
        "name": "<string>",
        "type": "PLOTTED_CHANNEL_TYPE_UNSPECIFIED",
        "color": "<string>",
        "channelSettings": {},
        "bitFieldIndex": 123,
        "bitFieldElement": {
          "name": "<string>",
          "index": 123,
          "bitCount": 123
        },
        "expression": "<string>",
        "expressionChannelReferences": [
          "<string>"
        ]
      }
    ],
    "chartSettings": {},
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "archivedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>"
  },
  "updateMask": "<string>"
}'
{
  "panelConfiguration": {
    "panelConfigurationId": "<string>",
    "versionId": "<string>",
    "version": 123,
    "changeMessage": "<string>",
    "name": "<string>",
    "panelType": "PANEL_TYPE_UNSPECIFIED",
    "channelConfigurations": [
      {
        "name": "<string>",
        "type": "PLOTTED_CHANNEL_TYPE_UNSPECIFIED",
        "color": "<string>",
        "channelSettings": {},
        "bitFieldIndex": 123,
        "bitFieldElement": {
          "name": "<string>",
          "index": 123,
          "bitCount": 123
        },
        "expression": "<string>",
        "expressionChannelReferences": [
          "<string>"
        ]
      }
    ],
    "chartSettings": {},
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "archivedDate": "2023-11-07T05:31:56Z",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
panelConfiguration.panelConfigurationId
string
required

Body

application/json

The request for a call to PanelConfigurationService_UpdatePanelConfiguration to update a panel configuration. Updating a panel configuration creates a new version of the panel configuration, leaving the previous untouched. If no update is deemed necessary, then the the current version is returned. To archive panel configuration, specify archived_date in the update mask as well as a non-null value for archived_date in the panel_configuration object. To unarchive a panel configuration, specify archived_date in the update mask and a null value for archived_date in the panel_configuration object.

​
panelConfiguration
object
required

The panel configuration to update.

​
updateMask
string
required

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

Response

A successful response.

​
panelConfiguration
object