Faults

Retrieve Fault

Retrieve the details of a Fault Record

get/faults/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

account_idinteger required
vehicle_idinteger nullable required
codestring required

The diagnostic trouble code.

countinteger nullable required

The number of times this Fault has occurred.

descriptionstring nullable required

A short description about the problem.

external_idstring nullable required

An external identifier for the Fault, if applicable.

last_occurred_atstring date-time nullable required

The date and time when the Fault last occurred.

namestring nullable required

The name or label for the Fault.

status'open' | 'resolved' | 'ignored' required

The status of the Fault.

sourcestring nullable

The source or origin of the Fault.

vehicle_archived_atstring date-time nullable required

The date and time when the associated Vehicle was archived, if applicable.

fault_rule_idinteger nullable
is_sampleboolean

Indicates if the Fault is sample data.

idempotency_keystring nullable

An optional key for idempotent operations.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "last_occurred_at": "2023-03-14T13:46:27-06:00",
  "vehicle_archived_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.