Function getReportTemplates

  • Get descriptive info for the specified templates.

    Parameters

    • query: {
          limit?: number;
          name?: string;
          ownerId?: string;
          skip?: number;
          sort?: (
              | "type"
              | "name"
              | "-name"
              | "+name"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
              | "createdAt"
              | "updatedAt"
              | "+type"
              | "-type"
          )[];
          sourceAppId?: string;
      }

      an object with query parameters

      • Optionallimit?: number

        If present, restrict the number of returned items to this value.

      • Optionalname?: string

        Template name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix.

      • OptionalownerId?: string

        Return the templates for the specified owner.

      • Optionalskip?: number

        If present, skip this number of the returned values in the result set (facilitates paging).

      • Optionalsort?: (
            | "type"
            | "name"
            | "-name"
            | "+name"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "createdAt"
            | "updatedAt"
            | "+type"
            | "-type"
        )[]

        Field to sort by. Prefix with +/- to indicate ascending/descending. By default, the sort order is ascending.

      • OptionalsourceAppId?: string

        Return the templates that are using the specified app as data source.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetReportTemplatesHttpResponse>

    GetReportTemplatesHttpError