Data model
The MaxTrax API is organised around the lifecycle of weld data on an industrial project. This page is a quick orientation to the vocabulary the endpoints use; the exact field-level schemas live in the REST API reference.
Core entities
Section titled “Core entities”| Term | What it is |
|---|---|
| ISO (isometric) | An isometric drawing — a 2D representation of a pipeline spool. Welds belong to an ISO. |
| Weld | A single weld joint on an ISO. Carries a weld number, type, size, schedule, and status. |
| Weld status | A weld’s position in its lifecycle: PENDING, ACCEPTED, REJECTED, VOIDED, or REPAIR. |
| NDT | Non-Destructive Testing — radiographic (RT), ultrasonic (UT), PWHT, and similar examinations. |
| Film interval | A defined section of an NDT film strip, mapped to one or more welds. |
| Test package | A collection of ISOs/welds released together for pressure testing and certification. |
| PQR | Procedure Qualification Record — documents qualification of a welding procedure. |
| WPS | Welding Procedure Specification — the procedure a welder follows. |
How they relate
Section titled “How they relate”- An ISO holds many welds.
- A weld moves through its status lifecycle as it is inspected, rejected, and repaired.
- Inspections and NDT records (with their film intervals) attach to the welds they cover.
- Welds and ISOs are grouped into test packages for pressure testing and quality certification.
- Welders carry qualifications, backed by PQRs and WPS documents.
Where this shows up in the API
Section titled “Where this shows up in the API”The vocabulary above maps directly onto the resources in the reference — for example:
GET /isos— list isometric drawings.GET /welds,GET /welds/{id}— list and read welds.PATCH /welds/{id}/status— advance a weld through its status lifecycle.
The REST API reference is the authoritative, always-current list of every resource, parameter, and schema.