SYsysadminsmedia
Entities

Create Entity

Changed on
post/v1/entities

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

Request body

descriptionstring
entityTypeIdstring nullable
locationIdstring nullable

Only needed when ParentID is another item and this lives elsewhere (#1688).

manufacturerstring nullable
modelNumberstring nullable

Identifications — optional at create time; populated e.g. by the barcode product-search import flow (#1578).

namestring required
parentIdstring nullable
quantitynumber
tagIdsstring[]

Edges

Response

Created

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