API DocsRESTView service

Lists views that apply to assets/runs.

GET
/api/v1/views:applicable

Query Parameters

pageSizeinteger

The maximum number of views to return. The service may return fewer than this value. If unspecified, at most 50 views 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 ListApplicableViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListApplicableViews must match the call that provided the page token.

assetIdsarray<string>

runIdsarray<string>

curl -X GET "<API_URL>/api/v1/views:applicable?pageSize=0&pageToken=string&assetIds=%5B%0A++%22string%22%0A%5D&runIds=%5B%0A++%22string%22%0A%5D" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

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

Previous

GetView GET

Next

ListViews GET