GetWorkOrderTemplateRequest
| Field | Type |
|---|---|
id | string |
task_page | int32 |
task_page_size | int32 |
Get Work Order Template
POST /public-api/publicapi.v1.WorkOrderTemplate/GetWorkOrderTemplate
Required scope: work_order_template:read.
Requires content-template or settings read access. Missing, archived, and foreign
templates return no template.
{ "id": "<work-order-template-id>", "taskPage": 1, "taskPageSize": 25 }Returns workOrderTemplate and tasks, plus taskPage, taskPageSize, and
hasMoreTasks. Task page defaults to 1, size to 25, maximum 100. Increment
taskPage while hasMoreTasks is true; page values above 1,000,000 are invalid.
Tasks are ordered by position, creation time, then ID.
Template description is bounded to 2,000 characters with descriptionTruncated;
task bodies to 2,000 with per-task bodyTruncated. Name is bounded to 200 and
title to 500 characters. Manual/advanced task counts remain complete; advanced
task configuration is not returned.
preferredLocation describes an active location field. If none is available,
requiresLocationOverride is true and creation needs an explicit populated
customer field selected through Prepare Work Order.
Use the template ID with Create Work Order.
Generated Reference
POST /public-api/publicapi.v1.WorkOrderTemplate/GetWorkOrderTemplate GetWorkOrderTemplateResponse
| Field | Type |
|---|---|
work_order_template | WorkOrderTemplate |
tasks | repeated WorkOrderTemplateTask |
task_page | int32 |
task_page_size | int32 |
has_more_tasks | bool |