Interface SharingTasksAPI

interface SharingTasksAPI {
    cancelSharingTask: (
        taskId: string,
        options?: ApiCallOptions,
    ) => Promise<CancelSharingTaskHttpResponse>;
    clearCache: () => void;
    configureSharingTasksSettings: (
        body: APISettingsUpload,
        options?: ApiCallOptions,
    ) => Promise<ConfigureSharingTasksSettingsHttpResponse>;
    createSharingTask: (
        body: SharingTaskRecurringCreateRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateSharingTaskHttpResponse>;
    deleteSharingTask: (
        taskId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteSharingTaskHttpResponse>;
    executeSharingTasks: (
        body: SharingActionsTriggerCreateRequest,
        options?: ApiCallOptions,
    ) => Promise<ExecuteSharingTasksHttpResponse>;
    getSharingTask: (
        taskId: string,
        query: { isViewChart?: boolean },
        options?: ApiCallOptions,
    ) => Promise<GetSharingTaskHttpResponse>;
    getSharingTaskExecution: (
        taskId: string,
        executionId: string,
        query: { status?: "failed" | "cancelled" | "successful" },
        options?: ApiCallOptions,
    ) => Promise<GetSharingTaskExecutionHttpResponse>;
    getSharingTaskExecutionFile: (
        taskId: string,
        executionId: string,
        fileAlias: string,
        query: { status?: "failed" | "cancelled" | "successful" },
        options?: ApiCallOptions,
    ) => Promise<GetSharingTaskExecutionFileHttpResponse>;
    getSharingTaskExecutions: (
        taskId: string,
        query: {
            limit?: number;
            next?: string;
            offset?: number;
            prev?: string;
            sort?: ("starttime" | "-starttime" | "+starttime")[];
            status?: "failed" | "successful";
        },
        options?: ApiCallOptions,
    ) => Promise<GetSharingTaskExecutionsHttpResponse>;
    getSharingTasks: (
        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"
            )[];
        },
        options?: ApiCallOptions,
    ) => Promise<GetSharingTasksHttpResponse>;
    getSharingTasksSettings: (
        options?: ApiCallOptions,
    ) => Promise<GetSharingTasksSettingsHttpResponse>;
    patchSharingTask: (
        taskId: string,
        body: SharingTaskPatchRequestCompliantList,
        options?: ApiCallOptions,
    ) => Promise<PatchSharingTaskHttpResponse>;
    updateSharingTasksSettings: (
        body: SharingSettingsPatchCompliantList,
        options?: ApiCallOptions,
    ) => Promise<UpdateSharingTasksSettingsHttpResponse>;
}

Index

Properties

cancelSharingTask clearCache configureSharingTasksSettings createSharingTask deleteSharingTask executeSharingTasks getSharingTask getSharingTaskExecution getSharingTaskExecutionFile getSharingTaskExecutions getSharingTasks getSharingTasksSettings patchSharingTask updateSharingTasksSettings

Properties

cancelSharingTask

cancelSharingTask: (
taskId: string,
options?: ApiCallOptions,
) => Promise<CancelSharingTaskHttpResponse>

Requests cancellation of an execution of the specified recurring sharing task.

Type Declaration

- (
  taskId: string,
  options?: ApiCallOptions,
  ): Promise<CancelSharingTaskHttpResponse>
- Requests cancellation of an execution of the specified recurring sharing task.
  Parameters
  - taskId: string
    The sharing task identifier.
  - Optionaloptions: ApiCallOptions
  Returns Promise<CancelSharingTaskHttpResponse>
  Throws
  CancelSharingTaskHttpError

Param: taskId

The sharing task identifier.

Throws

CancelSharingTaskHttpError

clearCache

clearCache: () => void

Clears the cache for sharing-tasks api requests.

Type Declaration

- (): void
- Clears the cache for sharing-tasks api requests.
  
  Returns void

configureSharingTasksSettings

configureSharingTasksSettings: (
body: APISettingsUpload,
options?: ApiCallOptions,
) => Promise<ConfigureSharingTasksSettingsHttpResponse>

Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.

Type Declaration

- (
  body: APISettingsUpload,
  options?: ApiCallOptions,
  ): Promise<ConfigureSharingTasksSettingsHttpResponse>
- Updates the settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.
  Parameters
  - body: APISettingsUpload
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<ConfigureSharingTasksSettingsHttpResponse>
  Throws
  ConfigureSharingTasksSettingsHttpError

