Function getDataAlerts

  • Retrieves all data alert tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.

    Parameters

    • query: {
          appID?: string;
          conditionId?: string;
          limit?: number;
          next?: string;
          offset?: number;
          ownerId?: string;
          ownerName?: string;
          prev?: string;
          role?: ("owner" | "recipient" | "notowner")[];
          sort?: (
              | "status"
              | "name"
              | "+status"
              | "-status"
              | "-name"
              | "+name"
              | "enabled"
              | "-datecreated"
              | "datecreated"
              | "+datecreated"
              | "-ownername"
              | "ownername"
              | "+ownername"
              | "lasttrigger"
              | "-lasttrigger"
              | "+lasttrigger"
              | "lastscan"
              | "-lastscan"
              | "+lastscan"
              | "-enabled"
              | "+enabled"
              | "nextexecutiontime"
              | "-nextexecutiontime"
              | "+nextexecutiontime"
          )[];
          status?: ("INVALID_RECIPIENT" | "INVALID_OWNER" | "DISABLED" | "VALID")[];
      }

      an object with query parameters

      • OptionalappID?: string

        The app ID you would like to filter by

      • OptionalconditionId?: string

        The conditionId you would like to filter by

      • Optionallimit?: number

        Limit the returned result set

      • Optionalnext?: string

        The cursor to the next page of data. Only one of next or previous may be specified.

      • Optionaloffset?: number

        Offset for finding a list of entities - used for pagination

      • OptionalownerId?: string

        The id of the owner you would like to filter by

      • OptionalownerName?: string

        The name of the owner you would like to filter by

      • Optionalprev?: string

        The cursor to the previous page of data. Only one of next or previous may be specified.

      • Optionalrole?: ("owner" | "recipient" | "notowner")[]

        The role you would like to filter by

      • Optionalsort?: (
            | "status"
            | "name"
            | "+status"
            | "-status"
            | "-name"
            | "+name"
            | "enabled"
            | "-datecreated"
            | "datecreated"
            | "+datecreated"
            | "-ownername"
            | "ownername"
            | "+ownername"
            | "lasttrigger"
            | "-lasttrigger"
            | "+lasttrigger"
            | "lastscan"
            | "-lastscan"
            | "+lastscan"
            | "-enabled"
            | "+enabled"
            | "nextexecutiontime"
            | "-nextexecutiontime"
            | "+nextexecutiontime"
        )[]

        Sort the returned result set by the specified field

      • Optionalstatus?: ("INVALID_RECIPIENT" | "INVALID_OWNER" | "DISABLED" | "VALID")[]

        The status you would like to filter by

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetDataAlertsHttpResponse>

    GetDataAlertsHttpError