client.taskRecurrenceOperationsOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/task-recurrence-operations/{id}taskRecurrenceOperations.get
Use this operation to get a task recurrence operation. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.taskRecurrenceOperations.get(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
getTaskRecurrenceOperation- Required scopes
task-recurrences:readtasks:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TaskRecurrenceOperation envelope
/task-recurrence-operations/{id}/canceltaskRecurrenceOperations.cancel
Use this operation to cancel a task recurrence operation. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.taskRecurrenceOperations.cancel(id: string, options: RequestOptions = {})- Return form
Promise- Operation ID
cancelTaskRecurrenceOperation- Required scopes
task-recurrences:writetasks:readtasks:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TaskRecurrenceOperation envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
taskRecurrenceOperations.wait
Poll a credential-owned asynchronous operation with bounded wait options.
client.taskRecurrenceOperations.wait(id: string, options: TaskRecurrenceOperationWaitOptions = {})PromiseErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.