Param: body

an object with the body content

Throws

ConfigureSharingTasksSettingsHttpError

createSharingTask

createSharingTask: (
body: SharingTaskRecurringCreateRequest,
options?: ApiCallOptions,
) => Promise<CreateSharingTaskHttpResponse>

Creates a new recurring sharing task.

Type Declaration

- (
  body: SharingTaskRecurringCreateRequest,
  options?: ApiCallOptions,
  ): Promise<CreateSharingTaskHttpResponse>
- Creates a new recurring sharing task.
  Parameters
  - body: SharingTaskRecurringCreateRequest
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<CreateSharingTaskHttpResponse>
  Throws
  CreateSharingTaskHttpError

Param: body

an object with the body content

Throws

CreateSharingTaskHttpError

deleteSharingTask

deleteSharingTask: (
taskId: string,
options?: ApiCallOptions,
) => Promise<DeleteSharingTaskHttpResponse>

Deletes a specific sharing task.

Type Declaration

- (
  taskId: string,
  options?: ApiCallOptions,
  ): Promise<DeleteSharingTaskHttpResponse>
- Deletes a specific sharing task.
  Parameters
  - taskId: string
    The sharing task identifier.
  - Optionaloptions: ApiCallOptions
  Returns Promise<DeleteSharingTaskHttpResponse>
  Throws
  DeleteSharingTaskHttpError

Param: taskId

The sharing task identifier.

Throws

DeleteSharingTaskHttpError

executeSharingTasks

executeSharingTasks: (
body: SharingActionsTriggerCreateRequest,
options?: ApiCallOptions,
) => Promise<ExecuteSharingTasksHttpResponse>

Requests execution of the specified recurring sharing task.

Type Declaration

- (
  body: SharingActionsTriggerCreateRequest,
  options?: ApiCallOptions,
  ): Promise<ExecuteSharingTasksHttpResponse>
- Requests execution of the specified recurring sharing task.
  Parameters
  - body: SharingActionsTriggerCreateRequest
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<ExecuteSharingTasksHttpResponse>
  Throws
  ExecuteSharingTasksHttpError

Param: body

an object with the body content

Throws

ExecuteSharingTasksHttpError

getSharingTask

getSharingTask: (
    taskId: string,
    query: { isViewChart?: boolean },
    options?: ApiCallOptions,
) => Promise<GetSharingTaskHttpResponse>

Returns the details of a specific sharing task.

Type Declaration

- (
      taskId: string,
      query: { isViewChart?: boolean },
      options?: ApiCallOptions,
  ): Promise<GetSharingTaskHttpResponse>
- Returns the details of a specific sharing task.
  Parameters
  - taskId: string
    The sharing task identifier.
  - query: { isViewChart?: boolean }
    an object with query parameters
    - OptionalisViewChart?: boolean
      Determines whether to update the lastViewed property for the sharing task, which is used to determine whether the sharing task is still in use. If set to true, this will be updated to current time.
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetSharingTaskHttpResponse>
  Throws
  GetSharingTaskHttpError

Param: taskId

The sharing task identifier.

Param: query

an object with query parameters

Throws

GetSharingTaskHttpError

getSharingTaskExecution

getSharingTaskExecution: (
    taskId: string,
    executionId: string,
    query: { status?: "failed" | "cancelled" | "successful" },
    options?: ApiCallOptions,
) => Promise<GetSharingTaskExecutionHttpResponse>

Retrieves a specific sharing task execution.

Type Declaration

- (
      taskId: string,
      executionId: string,
      query: { status?: "failed" | "cancelled" | "successful" },
      options?: ApiCallOptions,
  ): Promise<GetSharingTaskExecutionHttpResponse>
- Retrieves a specific sharing task execution.
  Parameters
  - taskId: string
    The sharing task identifier.
  - executionId: string
    The execution identifier. If value is "latest", the latest execution will be returned
  - query: { status?: "failed" | "cancelled" | "successful" }
    an object with query parameters
    - Optionalstatus?: "failed" | "cancelled" | "successful"
      Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution.
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetSharingTaskExecutionHttpResponse>
  Throws
  GetSharingTaskExecutionHttpError

Param: taskId

The sharing task identifier.

Param: executionId

The execution identifier. If value is "latest", the latest execution will be returned

Param: query

an object with query parameters

Throws

