client.plannedWorkOperationsOperation 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.
/planned-work-operations/{id}plannedWorkOperations.get
Polls a credential-owned, workspace-owned asynchronous replacement operation. Tenant and cell routing internals are never projected.
client.plannedWorkOperations.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getPlannedWorkOperation- Required scopes
planned-work:write- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 PlannedWorkOperation envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
plannedWorkOperations.wait
Poll a credential-owned asynchronous operation with bounded wait options.
client.plannedWorkOperations.wait(id: string, options?: PlannedWorkOperationWaitOptions)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.