Asset Part Unit API (1.0.0)

Download OpenAPI specification:Download

API for managing asset part units (individual instances of parts)

Asset Part Unit

Operations related to asset part unit management

Get all asset part units

Retrieve a list of all asset part units with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part unit

Create a new asset part unit with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "assignedTo": {
    },
  • "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": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part unit by ID

Retrieve a specific asset part unit by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part unit

Update an existing asset part unit with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit ID

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "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": {
    },
  • "assignedTo": {
    },
  • "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": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part unit

Delete an existing asset part unit

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part unit ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part unit deleted successfully"
}