LightningWeb.API.WorkOrdersController (Lightning v2.15.0-pre5)

View Source

API controller for managing work orders.

Query Parameters

  • page - Page number (default: 1)
  • page_size - Number of items per page (default: 10)
  • inserted_after - Filter work orders created after this ISO8601 datetime
  • inserted_before - Filter work orders created before this ISO8601 datetime
  • updated_after - Filter work orders updated after this ISO8601 datetime
  • updated_before - Filter work orders updated before this ISO8601 datetime

Examples

GET /api/work_orders?page=1&page_size=20
GET /api/work_orders?inserted_after=2024-01-01T00:00:00Z
GET /api/work_orders?inserted_after=2024-01-01T00:00:00Z&inserted_before=2024-12-31T23:59:59Z
GET /api/projects/:project_id/work_orders?inserted_after=2024-01-01T00:00:00Z

Summary

Functions

index(conn, params)

Lists work orders with optional project filtering.

show(conn, map)

Retrieves a specific work order by ID.

Functions

index(conn, params)

@spec index(Plug.Conn.t(), map()) :: Plug.Conn.t()

Lists work orders with optional project filtering.

This function has two variants:

  • With project_id: Returns work orders for a specific project
  • Without project_id: Returns work orders across all accessible projects

Returns a paginated list of work orders with optional datetime filtering.

Parameters

  • conn - The Plug connection struct with the current resource assigned
  • params - Map containing:
    • project_id - Project UUID (optional, filters to specific project)
    • page - Page number (optional, default: 1)
    • page_size - Items per page (optional, default: 10)
    • inserted_after - Filter work orders created after ISO8601 datetime (optional)
    • inserted_before - Filter work orders created before ISO8601 datetime (optional)
    • updated_after - Filter work orders updated after ISO8601 datetime (optional)
    • updated_before - Filter work orders updated before ISO8601 datetime (optional)

Returns

  • Renders JSON with paginated list of work orders
  • 404 Not Found if project doesn't exist (when project_id provided)
  • 403 Forbidden if user lacks project access (when project_id provided)
  • 422 Unprocessable Entity if datetime parameters are invalid

Examples

# All work orders accessible to user
GET /api/work_orders
GET /api/work_orders?page=2&page_size=50
GET /api/work_orders?inserted_after=2024-01-01T00:00:00Z

# Work orders for specific project
GET /api/projects/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/work_orders
GET /api/projects/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/work_orders?page=2
GET /api/projects/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d/work_orders?inserted_after=2024-01-01T00:00:00Z

show(conn, map)

@spec show(Plug.Conn.t(), map()) :: Plug.Conn.t()

Retrieves a specific work order by ID.

Returns detailed information about a single work order including its associated workflow and runs. Access is granted if the user has access to the work order's parent project.

Parameters

  • conn - The Plug connection struct with the current resource assigned
  • params - Map containing:
    • id - Work order UUID (required)

Returns

  • 200 OK with work order JSON including workflow and runs
  • 404 Not Found if work order doesn't exist
  • 403 Forbidden if user lacks project access

Examples

GET /api/work_orders/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d