API DocsRESTCalculated channel service

GetCalculatedChannel

Retrieve the latest version of a calculated channel.

GET
/v2/organizations/{organizationId}/calculated-channels/{clientKey}

Path Parameters

organizationId
Required
string

clientKey
Required
string

Query Parameters

calculatedChannelIdstring

curl -X GET "<API_URL>/v2/organizations/string/calculated-channels/string?calculatedChannelId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "calculatedChannel": {
    "calculatedChannelId": "string",
    "organizationId": "string",
    "clientKey": "string",
    "archivedDate": "2019-08-24T14:15:22Z",
    "versionId": "string",
    "version": 0,
    "name": "string",
    "description": "string",
    "changeMessage": "string",
    "userNotes": "string",
    "units": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "calculatedChannelConfiguration": {
      "assetConfiguration": {
        "allAssets": true,
        "selection": {
          "assetIds": [
            "string"
          ],
          "tagIds": [
            "string"
          ]
        }
      },
      "queryConfiguration": {
        "sel": {
          "expression": "string",
          "expressionChannelReferences": [
            {
              "channelReference": "string",
              "channelIdentifier": "string"
            }
          ]
        }
      }
    },
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "functionDependencies": [
      {
        "userDefinedFunctionVersionId": "string"
      }
    ]
  }
}

Previous

GetCalculatedChannel GET

Next

ListCalculatedChannelVersions GET