> For the complete documentation index, see [llms.txt](https://docs.flylogs.com/fcom/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flylogs.com/fcom/api-docs/reference/maintenance-jobs.md). # Maintenance Jobs Manage maintenance jobs for aircraft. Requires **premium** or **unlimited** subscription plan. ## Access control | Action | Allowed | | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | List / view (`index`, `view`, `history`, `forecast`) | Any authenticated company user on a premium/unlimited plan. The Flylogs NEO interface shows maintenance sections to `user_group_id <= 170` and `>= 250` | | Create / edit / sign CRS / duplicate / delete | `user_group_id` in **1, 100, 105, 110, 300** (administrators, managers and mechanics), or the aircraft owner | ## Recurring jobs Jobs carry a `repeat` field with one of: `NEVER`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `SEMESTER`, `YEAR`. When a job is marked complete (`completed = true`) and its `repeat` is not `NEVER`, the system automatically clones the job into the future: * `start` is shifted by the repeat interval (e.g. `SEMESTER` adds 6 months). * `finish` preserves the original duration. * `expiration` preserves the original offset from `start` if it was set. * `completed` is reset to `false`; `hours_now` and `landings_now` are reset to `0`. * All linked `WorkOrder` rows are duplicated with `status = pending`. Cloning is idempotent: a successor with the same `aircraft_id`, `name` and computed `start` will not be created twice. A console command `Console/cake maintenance recurring [companyId]` runs the same scan for jobs that completed before this feature was deployed and is safe to schedule via cron. ## Completion signature When a job transitions from `completed = false` to `completed = true`, the server stamps a `signature` JSON column with the authenticated user and timestamp: ```json { "user_id": 123, "signed_at": 1778485469 } ``` The signature is captured **only on the false → true transition**; re-saving an already-completed job will not overwrite the original signature. The field is `NULL` for jobs that have never been completed. ## Inspection signature After the CRS has been signed, a job can additionally be **inspected**. The inspection is stored as a `JobChange` event with `action = INSPECT` (user + timestamp) and printed in the **Inspected By** signature box of the job card PDF. In the Flylogs NEO interface the inspector confirms with their account password and the same certification disclaimer as the CRS signature; re-signing the CRS invalidates the previous inspection (a new INSPECT event after the latest SIGN is required). `POST` `/maintenance/jobs/inspect.json` #### Request Body | Parameter | Type | Description | | --------------- | ------ | ----------------------------------------------------------------------------------------------------------------------- | | data\[Job]\[id] | string | **Required.** Job UUID. The job must belong to the company and have `completed = true`, otherwise a 400/404 is returned | #### Response ```json { "result": true, "inspection": { "user_id": 3, "created": 1781141714 } } ``` ## Job card PDF signature boxes The job card PDF prints three signature boxes, filled from the job's change history: | Box | Source | | ------------ | ------------------------------------------------------------------- | | Performed By | The user that **created** the maintenance job (oldest `ADD` event) | | Inspected By | The latest `INSPECT` event recorded after the current CRS signature | | Approved By | The user that **signed the CRS** (latest `SIGN` event) | ## List Jobs `POST` `/maintenance/jobs/index.json` Retrieve a paginated list of maintenance jobs for the company fleet. #### Request Body (optional filters) | Parameter | Type | Description | | --------- | ------ | ----------------------------------------- | | aircraft | number | Filter by aircraft ID | | from | string | Start date filter (parseable date string) | | to | string | End date filter (parseable date string) | | wc | string | Search in job ID number and name | #### Response ```json { "maintenances": [ { "Job": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890", "aircraft_id": "45", "user_id": "123", "n_id": "42", "name": "100h Inspection", "start": "1714003200", "finish": "1714089600", "hours_now": "1250.5", "hours_added": "10.0", "landings_now": "890", "landings_added": null, "expiration": null, "description": "Scheduled 100-hour inspection per manufacturer guidelines.", "created": "1714003200" }, "Aircraft": { "registration": "EC-ABC", "Base": { "name": "LEBL" } }, "WorkOrder": [ { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Oil change", "ata": "79", "status": "completed" } ], "CompletedWorkOrder": [ { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Oil change", "ata": "79", "status": "completed" } ] } ], "paginate": { "page": 1, "current": 10, "count": 42, "prevPage": false, "nextPage": true, "pageCount": 5, "limit": 50 } } ``` *** ## View Job `GET` `/maintenance/jobs/view/{id}.json` Retrieve full details for a single maintenance job, including work orders and file uploads. #### Path Parameters | Parameter | Type | Description | | --------- | ------ | ----------- | | id | string | Job UUID | #### Response ```json { "maintenance": { "Job": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890", "aircraft_id": "45", "user_id": "123", "n_id": "42", "name": "100h Inspection", "start": "1714003200", "finish": "1714089600", "hours_now": "1250.5", "hours_added": "10.0", "landings_now": "890", "landings_added": null, "expiration": null, "description": "Scheduled 100-hour inspection per manufacturer guidelines.", "created": "1714003200" }, "Uploads": [], "Aircraft": { "id": "45", "registration": "EC-ABC", "active": true, "maintenance": true, "flight_count": "1200", "AircraftModel": { "name": "C172", "AircraftManufacturer": { "name": "Cessna" } } }, "WorkOrder": [ { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "status": "pending", "name": "Oil change", "created": "1714003200" } ], "AircraftReport": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "title": "Nose gear shimmy above 80kt", "type": "DEFECT", "severity": "MEDIUM", "status": "CLOSED", "aircraft_status": "FLYABLE", "created": "1714003200" } ] } } ``` *** ## Create Job `POST` `/maintenance/jobs/create.json` Create a new maintenance job. The authenticated user must be a manager or the aircraft's assigned user. An auto-incremented `n_id` is assigned server-side. #### Request Body | Parameter | Type | Required | Description | | -------------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | Job\[aircraft\_id] | number | yes | Aircraft ID | | Job\[name] | string | yes | Job name / title | | Job\[start] | string | yes | Start date (parseable date string) | | Job\[finish] | string | no | Finish date (defaults to start date) | | Job\[hours\_now] | number | yes | Aircraft total hours at time of job (decimal or HH:MM) | | Job\[hours\_added] | number | no | Hours added during job | | Job\[landings\_now] | number | no | Aircraft total landings at time of job | | Job\[landings\_added] | number | no | Landings added during job | | Job\[hours\_checkbox] | string | no | Set to non-zero to require `hours_added` | | Job\[expiration\_checkbox] | string | no | Set to non-zero to enable expiration date | | Job\[expiration] | string | no | Expiration date (parseable date string, required if checkbox enabled) | | Job\[description] | string | no | Job description | | Job\[crs] | string | no | Certificate of Release to Service — set to any truthy value to mark the job complete and automatically close all linked open aircraft reports | | Job\[attachment] | file | no | File upload (image, video, or document) | #### Response ```json { "data": { "aircraft_id": "45", "name": "100h Inspection", "start": "1714003200", "finish": "1714089600", "hours_now": "1250.5", "user_id": "123", "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890" }, "result": { "Job": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "n_id": "42", "name": "100h Inspection" } }, "attachment": null, "message": null } ``` On validation failure, `result` is `false`, `job` is `null` and `message` is a map of field → error messages, e.g.: ```json { "result": false, "job": null, "attachment": null, "message": { "aircraft_id": ["Aircraft cannot be empty"], "name": ["Maintenance name cannot be empty"] } } ``` If the save fails without producing field-level errors (e.g. a DB or `beforeSave` abort), `message` falls back to the string `"Unable to save the maintenance job"`. *** ## Delete Job `GET` `/maintenance/jobs/delete/{id}.json` Delete a maintenance job and all associated work orders. The authenticated user must be a manager or the aircraft's assigned user. #### Path Parameters | Parameter | Type | Description | | --------- | ------ | ----------- | | id | string | Job UUID | #### Response ```json { "result": true, "maintenance": { "Job": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "100h Inspection" }, "Aircraft": { "id": "45", "registration": "EC-ABC" } } } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.flylogs.com/fcom/api-docs/reference/maintenance-jobs.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.