Asset Part Type API (1.0.0)

Download OpenAPI specification:Download

API for managing asset part types

Asset Part Type

Operations related to asset part type management

Get all asset part types

Retrieve a list of all asset part types 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 type

Create a new asset part type with the provided data

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

Name of the asset part type

description
string

Description of the asset part type

category
required
string

Category of the asset part type

subcategory
string

Subcategory of the asset part type

object

Technical specifications

compatibleAssetTypes
Array of strings

List of compatible asset type IDs

object
warrantPeriod
integer

Warranty period in days

supplier
string

Default supplier ID

standardCost
number <double> >= 0

Standard cost of the part

isActive
boolean
Default: true

Whether the part type is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Engine Parts",
  • "description": "string",
  • "category": "Mechanical",
  • "subcategory": "string",
  • "specifications": {
    },
  • "compatibleAssetTypes": [
    ],
  • "maintenanceSchedule": {
    },
  • "warrantPeriod": 365,
  • "supplier": "string",
  • "standardCost": 0,
  • "isActive": true,
  • "metadata": { }
}

Response samples

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

Get asset part type by ID

Retrieve a specific asset part type by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part type ID

Responses

Response samples

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

Update asset part type

Update an existing asset part type with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part type ID

Request Body schema: application/json
name
required
string

Name of the asset part type

description
string

Description of the asset part type

category
required
string

Category of the asset part type

subcategory
string

Subcategory of the asset part type

object

Technical specifications

compatibleAssetTypes
Array of strings

List of compatible asset type IDs

object
warrantPeriod
integer

Warranty period in days

supplier
string

Default supplier ID

standardCost
number <double> >= 0

Standard cost of the part

isActive
boolean
Default: true

Whether the part type is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Engine Parts",
  • "description": "string",
  • "category": "Mechanical",
  • "subcategory": "string",
  • "specifications": {
    },
  • "compatibleAssetTypes": [
    ],
  • "maintenanceSchedule": {
    },
  • "warrantPeriod": 365,
  • "supplier": "string",
  • "standardCost": 0,
  • "isActive": true,
  • "metadata": { }
}

Response samples

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

Delete asset part type

Delete an existing asset part type

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part type ID

Responses

Response samples

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