Skip to main content
POST
/
api
/
v2
/
calculated-channels
CreateCalculatedChannel
curl --request POST \
  --url https://your-sift-api-url.com/api/v2/calculated-channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "userNotes": "<string>",
  "units": "<string>",
  "clientKey": "<string>",
  "calculatedChannelConfiguration": {
    "assetConfiguration": {
      "allAssets": true,
      "selection": {
        "assetIds": [
          "<string>"
        ],
        "tagIds": [
          "<string>"
        ]
      }
    },
    "queryConfiguration": {
      "sel": {
        "expression": "<string>",
        "expressionChannelReferences": [
          {
            "channelReference": "<string>",
            "channelIdentifier": "<string>"
          }
        ]
      }
    }
  },
  "metadata": [
    {
      "key": {
        "name": "<string>",
        "type": "METADATA_KEY_TYPE_UNSPECIFIED",
        "archivedDate": "2023-11-07T05:31:56Z"
      },
      "stringValue": "<string>",
      "numberValue": 123,
      "booleanValue": true,
      "archivedDate": "2023-11-07T05:31:56Z"
    }
  ]
}'
{
  "calculatedChannel": {
    "calculatedChannelId": "<string>",
    "organizationId": "<string>",
    "clientKey": "<string>",
    "archivedDate": "2023-11-07T05:31:56Z",
    "versionId": "<string>",
    "version": 123,
    "name": "<string>",
    "description": "<string>",
    "changeMessage": "<string>",
    "userNotes": "<string>",
    "units": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "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>"
      }
    ],
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "inapplicableAssets": [
    {
      "assetId": "<string>",
      "assetName": "<string>",
      "tagNames": [
        "<string>"
      ],
      "missingChannels": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
calculatedChannelConfiguration
object
required
metadata
object[]
required
description
string
userNotes
string
units
string
clientKey
string

Response

A successful response.

calculatedChannel
object
required
inapplicableAssets
object[]
required