Equipment

Manage equipment, including registration, update, deletion, and advanced search.
Equipment can be linked to offices, projects, and categories, and supports metadata and filtering.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/equipment/index

Returns a paginated and filterable list of equipment.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching equipment

object

filter

object

office_equipment_id

string format: uuid

office_id

string format: uuid

project_id

string format: uuid

equipment_id

string format: uuid

code

string

name

string

description

string

office_name

string

project_name

string

project_type

string

category

string

owned_active

boolean

parent_active

boolean

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "name": "Excavator",
    "office_id": "off-1"
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of equipment

Array<object>

object

office_equipment_id

string format: uuid

office_id

string format: uuid

project_id

string format: uuid

equipment_id

string format: uuid

code

string

name

string

description

string

office_name

string

project_name

string

project_type

string

category

string

owned_active

boolean

parent_active

boolean

Example

{
  "office_equipment_id": "oe-1",
  "office_id": "off-1",
  "equipment_id": "eq-1",
  "code": "EQ-001",
  "name": "Excavator",
  "description": "Heavy duty excavator",
  "project_id": "proj-1",
  "serial": "SN123456",
  "vendor": "Caterpillar",
  "model": "CAT320"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/equipment/create

Create a new equipment entry by providing the required details.

Request Body ^required

Equipment object to be created

object

office_equipment_id

string

office_id

string

equipment_id

string

code

string

name

string

description

string

project_id

string

serial

string

vendor

string

model

string

Example

{
  "office_id": "off-1",
  "code": "EQ-002",
  "name": "Bulldozer",
  "description": "Tracked bulldozer",
  "project_id": "proj-1",
  "serial": "SN654321",
  "vendor": "Komatsu",
  "model": "D65EX"
}

Responses

201

Equipment created successfully

object

office_equipment_id

string

office_id

string

equipment_id

string

code

string

name

string

description

string

project_id

string

serial

string

vendor

string

model

string

Example

{
  "office_equipment_id": "oe-2",
  "office_id": "off-1",
  "equipment_id": "eq-2",
  "code": "EQ-002",
  "name": "Bulldozer",
  "description": "Tracked bulldozer",
  "project_id": "proj-1",
  "serial": "SN654321",
  "vendor": "Komatsu",
  "model": "D65EX"
}

view

GET

/v2/equipment/view/{id}

Retrieve an equipment entry by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the equipment to retrieve

Responses

200

Equipment found

object

office_equipment_id

string format: uuid

office_id

string format: uuid

project_id

string format: uuid

equipment_id

string format: uuid

code

string

name

string

description

string

office_name

string

project_name

string

project_type

string

category

string

owned_active

boolean

parent_active

boolean

Example

{
  "office_equipment_id": "oe-1",
  "office_id": "off-1",
  "equipment_id": "eq-1",
  "code": "EQ-001",
  "name": "Excavator",
  "description": "Heavy duty excavator",
  "project_id": "proj-1",
  "serial": "SN123456",
  "vendor": "Caterpillar",
  "model": "CAT320"
}

404

Equipment not found

delete

DELETE

/v2/equipment/delete/{id}

Delete an equipment entry by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the equipment to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Equipment deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/equipment/update/{id}

Update an existing equipment entry by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the equipment to update

Request Body ^required

Equipment object with updated data

object

office_equipment_id

string

office_id

string

equipment_id

string

code

string

name

string

description

string

project_id

string

serial

string

vendor

string

model

string

Example

{
  "name": "Updated Excavator",
  "description": "Updated description"
}

Responses

200

Equipment updated successfully

object

office_equipment_id

string

office_id

string

equipment_id

string

code

string

name

string

description

string

project_id

string

serial

string

vendor

string

model

string

Example

{
  "office_equipment_id": "oe-1",
  "name": "Updated Excavator",
  "description": "Updated description"
}

404

Equipment not found