client.plannedWorkOperation 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-workplannedWork.list
Returns a stable ascending keyset page from the credential cell. The cursor is bound to the workspace and complete filter set. Authorization filtering can produce an empty page with a non-null cursor.
client.plannedWork.list(options: PlannedWorkListOptions)- Return form
Promise- Operation ID
listPlannedWork- Required scopes
planned-work:read- SDK parameters
options: PlannedWorkListOptions- Query request fields
cursor?: stringlimit?: integerstart: stringend: stringtaskId?: stringprojectId?: stringuserId?: string- Success
200 Array<PlannedWork> envelope
/tasks/{id}/planned-workplannedWork.getForTask
Returns the task schedule and a strong revision ETag. Reads fail closed while a replacement overlaps the task.
client.plannedWork.getForTask(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getTaskPlannedWork- Required scopes
planned-work:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 TaskPlannedWork envelope
/tasks/{id}/planned-workplannedWork.replaceForTask
Atomically compares the strong task schedule revision and accepts a credential-owned asynchronous replacement. The same Idempotency-Key and payload replay the original operation; a different payload conflicts.
client.plannedWork.replaceForTask(id: string, data: PlannedWorkReplacement, options: PlannedWorkReplaceOptions)- Return form
Promise- Operation ID
replaceTaskPlannedWork- Required scopes
planned-work:write- SDK parameters
id: stringdata: PlannedWorkReplacementoptions: PlannedWorkReplaceOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Request body
PlannedWorkReplacementapplication/json- Success
202 PlannedWorkOperation envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
plannedWork.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.plannedWork.pages(options: PlannedWorkListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors 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.