GetSharingTaskExecutionHttpError

getSharingTaskExecutionFile

getSharingTaskExecutionFile: (
    taskId: string,
    executionId: string,
    fileAlias: string,
    query: { status?: "failed" | "cancelled" | "successful" },
    options?: ApiCallOptions,
) => Promise<GetSharingTaskExecutionFileHttpResponse>

Retrieves the file content for the requested execution and file type.

Type Declaration

- (
      taskId: string,
      executionId: string,
      fileAlias: string,
      query: { status?: "failed" | "cancelled" | "successful" },
      options?: ApiCallOptions,
  ): Promise<GetSharingTaskExecutionFileHttpResponse>
- Retrieves the file content for the requested execution and file type.
  Parameters
  - taskId: string
    The sharing task identifier.
  - executionId: string
    The execution identifier.
  - fileAlias: string
    The execution identifier. If value is "latest", the latest execution will be returned
  - query: { status?: "failed" | "cancelled" | "successful" }
    an object with query parameters
    - Optionalstatus?: "failed" | "cancelled" | "successful"
      Filter by status. If not present then no filtering is done on the status. This is only relevant when requesting latest execution.
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetSharingTaskExecutionFileHttpResponse>
  Throws
  GetSharingTaskExecutionFileHttpError

Param: taskId

The sharing task identifier.

Param: executionId

The execution identifier.

Param: fileAlias

The execution identifier. If value is "latest", the latest execution will be returned

Param: query

an object with query parameters

Throws

GetSharingTaskExecutionFileHttpError

getSharingTaskExecutions

getSharingTaskExecutions: (
    taskId: string,
    query: {
        limit?: number;
        next?: string;
        offset?: number;
        prev?: string;
        sort?: ("starttime" | "-starttime" | "+starttime")[];
        status?: "failed" | "successful";
    },
    options?: ApiCallOptions,
) => Promise<GetSharingTaskExecutionsHttpResponse>

Lists executions for the specified sharing task.

Type Declaration

- (
      taskId: string,
      query: {
          limit?: number;
          next?: string;
          offset?: number;
          prev?: string;
          sort?: ("starttime" | "-starttime" | "+starttime")[];
          status?: "failed" | "successful";
      },
      options?: ApiCallOptions,
  ): Promise<GetSharingTaskExecutionsHttpResponse>
- Lists executions for the specified sharing task.
  Parameters
  - taskId: string
    The sharing task identifier.
  - query: {
        limit?: number;
        next?: string;
        offset?: number;
        prev?: string;
        sort?: ("starttime" | "-starttime" | "+starttime")[];
        status?: "failed" | "successful";
    }
    an object with query parameters
    - 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 pagination - how many elements to skip
    - Optionalprev?: string
      The cursor to the previous page of data. Only one of next or previous may be specified.
    - Optionalsort?: ("starttime" | "-starttime" | "+starttime")[]
      Sort the returned result set by the specified field
    - Optionalstatus?: "failed" | "successful"
      Specifies a filter for a particular field and value of an execution
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetSharingTaskExecutionsHttpResponse>
  Throws
  GetSharingTaskExecutionsHttpError

Param: taskId

The sharing task identifier.

Param: query

an object with query parameters

Throws

GetSharingTaskExecutionsHttpError

getSharingTasks

getSharingTasks: (
    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"
        )[];
    },
    options?: ApiCallOptions,
) => Promise<GetSharingTasksHttpResponse>

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

Type Declaration

- (
      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"
          )[];
      },
      options?: ApiCallOptions,
  ): Promise<GetSharingTasksHttpResponse>
- Retrieves all sharing tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.
  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
  Returns Promise<GetSharingTasksHttpResponse>
  Throws
  GetSharingTasksHttpError

Param: query

an object with query parameters

Throws

GetSharingTasksHttpError

getSharingTasksSettings

getSharingTasksSettings: (
options?: ApiCallOptions,
) => Promise<GetSharingTasksSettingsHttpResponse>

Retrieves the current settings for sharing tasks, reports, and other related configuration.

Type Declaration

- (options?: ApiCallOptions): Promise<GetSharingTasksSettingsHttpResponse>
- Retrieves the current settings for sharing tasks, reports, and other related configuration.
  Parameters
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetSharingTasksSettingsHttpResponse>
  Throws
  GetSharingTasksSettingsHttpError

Throws

GetSharingTasksSettingsHttpError

