List Tires
Returns a list of Tires
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2
and<= 100
Default value:
50
The number of records per page to return.
- filter object
The fields, operations, and values to filter the records by.
axle_config_id object
oneOf- MOD1
- MOD2
include string requiredeq string requiredvehicle_id object
oneOf- MOD1
- MOD2
include string requiredeq string requiredpart_id object
oneOf- MOD1
- MOD2
include string requiredeq string requiredtire_position_id object
oneOf- MOD1
- MOD2
include string requiredeq string requiredcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string required
- sort object
The fields and direction to sort the results by.
- created_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
] - id string
Possible values: [
asc
,desc
]Default value:
desc
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
axle_config_id object
oneOf- MOD1
- MOD2
include stringeq stringvehicle_id object
oneOf- MOD1
- MOD2
include stringeq stringpart_id object
oneOf- MOD1
- MOD2
include stringeq stringtire_position_id object
oneOf- MOD1
- MOD2
include stringeq stringcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
created_at stringPossible values: [
asc
,desc
]updated_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]records object[]
id integerThe id of the
Tire
tire_position_id integerA
Tire Position
id. The existence of atire_position_id
indicates thisTire
is currently installed. Similiarly, if this value isnull
, then thisTire
is not currently installed on aVehicle
.part_id integerA
Part
id.axle_config_id integerAn
Axle Configuration
id. The existence of aaxle_config_id
indicates thisTire
is currently installed. Similiarly, if this value isnull
, then thisTire
is not currently installed on aVehicle
.pressure integerThe air pressure of the
Tire
in pounds per square inch (PSI)tread_depth integerThe tread depth of the
Tire
in /32 inch.current_meter numberThe current meter of the
Tire
.created_at date-timeWhen the
Tire
was createdupdated_at date-timeWhen the
Tire
was last updated
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"axle_config_id": {
"include": "string"
}
},
{
"vehicle_id": {
"include": "string"
}
},
{
"part_id": {
"include": "string"
}
},
{
"tire_position_id": {
"include": "string"
}
},
{
"created_at": {
"lt": "string"
}
},
{
"updated_at": {
"lt": "string"
}
}
],
"sorted_by": [
{
"created_at": "asc"
},
{
"updated_at": "asc"
},
{
"id": "asc"
}
],
"records": [
{
"id": 1,
"tire_position_id": 1,
"part_id": 1,
"axle_config_id": 1,
"pressure": 32,
"tread_depth": 12,
"current_meter": 19250,
"created_at": "2024-11-21",
"updated_at": "2024-11-21"
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}