Download OpenAPI specification:Download
API for managing asset part units (individual instances of parts)
Retrieve a list of all asset part units with optional filtering and pagination
| limit | integer [ 1 .. 100 ] Default: 50 Maximum number of records to return |
| offset | integer >= 0 Default: 0 Number of records to skip for pagination |
| sort | string Field to sort by |
| order | string Default: "desc" Enum: "asc" "desc" Sort order (asc or desc) |
| filter | string Filter conditions in JSON format |
| search | string Search term for text fields |
{- "success": true,
- "data": [
- {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "serialNumber": "SN-EP001-2023-001",
- "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
- "batchNumber": "BATCH-2023-001",
- "lotNumber": "string",
- "manufactureDate": "2023-01-15",
- "expiryDate": "2019-08-24",
- "receiptDate": "2023-01-20T10:00:00Z",
- "status": "available",
- "condition": "new",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string"
}, - "assignedTo": {
- "asset": "string",
- "workOrder": "string",
- "technician": "string",
- "date": "2019-08-24T14:15:22Z"
}, - "installationDate": "2019-08-24T14:15:22Z",
- "lastMaintenanceDate": "2019-08-24T14:15:22Z",
- "nextMaintenanceDate": "2019-08-24T14:15:22Z",
- "warrantyExpiry": "2019-08-24",
- "cost": 0,
- "supplier": "string",
- "purchaseOrder": "string",
- "invoice": "string",
- "notes": "string",
- "maintenanceHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "inspection",
- "description": "string",
- "technician": "string",
- "cost": 0
}
], - "customFields": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
], - "total": 0
}Create a new asset part unit with the provided data
| serialNumber required | string Serial number of the part unit |
| assetPart required | string Asset part ID this unit belongs to |
| batchNumber | string Batch number |
| lotNumber | string Lot number |
| manufactureDate | string <date> Manufacturing date |
| expiryDate | string <date> Expiry date (if applicable) |
| receiptDate | string <date-time> Date when the unit was received |
| status required | string Default: "available" Enum: "available" "reserved" "in-use" "maintenance" "disposed" "returned" Current status of the part unit |
| condition | string Default: "new" Enum: "new" "good" "fair" "poor" "damaged" Physical condition of the part unit |
object | |
object | |
| installationDate | string <date-time> Date when the unit was installed |
| lastMaintenanceDate | string <date-time> Last maintenance date |
| nextMaintenanceDate | string <date-time> Next scheduled maintenance date |
| warrantyExpiry | string <date> Warranty expiry date |
| cost | number <double> >= 0 Cost of this specific unit |
| supplier | string Supplier ID |
| purchaseOrder | string Purchase order reference |
| invoice | string Invoice reference |
| notes | string Additional notes |
object Custom fields | |
object Additional metadata |
{- "serialNumber": "SN-EP001-2023-001",
- "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
- "batchNumber": "BATCH-2023-001",
- "lotNumber": "string",
- "manufactureDate": "2023-01-15",
- "expiryDate": "2019-08-24",
- "receiptDate": "2023-01-20T10:00:00Z",
- "status": "available",
- "condition": "new",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string"
}, - "assignedTo": {
- "asset": "string",
- "workOrder": "string",
- "technician": "string",
- "date": "2019-08-24T14:15:22Z"
}, - "installationDate": "2019-08-24T14:15:22Z",
- "lastMaintenanceDate": "2019-08-24T14:15:22Z",
- "nextMaintenanceDate": "2019-08-24T14:15:22Z",
- "warrantyExpiry": "2019-08-24",
- "cost": 0,
- "supplier": "string",
- "purchaseOrder": "string",
- "invoice": "string",
- "notes": "string",
- "customFields": { },
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "serialNumber": "SN-EP001-2023-001",
- "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
- "batchNumber": "BATCH-2023-001",
- "lotNumber": "string",
- "manufactureDate": "2023-01-15",
- "expiryDate": "2019-08-24",
- "receiptDate": "2023-01-20T10:00:00Z",
- "status": "available",
- "condition": "new",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string"
}, - "assignedTo": {
- "asset": "string",
- "workOrder": "string",
- "technician": "string",
- "date": "2019-08-24T14:15:22Z"
}, - "installationDate": "2019-08-24T14:15:22Z",
- "lastMaintenanceDate": "2019-08-24T14:15:22Z",
- "nextMaintenanceDate": "2019-08-24T14:15:22Z",
- "warrantyExpiry": "2019-08-24",
- "cost": 0,
- "supplier": "string",
- "purchaseOrder": "string",
- "invoice": "string",
- "notes": "string",
- "maintenanceHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "inspection",
- "description": "string",
- "technician": "string",
- "cost": 0
}
], - "customFields": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Retrieve a specific asset part unit by its ID
| id required | string Asset part unit ID |
{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "serialNumber": "SN-EP001-2023-001",
- "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
- "batchNumber": "BATCH-2023-001",
- "lotNumber": "string",
- "manufactureDate": "2023-01-15",
- "expiryDate": "2019-08-24",
- "receiptDate": "2023-01-20T10:00:00Z",
- "status": "available",
- "condition": "new",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string"
}, - "assignedTo": {
- "asset": "string",
- "workOrder": "string",
- "technician": "string",
- "date": "2019-08-24T14:15:22Z"
}, - "installationDate": "2019-08-24T14:15:22Z",
- "lastMaintenanceDate": "2019-08-24T14:15:22Z",
- "nextMaintenanceDate": "2019-08-24T14:15:22Z",
- "warrantyExpiry": "2019-08-24",
- "cost": 0,
- "supplier": "string",
- "purchaseOrder": "string",
- "invoice": "string",
- "notes": "string",
- "maintenanceHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "inspection",
- "description": "string",
- "technician": "string",
- "cost": 0
}
], - "customFields": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}Update an existing asset part unit with new data
| id required | string Asset part unit ID |
| serialNumber required | string Serial number of the part unit |
| assetPart required | string Asset part ID this unit belongs to |
| batchNumber | string Batch number |
| lotNumber | string Lot number |
| manufactureDate | string <date> Manufacturing date |
| expiryDate | string <date> Expiry date (if applicable) |
| receiptDate | string <date-time> Date when the unit was received |
| status required | string Default: "available" Enum: "available" "reserved" "in-use" "maintenance" "disposed" "returned" Current status of the part unit |
| condition | string Default: "new" Enum: "new" "good" "fair" "poor" "damaged" Physical condition of the part unit |
object | |
object | |
| installationDate | string <date-time> Date when the unit was installed |
| lastMaintenanceDate | string <date-time> Last maintenance date |
| nextMaintenanceDate | string <date-time> Next scheduled maintenance date |
| warrantyExpiry | string <date> Warranty expiry date |
| cost | number <double> >= 0 Cost of this specific unit |
| supplier | string Supplier ID |
| purchaseOrder | string Purchase order reference |
| invoice | string Invoice reference |
| notes | string Additional notes |
object Custom fields | |
object Additional metadata |
{- "serialNumber": "SN-EP001-2023-001",
- "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
- "batchNumber": "BATCH-2023-001",
- "lotNumber": "string",
- "manufactureDate": "2023-01-15",
- "expiryDate": "2019-08-24",
- "receiptDate": "2023-01-20T10:00:00Z",
- "status": "available",
- "condition": "new",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string"
}, - "assignedTo": {
- "asset": "string",
- "workOrder": "string",
- "technician": "string",
- "date": "2019-08-24T14:15:22Z"
}, - "installationDate": "2019-08-24T14:15:22Z",
- "lastMaintenanceDate": "2019-08-24T14:15:22Z",
- "nextMaintenanceDate": "2019-08-24T14:15:22Z",
- "warrantyExpiry": "2019-08-24",
- "cost": 0,
- "supplier": "string",
- "purchaseOrder": "string",
- "invoice": "string",
- "notes": "string",
- "customFields": { },
- "metadata": { }
}{- "success": true,
- "data": {
- "_id": "60f7b1b3e4b0e8b3f8b3f8b3",
- "serialNumber": "SN-EP001-2023-001",
- "assetPart": "60f7b1b3e4b0e8b3f8b3f8b4",
- "batchNumber": "BATCH-2023-001",
- "lotNumber": "string",
- "manufactureDate": "2023-01-15",
- "expiryDate": "2019-08-24",
- "receiptDate": "2023-01-20T10:00:00Z",
- "status": "available",
- "condition": "new",
- "location": {
- "warehouse": "string",
- "section": "string",
- "shelf": "string",
- "position": "string"
}, - "assignedTo": {
- "asset": "string",
- "workOrder": "string",
- "technician": "string",
- "date": "2019-08-24T14:15:22Z"
}, - "installationDate": "2019-08-24T14:15:22Z",
- "lastMaintenanceDate": "2019-08-24T14:15:22Z",
- "nextMaintenanceDate": "2019-08-24T14:15:22Z",
- "warrantyExpiry": "2019-08-24",
- "cost": 0,
- "supplier": "string",
- "purchaseOrder": "string",
- "invoice": "string",
- "notes": "string",
- "maintenanceHistory": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "inspection",
- "description": "string",
- "technician": "string",
- "cost": 0
}
], - "customFields": { },
- "metadata": { },
- "createdAt": "2023-01-15T08:00:00Z",
- "updatedAt": "2023-01-15T10:30:00Z"
}
}