patchSharingTask

patchSharingTask: (
    taskId: string,
    body: SharingTaskPatchRequestCompliantList,
    options?: ApiCallOptions,
) => Promise<PatchSharingTaskHttpResponse>

Updates one or more properties of a specific sharing task.

Type Declaration

- (
      taskId: string,
      body: SharingTaskPatchRequestCompliantList,
      options?: ApiCallOptions,
  ): Promise<PatchSharingTaskHttpResponse>
- Updates one or more properties of a specific sharing task.
  Parameters
  - taskId: string
    The sharing task identifier.
  - body: SharingTaskPatchRequestCompliantList
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<PatchSharingTaskHttpResponse>
  Throws
  PatchSharingTaskHttpError

Param: taskId

The sharing task identifier.

Param: body

an object with the body content

Throws

PatchSharingTaskHttpError

updateSharingTasksSettings

updateSharingTasksSettings: (
body: SharingSettingsPatchCompliantList,
options?: ApiCallOptions,
) => Promise<UpdateSharingTasksSettingsHttpResponse>

Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.

Type Declaration

- (
  body: SharingSettingsPatchCompliantList,
  options?: ApiCallOptions,
  ): Promise<UpdateSharingTasksSettingsHttpResponse>
- Patches the toggle settings for sharing tasks, reports, and other related configuration in the tenant. User must be assigned the TenantAdmin role.
  Parameters
  - body: SharingSettingsPatchCompliantList
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<UpdateSharingTasksSettingsHttpResponse>
  Throws
  UpdateSharingTasksSettingsHttpError

Param: body

an object with the body content

Throws

UpdateSharingTasksSettingsHttpError

Interface SharingTasksAPI

Index

Properties

Properties

cancelSharingTask

Type Declaration

Parameters

Returns Promise<CancelSharingTaskHttpResponse>

Throws

Param: taskId

Throws

clearCache

Type Declaration

Returns void

configureSharingTasksSettings

Type Declaration

Parameters

Returns Promise<ConfigureSharingTasksSettingsHttpResponse>

Throws

Param: body

Throws

createSharingTask

Type Declaration

Parameters

Returns Promise<CreateSharingTaskHttpResponse>

Throws

Param: body

Throws

deleteSharingTask

Type Declaration

Parameters

Returns Promise<DeleteSharingTaskHttpResponse>

Throws

Param: taskId

Throws

executeSharingTasks

Type Declaration

Parameters

Returns Promise<ExecuteSharingTasksHttpResponse>

Throws

Param: body

Throws

getSharingTask

Type Declaration

Parameters

OptionalisViewChart?: boolean

Returns Promise<GetSharingTaskHttpResponse>

Throws

Param: taskId

Param: query

Throws

getSharingTaskExecution

Type Declaration

Parameters

Optionalstatus?: "failed" | "cancelled" | "successful"

Returns Promise<GetSharingTaskExecutionHttpResponse>

Throws

Param: taskId

Param: executionId

Param: query

Throws

getSharingTaskExecutionFile

Type Declaration

Parameters

Optionalstatus?: "failed" | "cancelled" | "successful"

Returns Promise<GetSharingTaskExecutionFileHttpResponse>

Throws

Param: taskId

Param: executionId

Param: fileAlias

Param: query

Throws

getSharingTaskExecutions

Type Declaration

Parameters

Optionallimit?: number

Optionalnext?: string

Optionaloffset?: number

Optionalprev?: string

Optionalsort?: ("starttime" | "-starttime" | "+starttime")[]

`Optional`isViewChart?: boolean

`Optional`status?: "failed" | "cancelled" | "successful"

`Optional`status?: "failed" | "cancelled" | "successful"

`Optional`limit?: number

`Optional`next?: string

`Optional`offset?: number

`Optional`prev?: string

`Optional`sort?: ("starttime" | "-starttime" | "+starttime")[]

`Optional`status?: "failed" | "successful"

`Optional`appid?: string

`Optional`excludeDeleting?: boolean

`Optional`limit?: number

`Optional`next?: string

`Optional`offset?: number

`Optional`owner?: string

`Optional`ownername?: string

`Optional`page?: string

`Optional`prev?: string

`Optional`role?: ("owner" | "recipient")[]

`Optional`templateId?: string[]

`Optional`type?: ("chart-monitoring" | "chart-sharing" | "sheet-sharing" | "template-sharing")[]