Value

A value is raw binary data stored separately from object state. Upload returns an opaque valueRef; you attach that reference when setting state so large files, images, or other blobs stay out of the inline state body. Download returns the bytes; list returns metadata (name, MIME type, size) without the payload.

Values belong to a fully qualified object name. Always use the same object and exact valueRef pair for download, list filters, and delete.

Typical flow#

Upload bytes → valueRef → set state with valueRef → download when a client needs the file
  1. Upload the blob as raw application/octet-stream (optional filename / filemimetype metadata).
  2. Set state with valueRef (not value or mutation in the same request).
  3. Download later by object + valueRef, or resolve a valueRef returned from get state.

Prefer values when the payload is binary or too large for a comfortable inline JSON/number/string state. Keep small structured data as inline state instead.

When to use these endpoints#

  • Upload before publishing state that should point at a file
  • Download when a client needs the bytes (UI preview, processing, export)
  • List to inventory references and metadata under an object
  • Delete blobs you no longer need (confirm nothing still depends on that valueRef)

Endpoints#

© 2024 BigState