SYsysadminsmedia
Entities

Update Entity

Changed on
put/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

archivedboolean
assetIdstring
descriptionstring
entityTypeIdstring nullable
idstring
insuredboolean
lifetimeWarrantyboolean

Warranty

locationIdstring nullable

Only needed when ParentID is another item and this lives elsewhere (#1688). Otherwise ParentID carries the location. See resolveLocationOverride.

manufacturerstring
modelNumberstring
namestring required
notesstring

Extras

parentIdstring nullable
purchaseDatestring

Purchase

purchaseFromstring
purchasePricenumber nullable
quantitynumber
serialNumberstring

Identifications

soldDatestring

Sold

soldNotesstring
soldPricenumber nullable
soldTostring
syncChildEntityLocationsboolean
tagIdsstring[]

Edges

warrantyDetailsstring
warrantyExpiresstring

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