API DocsRESTUser defined function service

GetUserDefinedFunctionDependents

Retrieve dependents of a user defined function.

GET
/api/v1/user-defined-functions/dependents

Query Parameters

pageSizeinteger

Format: "int64"

userDefinedFunctionIdstring

userDefinedFunctionNamestring

userDefinedFunctionVersionIdstring

curl -X GET "<API_URL>/api/v1/user-defined-functions/dependents?pageSize=0&userDefinedFunctionId=string&userDefinedFunctionName=string&userDefinedFunctionVersionId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "userDefinedFunctions": [
    {
      "userDefinedFunctionId": "string",
      "name": "string",
      "archivedDate": "2019-08-24T14:15:22Z",
      "userDefinedFunctionVersionId": "string",
      "version": 0,
      "description": "string",
      "changeMessage": "string",
      "userNotes": "string",
      "expression": "string",
      "functionInputs": [
        {
          "identifier": "string",
          "dataType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
          "constant": true
        }
      ],
      "functionOutputType": "FUNCTION_DATA_TYPE_UNSPECIFIED",
      "functionDependencies": [
        {
          "userDefinedFunctionVersionId": "string"
        }
      ],
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string"
    }
  ],
  "nextPageTokenUserDefinedFunction": "string",
  "calculatedChannels": [
    {
      "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"
        }
      ]
    }
  ],
  "nextPageTokenCalculatedChannel": "string",
  "rules": [
    {
      "ruleId": "string",
      "assetId": "string",
      "name": "string",
      "description": "string",
      "isEnabled": true,
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "organizationId": "string",
      "conditions": [
        {
          "ruleConditionId": "string",
          "ruleId": "string",
          "expression": {
            "singleChannelComparison": {
              "channelComponent": "string",
              "channelName": "string",
              "comparator": "CONDITION_COMPARATOR_UNSPECIFIED",
              "double": 0.1,
              "string": "string",
              "lastValue": {}
            },
            "calculatedChannel": {
              "channelReferences": {
                "property1": {
                  "name": "string",
                  "component": "string"
                },
                "property2": {
                  "name": "string",
                  "component": "string"
                }
              },
              "expression": "string",
              "functionDependencies": [
                {
                  "userDefinedFunctionVersionId": "string"
                }
              ]
            }
          },
          "createdDate": "2019-08-24T14:15:22Z",
          "modifiedDate": "2019-08-24T14:15:22Z",
          "createdByUserId": "string",
          "modifiedByUserId": "string",
          "actions": [
            {
              "ruleActionId": "string",
              "ruleConditionId": "string",
              "actionType": "ACTION_KIND_UNSPECIFIED",
              "configuration": {
                "notification": {
                  "recipientUserIds": [
                    "string"
                  ]
                },
                "annotation": {
                  "tagIds": [
                    "string"
                  ],
                  "annotationType": "ANNOTATION_TYPE_UNSPECIFIED",
                  "assignedToUserId": "string"
                }
              },
              "createdDate": "2019-08-24T14:15:22Z",
              "modifiedDate": "2019-08-24T14:15:22Z",
              "createdByUserId": "string",
              "modifiedByUserId": "string",
              "ruleActionVersionId": "string"
            }
          ],
          "ruleConditionVersionId": "string"
        }
      ],
      "ruleVersion": {
        "ruleId": "string",
        "ruleVersionId": "string",
        "version": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "createdByUserId": "string",
        "versionNotes": "string",
        "generatedChangeMessage": "string",
        "deletedDate": "2019-08-24T14:15:22Z"
      },
      "clientKey": "string",
      "assetConfiguration": {
        "assetIds": [
          "string"
        ],
        "tagIds": [
          "string"
        ]
      },
      "contextualChannels": {
        "channels": [
          {
            "name": "string",
            "component": "string"
          }
        ]
      },
      "deletedDate": "2019-08-24T14:15:22Z",
      "isExternal": true
    }
  ],
  "nextPageTokenRule": "string"
}