Asset Part API (1.0.0)

Download OpenAPI specification:Download

API for managing asset parts

Asset Part

Operations related to asset part management

Get all asset parts

Retrieve a list of all asset parts 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

Create a new asset part with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
partNumber
required
string

Unique part number

name
required
string

Name of the asset part

description
string

Description of the asset part

partType
required
string

Asset part type ID

manufacturer
string

Manufacturer name

model
string

Part model number

object

Technical specifications

compatibleAssets
Array of strings

List of compatible asset IDs

supplier
string

Primary supplier ID

cost
number <double> >= 0

Current cost of the part

currency
string

Currency code

minStockLevel
integer >= 0

Minimum stock level

maxStockLevel
integer >= 0

Maximum stock level

reorderPoint
integer >= 0

Reorder point threshold

leadTime
integer

Lead time in days

warrantyPeriod
integer

Warranty period in days

category
string

Part category

subcategory
string

Part subcategory

isActive
boolean
Default: true

Whether the part is active

barcode
string

Barcode for the part

qrCode
string

QR code for the part

images
Array of strings <uri>

Part images URLs

Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "partNumber": "EP-001-2023",
  • "name": "Engine Valve",
  • "description": "string",
  • "partType": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "manufacturer": "ABC Manufacturing",
  • "model": "string",
  • "specifications": {
    },
  • "compatibleAssets": [
    ],
  • "supplier": "string",
  • "cost": 0,
  • "currency": "USD",
  • "minStockLevel": 0,
  • "maxStockLevel": 0,
  • "reorderPoint": 0,
  • "leadTime": 7,
  • "warrantyPeriod": 365,
  • "category": "Engine",
  • "subcategory": "Valves",
  • "isActive": true,
  • "barcode": "string",
  • "qrCode": "string",
  • "images": [],
  • "documents": [],
  • "metadata": { }
}

Response samples

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

Get asset part by ID

Retrieve a specific asset part by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part ID

Responses

Response samples

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

Update asset part

Update an existing asset part with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part ID

Request Body schema: application/json
partNumber
required
string

Unique part number

name
required
string

Name of the asset part

description
string

Description of the asset part

partType
required
string

Asset part type ID

manufacturer
string

Manufacturer name

model
string

Part model number

object

Technical specifications

compatibleAssets
Array of strings

List of compatible asset IDs

supplier
string

Primary supplier ID

cost
number <double> >= 0

Current cost of the part

currency
string

Currency code

minStockLevel
integer >= 0

Minimum stock level

maxStockLevel
integer >= 0

Maximum stock level

reorderPoint
integer >= 0

Reorder point threshold

leadTime
integer

Lead time in days

warrantyPeriod
integer

Warranty period in days

category
string

Part category

subcategory
string

Part subcategory

isActive
boolean
Default: true

Whether the part is active

barcode
string

Barcode for the part

qrCode
string

QR code for the part

images
Array of strings <uri>

Part images URLs

Array of objects
object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "partNumber": "EP-001-2023",
  • "name": "Engine Valve",
  • "description": "string",
  • "partType": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "manufacturer": "ABC Manufacturing",
  • "model": "string",
  • "specifications": {
    },
  • "compatibleAssets": [
    ],
  • "supplier": "string",
  • "cost": 0,
  • "currency": "USD",
  • "minStockLevel": 0,
  • "maxStockLevel": 0,
  • "reorderPoint": 0,
  • "leadTime": 7,
  • "warrantyPeriod": 365,
  • "category": "Engine",
  • "subcategory": "Valves",
  • "isActive": true,
  • "barcode": "string",
  • "qrCode": "string",
  • "images": [],
  • "documents": [],
  • "metadata": { }
}

Response samples

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

Delete asset part

Delete an existing asset part

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part ID

Responses

Response samples

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