API DocsRESTView service

GetView

Retrieves a view.

GET
/api/v1/views/{viewId}

Path Parameters

viewId
Required
string

curl -X GET "<API_URL>/api/v1/views/string" \
  -H "Authorization: Bearer <API_KEY>"

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
  }
}

Previous

DeleteView DELETE

Next

Lists views that apply to assets/runs. GET