Managing Equipment Lifecycle

Equipment lifecycle management enables you to track your equipment through different operational states, from active operation to retirement. This ensures accurate fleet visibility, proper data collection management, and organized equipment transitions.

This guide covers common scenarios for managing equipment status changes through the Hiboo API.

Overview

Equipment in Hiboo can exist in three distinct states, each serving different business purposes and affecting data collection:

Equipment Status Types:

ACTIVE: Part of your operational fleet, actively receiving and processing data
ARCHIVED: Equipment no longer in active service but with preserved historical data access
DELETED: Equipment completely removed from your fleet (typically for data correction purposes)

Key Business Rules:

Equipment must be unshared before it can be archived
Equipment must be archived before it can be deleted
Data collection stops immediately when equipment is archived
Historical data remains accessible for archived equipment
Data collected during archiving period is permanently unavailable when restored
Equipment deletion is irreversible

Learn More: See Equipment Archiving Help Center for additional operational information.

Status Discovery

Checking Equipment Status

When you need to understand the current operational state of equipment:

Get equipment status

get

/v2/fleet/equipments/{id}/status

Returns the current status of the specified equipment. The response includes metadata depending on the status

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Responses

200

Equipment status retrieved successfully

application/json

statusstring · enumRequired

Current status of the equipment

Possible values:

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

get/v2/fleet/equipments/{id}/status

GET /v2/fleet/equipments/{id}/status HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

{
  "status": "archived",
  "metadata": {
    "date": "2024-12-01T10:30:00Z",
    "comment": "End-of-life; replaced by new model"
  }
}

Common scenarios:

Fleet auditing: Review operational status across your entire fleet
Compliance tracking: Ensure proper documentation of equipment transitions
System integration: Validate equipment state before performing operations
Troubleshooting: Understand why equipment might not be receiving data

Equipment Archiving

Moving Equipment Out of Active Service

Problem: You need to remove equipment from active operations while preserving historical data access for compliance, reporting, or future reference.

Solution: Archive equipment to stop data collection while maintaining access to historical information.

Archive an equipment

post

/v2/fleet/equipments/{id}/status/archived

Marks the specified equipment as archived. Archived equipment will no longer be active, but can be restored later using the /status/active endpoint.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Body

commentstringRequired

Reason or note for archiving the equipment

Example: Equipment is no longer in use and has been replaced

Responses

204

Equipment archived successfully (no content)

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Equipment must be active before it can be archived

post/v2/fleet/equipments/{id}/status/archived

POST /v2/fleet/equipments/{id}/status/archived HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "comment": "Equipment is no longer in use and has been replaced"
}

No content

Example: End-of-life equipment retirement

{
  "comment": "Equipment reached end-of-life and replaced with newer model CAT-2024-001"
}

Example: Equipment sale transition

{
  "comment": "Equipment sold to ABC Construction - reference sale order SO-2024-156"
}

Example: Maintenance removal

{
  "comment": "Removed from active fleet for major overhaul - estimated return Q2 2025"
}

Use this when:

Equipment sales: Transferring ownership to another organization
End-of-life retirement: Equipment no longer economically viable to operate
Long-term maintenance: Extended repairs or refurbishment periods

Equipment Restoration

Returning Equipment to Active Service

Problem: Previously archived equipment needs to return to active operations, resuming data collection and fleet visibility.

Solution: Restore archived equipment to active status to resume normal operations.

Unarchive an equipment

post

/v2/fleet/equipments/{id}/status/active

Restores a previously archived equipment to active status.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Responses

204

Equipment unarchived successfully (no content)

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Equipment must be archived before it can be unarchived

post/v2/fleet/equipments/{id}/status/active

POST /v2/fleet/equipments/{id}/status/active HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

No content

Use this when:

Post-maintenance return: Equipment repairs completed and ready for service
Lease return: Equipment returned from lease and back in your direct fleet

Important considerations:

Data collection resumes immediately upon restoration
Any data that would have been collected during archiving period is permanently unavailable
Equipment returns to your active inventory and operational dashboards
Historical data from before archiving remains fully accessible

Equipment Deletion

Permanently Removing Equipment from Fleet

Problem: Equipment was incorrectly added to your fleet or needs complete removal for data accuracy purposes.

Solution: Delete equipment to completely remove it from your system (requires prior archiving).

Delete an equipment

delete

/v2/fleet/equipments/{id}

Marks the specified equipment as deleted. The equipment must be archived before it can be mark as deleted.

Authorizations

x-access-tokenstringRequired

Generate a JWT when you log in. Use it in your following requests in the header as x-access-token: your-token-here

Path parameters

idinteger · int32Required

ID of the equipment

Responses

204

Equipment deleted successfully (no content)

No content

401

Unable to authenticate the token

application/json

403

Insufficient permissions to access the resource

application/json

404

Resource not found

application/json

409

Equipment cannot be deleted unless it is archived first, or if it is currently involved in an in progress sharing process.

delete/v2/fleet/equipments/{id}

DELETE /v2/fleet/equipments/{id} HTTP/1.1
Host: api.hiboo.io
x-access-token: YOUR_API_KEY
Accept: */*

No content

Use this when:

API integration errors: Equipment incorrectly imported from data sources
Duplicate entries: Multiple records created for the same physical equipment
Data correction: Wrong equipment information that cannot be updated
System cleanup: Removing test or invalid equipment records

Critical considerations:

Equipment must be archived first before deletion
Action is irreversible - equipment disappears entirely from the system
All associated data becomes permanently inaccessible
Use sparingly - archiving is usually the preferred approach

Common Use Cases

Equipment Lifecycle Transitions

Scenario: Manage planned equipment transitions including sales, replacements, and upgrades while maintaining operational continuity.

Strategy:

Plan archiving timing to minimize operational disruption
Document replacement equipment details in archiving comments
Coordinate with maintenance teams for pre-archiving inspections
Ensure proper handover documentation for equipment sales

Example transition management:

Pre-archiving: Complete final maintenance, document condition
Archive with context: "Replaced by CAT-2024-001 - final hours: 8,450"
Sales coordination: Share historical data with buyers if contractually required
Activate replacement: Ensure new equipment integration is complete

Maintenance Management

Scenario: Equipment requires extended maintenance periods that exceed normal operational downtime expectations.

Strategy:

Archive equipment during extended maintenance to stop unnecessary alerts
Use detailed comments to track maintenance scope and timeline
Coordinate with maintenance teams on expected completion dates
Plan for systematic reactivation testing

Maintenance archiving examples:

"Major overhaul - engine rebuild, hydraulic system replacement - ETA 16 weeks"
"Accident damage repair - awaiting insurance approval and parts availability"
"Transmission replacement - specialized repair facility - return date TBD"

Best Practices

Status Change Documentation

Comment Guidelines:

Include specific business reasons for status changes
Reference related equipment, projects, or business events
Provide timeline information when relevant
Use consistent terminology across your organization

Documentation Examples:

Good: "Replaced by newer model DEF-2024-002 due to high maintenance costs - final service hours: 12,450"
Poor: "No longer needed"

Timing Considerations

Archiving Timing:

Archive equipment immediately when removed from service to stop data alerts
Coordinate archiving with maintenance schedules to avoid confusion
Plan archiving around reporting periods to maintain data consistency
Consider operational impact when multiple pieces of equipment are archived simultaneously

PreviousAttaching Documents to Equipment NextConnecting a Data Source via OAuth

Last updated 1 year ago

Was this helpful?