Skip to main content
POST
/
api
/
v2
/
calculated-channels
/
resolve
ResolveCalculatedChannel
curl --request POST \
  --url https://your-sift-api-url.com/api/v2/calculated-channels/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": {
    "id": "<string>",
    "clientKey": "<string>"
  },
  "calculatedChannelConfiguration": {
    "assetConfiguration": {
      "allAssets": true,
      "selection": {
        "assetIds": [
          "<string>"
        ],
        "tagIds": [
          "<string>"
        ]
      }
    },
    "queryConfiguration": {
      "sel": {
        "expression": "<string>",
        "expressionChannelReferences": [
          {
            "channelReference": "<string>",
            "channelIdentifier": "<string>"
          }
        ]
      }
    }
  },
  "organizationId": "<string>",
  "assets": {
    "ids": {
      "ids": [
        "<string>"
      ]
    },
    "names": {
      "names": [
        "<string>"
      ]
    }
  },
  "run": {
    "id": "<string>",
    "clientKey": "<string>"
  }
}
'
{
  "resolved": [
    {
      "assetName": "<string>",
      "expressionRequest": {
        "expression": "<string>",
        "channelReferences": {},
        "expressionChannelReferences": [
          {
            "channelReference": "<string>",
            "channelId": "<string>"
          }
        ],
        "functionDependencies": [
          {
            "userDefinedFunctionVersionId": "<string>"
          }
        ]
      },
      "outputDataType": "CHANNEL_DATA_TYPE_UNSPECIFIED",
      "assetId": "<string>"
    }
  ],
  "unresolved": [
    {
      "assetName": "<string>",
      "errorMessage": "<string>"
    }
  ],
  "calculatedChannelId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

The request for a call to CalculatedChannelService_ResolveCalculatedChannel to get the all possible calculated channels.

  1. If the calculated channel has a selection of assets and tags then those assets will be used as a base and then filtered down by the given assets and assets from the run.
  2. If the calculated channel is enabled for all assets then: a) If the request has run and assets from the run will be used as a base and then filtered down by the given assets. b) If the request has run and no assets then those assets will be used. c) If the request has only assets then those assets will be used. The organization_id argument is only required if using client_key and the user belongs to multiple organizations.

The request for a call to CalculatedChannelService_ResolveCalculatedChannel to get the all possible calculated channels.

  1. If the calculated channel has a selection of assets and tags then those assets will be used as a base and then filtered down by the given assets and assets from the run.
  2. If the calculated channel is enabled for all assets then: a) If the request has run and assets from the run will be used as a base and then filtered down by the given assets. b) If the request has run and no assets then those assets will be used. c) If the request has only assets then those assets will be used. The organization_id argument is only required if using client_key and the user belongs to multiple organizations.
​
identifier
object
​
calculatedChannelConfiguration
object
​
organizationId
string

This field is only required if your user belongs to multiple organizations.

​
assets
object
​
run
object

Response

A successful response.

The response of a call to CalculatedChannelService_ResolveCalculatedChannel.

​
resolved
object[]
required

All resolved calculated channels.

​
unresolved
object[]
required

All assets with any issues in resolution.

​
calculatedChannelId
string

If provided in the request, the calculated channel resolved.