GET v2/J1939/FaultLibraries/{id}/Fmis

Retrieves the list of FMIs from the J1939 fault library.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the J1939 fault library to retrieve FMIs from.

integer

Required

Body Parameters

None.

Response Information

Resource Description

An array of representing the FMIs in the J1939 fault library.

Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Fmi
NameDescriptionTypeAdditional information
fmi

The failure mode identifier (FMI). Sent as part of the J1939 CAN Frame.

integer

None.

name

The name of the FMI.

string

None.

description

A description of the FMI.

string

None.

recommendations

Recommendations for addressing a fault that references this FMI.

string

None.

faultSeverityId

The fault severity associated with this FMI. This is an optional value assigned in a custom J1939 library. If not assigned, the fault severity will be null.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "fmi": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "recommendations": "sample string 4",
    "faultSeverityId": 1
  },
  {
    "fmi": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "recommendations": "sample string 4",
    "faultSeverityId": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfJ1939Fmi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <J1939Fmi>
    <Fmi>1</Fmi>
    <Name>sample string 2</Name>
    <Description>sample string 3</Description>
    <Recommendations>sample string 4</Recommendations>
    <FaultSeverityId>1</FaultSeverityId>
  </J1939Fmi>
  <J1939Fmi>
    <Fmi>1</Fmi>
    <Name>sample string 2</Name>
    <Description>sample string 3</Description>
    <Recommendations>sample string 4</Recommendations>
    <FaultSeverityId>1</FaultSeverityId>
  </J1939Fmi>
</ArrayOfJ1939Fmi>