SYsysadminsmedia
Entities

Patch Entity

Changed on
patch/v1/entities/{id}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Path parameters

idstring required

Entity ID

Request body

entityTypeIdstring nullable
idstring
locationIdstring nullable
parentIdstring nullable
quantitynumber nullable
tagIdsstring[] nullable

Response

OK

archivedboolean
assetIdstring
createdAtstring
descriptionstring
idstring
imageIdstring nullable
insuredboolean
itemCountnumber

Container-specific (populated when querying locations)

lifetimeWarrantyboolean

Warranty

locationIdstring nullable

LocationID is set only when this entity has its own location, nil when inherited. Same name as the EntityUpdate field so a GET/PUT round trip doesn't pin an inherited location or drop an explicit one.

manufacturerstring
modelNumberstring
namestring
notesstring

Extras

purchaseDatestring

Purchase

purchaseFromstring
purchasePricenumber
quantitynumber
serialNumberstring
soldDatestring

Sold

soldNotesstring
soldPricenumber
soldTostring
syncChildEntityLocationsboolean
thumbnailIdstring nullable
totalPricenumber
updatedAtstring
warrantyDetailsstring
warrantyExpiresstring

Changes