client.projectTemplatesOperation 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.
/project-templatesprojectTemplates.list
The cell-local App re-authenticates the credential and verifies the projects.templates plan capability before this service reads only the tenant-scoped, metadata-only projection. Captured snapshot data is never selected or exposed.
client.projectTemplates.list(options: ProjectTemplateListOptions = {})- Return form
Promise- Operation ID
listProjectTemplates- Required scopes
project-templates:read- SDK parameters
options: ProjectTemplateListOptions- Query request fields
cursor?: stringlimit?: integerarchived?: booleancreatedAtFrom?: stringcreatedAtTo?: stringoriginProjectId?: string- Success
200 Array<ProjectTemplate> envelope
/project-templatesprojectTemplates.create
The cell-local App re-authenticates the credential, verifies tenant ownership and the projects.templates.add plan permission, snapshots the source project with bounded list/task limits, and applies credential-bound idempotency.
client.projectTemplates.create(data: ProjectTemplateCreate, options?: MutationOptions)- Return form
Promise- Operation ID
createProjectTemplate- Required scopes
project-templates:write- SDK parameters
data: ProjectTemplateCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
ProjectTemplateCreateapplication/json- Success
200 ProjectTemplate envelope201 ProjectTemplate envelope
/project-templates/{id}projectTemplates.get
The cell-local App re-authenticates the credential and verifies the projects.templates plan capability before a tenant-scoped metadata-only read. The captured snapshot is never selected or exposed.
client.projectTemplates.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getProjectTemplate- Required scopes
project-templates:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 ProjectTemplate envelope
/project-templates/{id}projectTemplates.update
Requires exactly one latest strong resource ETag. The cell-local App re-authenticates and atomically compares the tenant-bound revision before mutation.
client.projectTemplates.update(id: string, data: ProjectTemplateUpdate, options: ProjectTemplateMutationOptions)- Return form
Promise- Operation ID
updateProjectTemplate- Required scopes
project-templates:write- SDK parameters
id: stringdata: ProjectTemplateUpdateoptions: ProjectTemplateMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
ProjectTemplateUpdateapplication/json- Success
200 ProjectTemplate envelope
/project-templates/{id}projectTemplates.archive
Requires exactly one latest strong resource ETag and returns the post-archive revision in the ETag header.
client.projectTemplates.archive(id: string, options: ProjectTemplateMutationOptions)- Return form
Promise- Operation ID
archiveProjectTemplate- Required scopes
project-templates:write- SDK parameters
id: stringoptions: ProjectTemplateMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
204
/project-templates/{id}/restoreprojectTemplates.restore
Requires exactly one latest strong resource ETag. The cell-local App re-authenticates and atomically compares the tenant-bound revision before mutation.
client.projectTemplates.restore(id: string, options: ProjectTemplateMutationOptions)- Return form
Promise- Operation ID
restoreProjectTemplate- Required scopes
project-templates:write- SDK parameters
id: stringoptions: ProjectTemplateMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 ProjectTemplate envelope
/project-templates/{id}/instantiateprojectTemplates.instantiate
The cell-local App re-authenticates the credential, verifies both required scopes, tenant ownership, projects.templates and projects.create plan permissions, validates every referenced resource, and starts a credential-owned asynchronous operation.
client.projectTemplates.instantiate(id: string, data: ProjectTemplateInstantiate, options: ProjectTemplateInstantiationOptions)- Return form
Promise- Operation ID
instantiateProjectTemplate- Required scopes
project-templates:writeprojects:write- SDK parameters
id: stringdata: ProjectTemplateInstantiateoptions: ProjectTemplateInstantiationOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Request body
ProjectTemplateInstantiateapplication/json- Success
202 ProjectTemplateInstantiation envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
projectTemplates.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.projectTemplates.pages(options?: ProjectTemplateListOptions, 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.