GetWorkOrderRequest
| Field | Type |
|---|---|
id | string |
task_page | int32 |
task_page_size | int32 |
Get Work Order
POST /public-api/publicapi.v1.WorkOrder/GetWorkOrder
Required scope: work_order:read.
Requires orders read access and a readable customer. Reads only owner-workspace
records, not partner shares or executor records. Missing, foreign, and
customer-inaccessible work orders are not returned.
{ "id": "<work-order-id>", "taskPage": 1, "taskPageSize": 25 }Returns workOrder, tasks, taskPage, taskPageSize, hasMoreTasks, and
descriptionTruncated. Task page defaults to 1, page size to 25 with a maximum
of 100. Increment taskPage while hasMoreTasks is true; page values above
1,000,000 are invalid. Tasks are ordered by position, creation time, then ID.
Description is limited to 4,000 characters and task bodies to 2,000, with
descriptionTruncated and per-task bodyTruncated flags. Work-order title is
bounded to 500 characters. Task counters describe all tasks, not just this page.
Task details include completion state and completionMode, not execution
configuration. This read does not complete or otherwise transition a work order.
Generated Reference
POST /public-api/publicapi.v1.WorkOrder/GetWorkOrder Owner-workspace only. Returns a bounded summary and one page of tasks.
GetWorkOrderResponse
| Field | Type |
|---|---|
work_order | WorkOrder |
tasks | repeated WorkOrderTask |
task_page | int32 |
task_page_size | int32 |
has_more_tasks | bool |
description_truncated | bool |