Trucks

Operations

GET/trucksPOST/trucksGET/trucks/{id}PUT/trucks/{id}DELETE/trucks/{id}

---

List all Trucks

GET

/trucks

Returns a list of trucks. By default, non-archived trucks are returned, sorted by code ascending.

Authorizations

Bearer

JWT Authorization header using the Bearer scheme.

TypeHTTP (bearer)

Parameters

Header Parameters

x-api-version

Typestring

Default"1.0"

Query Parameters

term

Fuzzy search by: code, name, description

Typestring

code

Filter by code (exact)

Typestring

includeArchived

Include archived trucks

Typeboolean

Defaultfalse

sort

Sorting property

Typestring

Valid values

"code""name"

Default"code"

dir

The direction of sorting

Typestring

Valid values

"asc""desc"

Default"asc"

page

The page number of the results to fetch

Typeinteger

Example1

Format"int64"

Default1

size

Maximum number of items returned in a single response (max 100)

Typeinteger

Examples

10

20

50

Format"int64"

Default10

Responses

OK

Content-Type

application/json

{

"items": [

{

"id": "string",

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string",

"isArchived": true

}

],

"pagination": {

"total": 100,

"pages": 10

}

}

GET

/trucks

Playground

Authorization

Bearer

Headers

x-api-version

Variables

Key

Value

term

code

includeArchived

sort

dir

page

size

Samples

cURL

JavaScript

PHP

Python

---

Create a Truck

POST

/trucks

Authorizations

Bearer

JWT Authorization header using the Bearer scheme.

TypeHTTP (bearer)

Request Body

application/json

{

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string"

}

Responses

OK

Content-Type

application/json

{

"id": "string",

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string",

"isArchived": true

}

POST

/trucks

Playground

Authorization

Bearer

Body

Samples

cURL

JavaScript

PHP

Python

---

Get Truck details

GET

/trucks/{id}

Returns the details of the specified Truck

Authorizations

Bearer

JWT Authorization header using the Bearer scheme.

TypeHTTP (bearer)

Parameters

Header Parameters

x-api-version

Typestring

Default"1.0"

Path Parameters

id*

The identifier of the specified Truck

Typestring

Required

Responses

OK

Content-Type

application/json

{

"id": "string",

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string",

"isArchived": true

}

GET

/trucks/{id}

Playground

Authorization

Bearer

Headers

x-api-version

Variables

Key

Value

id*

Samples

cURL

JavaScript

PHP

Python

---

Update a Truck

PUT

/trucks/{id}

Authorizations

Bearer

JWT Authorization header using the Bearer scheme.

TypeHTTP (bearer)

Request Body

application/json

{

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string",

"isArchived": true

}

Responses

OK

Content-Type

application/json

{

"id": "string",

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string",

"isArchived": true

}

PUT

/trucks/{id}

Playground

Authorization

Bearer

Body

Samples

cURL

JavaScript

PHP

Python

---

Archive a Truck

DELETE

/trucks/{id}

Authorizations

Bearer

JWT Authorization header using the Bearer scheme.

TypeHTTP (bearer)

Responses

OK

Content-Type

application/json

{

"id": "string",

"code": "string",

"name": "string",

"description": "string",

"type": "string",

"plantId": "string",

"isArchived": true

}

DELETE

/trucks/{id}

Playground

Authorization

Bearer

Samples

cURL

JavaScript

PHP

Python

---