API DocsRESTView service

UpdateView

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

PATCH
/api/v1/views/{view.viewId}

Request Body

application/jsonRequired

viewobject

updateMaskstring

The list of fields to update.

Path Parameters

view.viewId
Required
string

curl -X PATCH "<API_URL>/api/v1/views/string" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "view": {
      "name": "string",
      "axisGroups": {
        "left": [
          "string"
        ],
        "right": [
          "string"
        ]
      },
      "channels": [
        {
          "name": "string",
          "component": "string",
          "dataType": "string",
          "axisGroup": "string",
          "bitFieldNames": [
            "string"
          ],
          "calculatedChannelConfig": {
            "channelKey": "string",
            "channelReferences": {
              "property1": {
                "name": "string",
                "component": "string"
              },
              "property2": {
                "name": "string",
                "component": "string"
              }
            },
            "expression": "string",
            "unit": "string"
          }
        }
      ],
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "organizationId": "string",
      "modifiedByUserId": "string",
      "isPinned": true
    },
    "updateMask": "string"
  }'

A successful response.

{
  "view": {
    "viewId": "string",
    "name": "string",
    "axisGroups": {
      "left": [
        "string"
      ],
      "right": [
        "string"
      ]
    },
    "channels": [
      {
        "name": "string",
        "component": "string",
        "dataType": "string",
        "axisGroup": "string",
        "bitFieldNames": [
          "string"
        ],
        "calculatedChannelConfig": {
          "channelKey": "string",
          "channelReferences": {
            "property1": {
              "name": "string",
              "component": "string"
            },
            "property2": {
              "name": "string",
              "component": "string"
            }
          },
          "expression": "string",
          "unit": "string"
        }
      }
    ],
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "organizationId": "string",
    "modifiedByUserId": "string",
    "isPinned": true
  }
}