🧪 Create DVIR Log - Catena Telematics API

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

is_sync

boolean

default:false

Whether to process the request synchronously. If true, Catena will attempt to create or update the resource immediately with the TSP and return the result in the response. When performing synchronous operations, you are responsible for handling any necessary retries in case of transient failures.If false (default), Catena will create an asynchronous operation, and you can check the status of the operation using the returned operation ID.

Body

application/json

DvirLog model for creating new records.

connection_id

string<uuid>

required

Unique identifier of the connection at Catena Telematics which will be used to create this resource. A connection represents a Fleet/TSP pairing.

driver_id

string<uuid>

required

Identifier for the driver

vehicle_id

string<uuid> | null

Identifier for the vehicle

trailer_id

string<uuid> | null

Identifier for the trailer

occurred_at

string<date-time> | null

Datetime of when the inspection occurred (must be UTC)

log_type

enum<string>

default:unknown

Type of DVIR log. Defaults to unknown when omitted.

Available options:

pre_trip,

post_trip,

mechanic,

unknown

inspected_by

string | null

Name of the inspector conducting the DVIR

defect_count

integer | null

Total number of defects reported in this DVIR log. Defaults to 0 when omitted and no defects provided.

defects

enum<string>[] | null

List of defects reported in this DVIR log

Enum for DVIR (Driver Vehicle Inspection Report) defects

Available options:

fluid_levels,

battery,

belts_hoses,

radiator,

frame_assembly,

front_axle,

starter,

transmission,

oil_pressure,

defroster_heater,

lights_front,

windshield_clean,

windshield_wiper_fluid,

windshield_wipers,

brakes,

brake_check,

clutch,

mirrors,

horn,

safety_equipment,

trip_recorder,

air_conditioner,

doors,

stop_arm_control,

steering_wheel,

emergency_door_buzzer,

entrance_steps,

interior_floor,

windows,

exhaust,

fifth_wheel,

landing_gear,

suspension,

alignment,

rims,

tires,

tire_chains,

stop_arm,

muffler,

roof,

wheels,

wheels_rims,

suspension_under,

scratches,

air_compressor,

air_lines,

brake_connections,

coupling_devices,

reflectors,

lights_rear,

rear_end,

tire_chains_rear,

brake_accessories,

drive_line,

engine,

fuel_tanks,

lights_general,

other,

unset,

first_aid_kit

defects_detail

DvirDefectDetail · object[] | null

Detailed defect entries with part and defect information

Show child attributes

is_safety_critical

boolean | null

Indicates whether the DVIR log is safety-critical

driver_comment

string | null

Additional free-text comments provided by the driver

certify_comment

string | null

Driver's certification comment acknowledging the inspection

odometer

number | null

Vehicle odometer reading at the time of the DVIR

odometer_unit

enum<string> | null

Unit for odometer

Available options:

m,

km,

mi,

ft,

nmi

certify_date

string<date-time> | null

Datetime when the DVIR was certified (must be UTC)

certified_by

string | null

Identifier for the individual who certified the DVIR

status

enum<string> | null

Log level defects summary status

Available options:

no_defect,

defect_noted,

defect_corrected

Response

The DVIR log was created successfully.

Resource operation model

partner_id

string<uuid>

required

The ID of the partner that created the operation.

connection_id

string<uuid>

required

The ID of the connection

resource

enum<string>

required

The type of resource to operate on (e.g., vehicle, driver).

Available options:

asset,

driver_association,

driver_vehicle_association,

driver_event_log,

driver_safety_event,

dvir_log,

dvir_log_defect,

engine_log,

engine_status,

fuel_transaction,

fleet_info,

hos_availability,

hos_daily_snapshot,

hos_event,

hos_event_annotation,

hos_event_attachment,

hos_violation,

ifta_summary,

location_segment,

message,

group_message,

user,

vehicle,

vehicle_location,

vehicle_sensor,

vehicle_region_segment,

trailer,

trailer_association,

trailer_vehicle_association,

trailer_location,

trailer_status,

workflow

operation_type

enum<string>

required

The type of operation to perform (e.g., create, update).

Available options:

create,

update

payload

Operation Payload · object

required

The payload of the operation, containing the resource attributes to be created or updated.

string<uuid>

Unique identifier for the resource operation.

created_at

string<date-time>

Immutable: The datetime the record was created in Catena Telematics.

updated_at

string<date-time>

The datetime the record was last modified in Catena Telematics.

deleted_at

string<date-time> | null

The datetime the record was logically deleted from Catena Telematics.

resource_id

string<uuid> | null

Unique identifier of the record. Can be null for create operations where the source does not exist yet.

source_id

string | null

The unique identifier of the resource in the source system. Required for update operations.

status

enum<string>

default:pending

The status of the operation

Available options:

pending,

success,

failed

logs

ResourceOperationLog · object[]

Log entries for each attempt to execute this operation.

Show child attributes