solarOSsolarOS Docs

Create a project-contained Work Order

Creates a Work Order inside a required Project using an active Work Type. The Work Order Property is derived from the Project and submitted mismatches fail validation. Requires linking an existing unlinked WORK_ORDER Project Item or creating a limited inline Project Item in the same transaction. Scheduling fields are not writable. Requires Idempotency-Key and work_orders:write.

POST
/work-orders

Creates a Work Order inside a required Project using an active Work Type. The Work Order Property is derived from the Project and submitted mismatches fail validation. Requires linking an existing unlinked WORK_ORDER Project Item or creating a limited inline Project Item in the same transaction. Scheduling fields are not writable. Requires Idempotency-Key and work_orders:write.

Authorization

Authorization<token>

Organization API key. Format: Bearer sk_live_...

In: header

Request Body

application/json

JSON request payload for createWorkOrder.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/work-orders" \  -H "Content-Type: application/json" \  -d '{    "projectId": "project_123",    "workTypeId": "work_type_123",    "title": "Install PV array",    "description": "Roof work and inverter installation.",    "priority": "MEDIUM",    "projectItem": {      "name": "Install PV array",      "isRequired": true    }  }'
{  "data": {},  "meta": {    "requestId": "string",    "version": "v1",    "timestamp": "2019-08-24T14:15:22Z",    "rateLimit": {      "limit": 0,      "remaining": 0,      "reset": 0    }  }}