Asset
Query and manage assets, attributes, hierarchy, and user-to-asset links
Delete assets
Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
Create an asset
Creates an asset in an accessible realm and returns the persisted representation. The server generates an ID when absent; supplied IDs must be globally unique and 22 characters long.
Write values to multiple asset attributes
Submits a batch of attribute states using current server time and returns one result per input item. Authorization and processing failures are encoded in each AttributeWriteResult rather than returned as an HTTP error.
Write timestamped values to multiple asset attributes
Submits a batch of complete attribute events and returns one result per input item. Supplied timestamps are preserved; authorization and processing failures are encoded per result rather than returned as an HTTP error.
Count assets using a query
Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
Move assets to the realm root
Clears the parent reference of every asset listed in repeated assetIds query parameters.
Retrieve a partially loaded asset
Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
Retrieve assets using a query
Executes an AssetQuery after constraining realm and linked-asset access. Anonymous callers receive public-readable assets only; the query select clause controls which fields are populated.
Retrieve an optimized asset tree using a query
Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
Retrieve assets accessible to the current user
Returns partial linked assets for a restricted user, root assets for an unrestricted realm user, and an empty array for a super user. Attributes and paths are omitted; use getAsset for full details.
Retrieve links between assets and users
Returns user-asset links in the required realm, optionally filtered by userId and assetId. Missing users or assets produce an empty result; restricted users cannot call this operation.
Create links between users and assets
Creates all supplied links as one operation. Every item must identify the same realm and user, and every referenced realm, user, and asset must exist.
Delete user asset links
Removes all supplied links. Every item must identify the same realm and user.
Delete all links for a user
Removes every asset link belonging to the user in the requested realm.
Delete a link between an asset and user
Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
Retrieve an asset
Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
Update an asset
Replaces mutable asset data while preserving the path identifier. Realm, parent, restricted-user, and private-metadata rules are validated; disallowed restricted-user fields may be ignored.
Write a value to one asset attribute
Submits an asynchronous attribute write using the current server time. The result reports whether the event was accepted, not whether downstream processing ultimately succeeded. Anonymous writes require public-write metadata.
Write a timestamped value to one asset attribute
Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
Move assets below a new parent
Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.