Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Equipment

15 endpoints15 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/managed_equipmentList equipment register
  2. POST /rest/v1.0/companies/{company_id}/managed_equipmentCreate equipment
  3. GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}Show equipment
  4. PATCH /rest/v1.0/companies/{company_id}/managed_equipment/{id}Update equipment
  5. GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/assignmentsList assignments
  6. POST /rest/v1.0/companies/{company_id}/managed_equipment/{id}/assignmentsCreate assignment
  7. GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspectionsList inspection records
  8. POST /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspectionsCreate inspection record
  9. GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections/{inspection_id}Show inspection record
  10. PATCH /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections/{inspection_id}Update inspection record
  11. DELETE /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections/{inspection_id}Delete inspection record
  12. GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/maintenance_logsList maintenance logs
  13. POST /rest/v1.0/companies/{company_id}/managed_equipment/{id}/maintenance_logsCreate maintenance log
  14. GET /rest/v1.0/companies/{company_id}/managed_equipment/filter_options/statusStatus filter options
  15. GET /rest/v1.0/projects/{project_id}/managed_equipmentList project-assigned equipment
GET /rest/v1.0/companies/{company_id}/managed_equipment

List equipment register

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · Equipment[]

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integerrequired
  • make
    string
  • model
    string
  • year
    integer
  • category
    string
  • type
    string
  • serial_number
    string
  • identification_number
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • ownership
    stringrequired
  • translated_ownership
    stringrequired
  • company_visible
    boolean
  • hourly_rate
    number
  • standby_rate
    number
  • current_project_id
    integer
  • current_project
    ProjectStub
  • location_id
    integer
  • location
    LocationFull
  • vendor_id
    integer
  • vendor
    VendorStub
  • created_by
    UserStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • deleted_at
    string
POST /rest/v1.0/companies/{company_id}/managed_equipment

Create equipment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Request body

  • managed_equipment
    objectrequired

Response · 201 · EquipmentShow

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integerrequired
  • make
    string
  • model
    string
  • year
    integer
  • category
    string
  • type
    string
  • serial_number
    string
  • identification_number
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • ownership
    stringrequired
  • translated_ownership
    stringrequired
  • company_visible
    boolean
  • hourly_rate
    number
  • standby_rate
    number
  • current_project_id
    integer
  • current_project
    ProjectStub
  • location_id
    integer
  • location
    LocationFull
  • vendor_id
    integer
  • vendor
    VendorStub
  • created_by
    UserStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • deleted_at
    string
  • assignments
    Assignment[]required
  • maintenance_logs
    MaintenanceLog[]required
  • inspections
    Inspection[]required
GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}

Show equipment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · EquipmentShow

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integerrequired
  • make
    string
  • model
    string
  • year
    integer
  • category
    string
  • type
    string
  • serial_number
    string
  • identification_number
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • ownership
    stringrequired
  • translated_ownership
    stringrequired
  • company_visible
    boolean
  • hourly_rate
    number
  • standby_rate
    number
  • current_project_id
    integer
  • current_project
    ProjectStub
  • location_id
    integer
  • location
    LocationFull
  • vendor_id
    integer
  • vendor
    VendorStub
  • created_by
    UserStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • deleted_at
    string
  • assignments
    Assignment[]required
  • maintenance_logs
    MaintenanceLog[]required
  • inspections
    Inspection[]required
PATCH /rest/v1.0/companies/{company_id}/managed_equipment/{id}

Update equipment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · EquipmentShow

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integerrequired
  • make
    string
  • model
    string
  • year
    integer
  • category
    string
  • type
    string
  • serial_number
    string
  • identification_number
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • ownership
    stringrequired
  • translated_ownership
    stringrequired
  • company_visible
    boolean
  • hourly_rate
    number
  • standby_rate
    number
  • current_project_id
    integer
  • current_project
    ProjectStub
  • location_id
    integer
  • location
    LocationFull
  • vendor_id
    integer
  • vendor
    VendorStub
  • created_by
    UserStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • deleted_at
    string
  • assignments
    Assignment[]required
  • maintenance_logs
    MaintenanceLog[]required
  • inspections
    Inspection[]required
GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/assignments

List assignments

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Assignment[]

  • id
    integerrequired
  • equipment_id
    integerrequired
  • project_id
    integerrequired
  • project
    ProjectStub
  • start_date
    stringrequired
  • end_date
    string
  • status
    stringrequired
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/companies/{company_id}/managed_equipment/{id}/assignments

Create assignment

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · Assignment

  • id
    integerrequired
  • equipment_id
    integerrequired
  • project_id
    integerrequired
  • project
    ProjectStub
  • start_date
    stringrequired
  • end_date
    string
  • status
    stringrequired
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections

List inspection records

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Inspection[]

  • id
    integerrequired
  • managed_equipment_id
    integerrequired
  • date
    stringrequired
  • inspector
    string
  • result
    stringrequired
  • translated_result
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
POST /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections

Create inspection record

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • managed_equipment_inspection
    objectrequired

Response · 201 · Inspection

  • id
    integerrequired
  • managed_equipment_id
    integerrequired
  • date
    stringrequired
  • inspector
    string
  • result
    stringrequired
  • translated_result
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections/{inspection_id}

Show inspection record

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired
  • inspection_id
    stringpathrequired

Response · 200 · Inspection

  • id
    integerrequired
  • managed_equipment_id
    integerrequired
  • date
    stringrequired
  • inspector
    string
  • result
    stringrequired
  • translated_result
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
PATCH /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections/{inspection_id}

Update inspection record

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired
  • inspection_id
    stringpathrequired

Response · 200 · Inspection

  • id
    integerrequired
  • managed_equipment_id
    integerrequired
  • date
    stringrequired
  • inspector
    string
  • result
    stringrequired
  • translated_result
    string
  • notes
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
DELETE /rest/v1.0/companies/{company_id}/managed_equipment/{id}/inspections/{inspection_id}

Delete inspection record

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired
  • inspection_id
    stringpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/managed_equipment/{id}/maintenance_logs

List maintenance logs

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · MaintenanceLog[]

  • id
    integerrequired
  • managed_equipment_id
    integerrequired
  • date
    stringrequired
  • type
    stringrequired
  • translated_type
    string
  • hours_at_service
    integer
  • performed_by
    string
  • cost
    number
  • notes
    string
  • next_service_date
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
POST /rest/v1.0/companies/{company_id}/managed_equipment/{id}/maintenance_logs

Create maintenance log

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · MaintenanceLog

  • id
    integerrequired
  • managed_equipment_id
    integerrequired
  • date
    stringrequired
  • type
    stringrequired
  • translated_type
    string
  • hours_at_service
    integer
  • performed_by
    string
  • cost
    number
  • notes
    string
  • next_service_date
    string
  • created_by
    UserStub
  • created_at
    string
  • updated_at
    string
  • deleted_at
    string
GET /rest/v1.0/companies/{company_id}/managed_equipment/filter_options/status

Status filter options

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · FilterOption[]

  • key
    stringrequired
  • value
    stringrequired
GET /rest/v1.0/projects/{project_id}/managed_equipment

List project-assigned equipment

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 200 · Equipment[]

  • id
    integerrequired
  • name
    stringrequired
  • company_id
    integerrequired
  • make
    string
  • model
    string
  • year
    integer
  • category
    string
  • type
    string
  • serial_number
    string
  • identification_number
    string
  • status
    stringrequired
  • translated_status
    stringrequired
  • ownership
    stringrequired
  • translated_ownership
    stringrequired
  • company_visible
    boolean
  • hourly_rate
    number
  • standby_rate
    number
  • current_project_id
    integer
  • current_project
    ProjectStub
  • location_id
    integer
  • location
    LocationFull
  • vendor_id
    integer
  • vendor
    VendorStub
  • created_by
    UserStub
  • created_at
    stringrequired
  • updated_at
    stringrequired
  • deleted_at
    string

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file