OfficeGest
Workshop/Service orders/{serviceOrder}/Checklists

Attach checklists to a service order

Attaches one or more checklist templates to a service order, copying the active items of each newly attached checklist. Already-attached checklists are skipped (idempotent) and keep their existing item state. Returns the updated list of checklists for the service order.

POST
/workshop/service-orders/{serviceOrder}/checklists
AuthorizationBearer <token>

In: header

Path Parameters

serviceOrderstring
checklist_idsarray<integer>

Checklist template IDs to attach to the service order. Each must reference an active checklist. Attaching an already-attached checklist is a no-op.

Response Body

curl -X POST "https://og-tenant1.test:8003/api/v2/workshop/service-orders/string/checklists" \
  -H "Content-Type: application/json" \
  -d '{
    "checklist_ids": [
      0
    ]
  }'
{
  "data": [
    {
      "checklist_id": 0,
      "description": "string",
      "checked_count": 0,
      "total_count": 0,
      "items": []
    }
  ]
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}