31  Equipment

6 operations.

31.0.1 list_equipment_api_v1_equipment_get

GET /api/v1/equipment

List Equipment

List equipment with optional filters. Returns a paginated list of equipment records. Filterable by facility, equipment class, process unit, and automation scope.

Authentication: bearerAuth

Parameters

Name In Required Type Notes
facility_id query no Filter by facility
equipment_class query no Filter by class (e.g. pressure_vessel)
process_unit query no Filter by process unit name
in_scope query no Filter by automation scope
limit query no integer
offset query no integer

Responses

Status Meaning Body
200 Successful Response
422 Validation Error HTTPValidationError

31.0.2 get_equipment_api_v1_equipment__equipment_id__get

GET /api/v1/equipment/{equipment_id}

Get Equipment

Get equipment detail with full profile. Returns the equipment record plus its EquipmentProfile (material, design params, process fluids, historical damage mechanisms) suitable for direct use in pipeline stage requests.

Authentication: bearerAuth

Parameters

Name In Required Type Notes
equipment_id path yes string (uuid)

Responses

Status Meaning Body
200 Successful Response
422 Validation Error HTTPValidationError

31.0.3 get_equipment_exceedances_api_v1_equipment__equipment_id__exceedances_get

GET /api/v1/equipment/{equipment_id}/exceedances

Get Equipment Exceedances

Get recent exceedance events for an equipment item. Returns IOW exceedances detected by Stage 2, ordered by start_time desc.

Authentication: bearerAuth

Parameters

Name In Required Type Notes
equipment_id path yes string (uuid)
iow_level query no Filter by IOW level
active_only query no boolean Only return ongoing exceedances
limit query no integer

Responses

Status Meaning Body
200 Successful Response ExceedanceEvent
422 Validation Error HTTPValidationError

31.0.4 get_equipment_iow_limits_api_v1_equipment__equipment_id__iow_limits_get

GET /api/v1/equipment/{equipment_id}/iow-limits

Get Equipment Iow Limits

Get active IOW limits for an equipment item. Returns IOW limits defined per API 584 for the given equipment. Used by Stage 2 (IOW Classification) to detect exceedances.

Authentication: bearerAuth

Parameters

Name In Required Type Notes
equipment_id path yes string (uuid)
iow_level query no Filter by IOW level
active_only query no boolean Only return active (non-superseded) limits

Responses

Status Meaning Body
200 Successful Response IOWLimit
422 Validation Error HTTPValidationError

31.0.5 get_equipment_profile_api_v1_equipment__equipment_id__profile_get

GET /api/v1/equipment/{equipment_id}/profile

Get Equipment Profile

Get the EquipmentProfile for use in pipeline stage requests. This is the structured profile needed by Stages 3–5 (damage mapping, consistency gate, risk quantification). Built from equipment record + related data (materials, process fluids, historical mechanisms).

Authentication: bearerAuth

Parameters

Name In Required Type Notes
equipment_id path yes string (uuid)

Responses

Status Meaning Body
200 Successful Response EquipmentProfile
422 Validation Error HTTPValidationError

31.0.6 get_equipment_risk_assessment_api_v1_equipment__equipment_id__risk_assessment_get

GET /api/v1/equipment/{equipment_id}/risk-assessment

Get Equipment Risk Assessment

Get the latest risk assessment for an equipment item. Returns the most recent Stage 5 output (risk score, remaining life, inspection interval) for the given equipment.

Authentication: bearerAuth

Parameters

Name In Required Type Notes
equipment_id path yes string (uuid)

Responses

Status Meaning Body
200 Successful Response
422 Validation Error HTTPValidationError