Skip to main content
POST
Create an asset

Autorizaciones

X-API-KEY
string
header
requerido
OW-KEY
string
header
requerido

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Cuerpo

application/json
name
string
requerido
assetTypeId
integer
requerido
locationId
integer
requerido
isActive
boolean
requerido
isLeased
boolean
requerido
id
integer | null

Present only when upserting an existing asset.

assetUUID
string | null
assetNumber
string | null
description
string | null
images
string[] | null
attachments
object[] | null
qrCodeImages
object[] | null
serialNumberImages
object[] | null
manufacturer
string | null
upcNumber
string | null
modelNumber
string | null
serialNumber
string | null
assetModelId
integer | null
assetTypeDetails
object[] | null
areaId
integer | null
brand
string | null
installDate
string<date-time> | null
purchaseDate
string<date-time> | null
leaseStartDate
string<date-time> | null
leaseEndDate
string<date-time> | null
warrantyIds
integer[] | null
partWarrantyId
integer | null
lifeExpectancyInMonths
integer | null
originalPrice
number | null
capitalisedCost
number | null
isReplacementEquipment
boolean | null
replacementEquipmentTypeId
integer | null
lastTaggedAt
string<date-time> | null
assetTags
string[] | null
parentId
integer | null

Parent asset id (sub-asset). Must not equal the asset's own id.

checkInNotes
object | null
checkOutNotes
object | null
availabilityStatus
string | null

Defaults to "available".

downtimeStatus
string | null

Defaults to "online".

additionalAssetDetails
object | null
partsVendorId
integer | null
vendorId
integer | null
externalSpend
number | null
userOverrideReplacementRecommendation
string | null
userOverrideReplacementRecommendationNotes
string | null
isRefrigerantTracked
boolean | null

Omitted or null keeps the stored value; enrolment is turned off only by an explicit false.

refrigerantTypeCode
string | null
fullChargeLb
number | null
applianceCategory
string | null
refrigerantRequiresProcessShutdown
boolean | null

Respuesta

Success.

type
string
requerido

Entity type marker, e.g. "Asset".

data
object
requerido

Asset. ABRIDGED: the full case class carries further fields (warranties, depreciation, spend rollups, meters, refrigerant retrofit plan, equipment/purchase-order links, etc.) that may appear in responses.

status
enum<string>
requerido
Opciones disponibles:
ok