Function getSharingTasks

Parameters

• query: {
      appid?: string;
      excludeDeleting?: boolean;
      limit?: number;
      next?: string;
      offset?: number;
      owner?: string;
      ownername?: string;
      page?: string;
      prev?: string;
      role?: ("owner" | "recipient")[];
      sort?: (
          | "status"
          | "type"
          | "name"
          | "sent"
          | "+status"
          | "-status"
          | "-name"
          | "+name"
          | "scheduled"
          | "enabled"
          | "-datecreated"
          | "datecreated"
          | "+datecreated"
          | "-ownername"
          | "ownername"
          | "+ownername"
          | "-enabled"
          | "+enabled"
          | "+type"
          | "-type"
          | "-sent"
          | "+sent"
          | "-scheduled"
          | "+scheduled"
          | "-appname"
          | "appname"
          | "+appname"
          | "-appid"
          | "appid"
          | "+appid"
      )[];
      templateId?: string[];
      type?: (
          | "chart-monitoring"
          | "chart-sharing"
          | "sheet-sharing"
          | "template-sharing"
      )[];
  }

  an object with query parameters

  • Optionalappid?: string

    the filter by sharing task resource app id. TenantAdmin users may omit this parameter to list all sharing-tasks in the tenant.

  • OptionalexcludeDeleting?: boolean

    Indicates if task with the status DELETING should be excluded from the list

  • Optionallimit?: number

    Limit the returned result set

  • Optionalnext?: string

    Deprecated

    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

  • Optionalowner?: string

    the filter by sharing task resource owner id.

  • Optionalownername?: string

    the filter by sharing task resource owner name.

  • Optionalpage?: string

    The cursor to the page of data.

  • Optionalprev?: string

    Deprecated

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

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

    the filter by sharing task resource role.

  • Optionalsort?: (
        | "status"
        | "type"
        | "name"
        | "sent"
        | "+status"
        | "-status"
        | "-name"
        | "+name"
        | "scheduled"
        | "enabled"
        | "-datecreated"
        | "datecreated"
        | "+datecreated"
        | "-ownername"
        | "ownername"
        | "+ownername"
        | "-enabled"
        | "+enabled"
        | "+type"
        | "-type"
        | "-sent"
        | "+sent"
        | "-scheduled"
        | "+scheduled"
        | "-appname"
        | "appname"
        | "+appname"
        | "-appid"
        | "appid"
        | "+appid"
    )[]

    Sort the returned result set by the specified field

  • OptionaltemplateId?: string[]

    array of template ids to filter by

  • Optionaltype?: ("chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing")[]

    the filter by sharing task resource type. If type is template-sharing only and user is not tenant admin, appid is also required.

• Optionaloptions: ApiCallOptions