Value get

Download a stored blob by object and valueRef. The response body is raw bytes (not JSON). Content-Type and the suggested filename in Content-Disposition come from the filemimetype and filename you sent when this blob was uploaded (POST /v1/value), so they stay aligned with that upload — not with whatever file you may be comparing to locally.

GET
{{host}}/v1/value?object={{object}}&valueRef={{valueRef}}
VERB:GET
BASE URL:{{host}}/v1/value
QUERY STRING:?object={{object}}&valueRef={{valueRef}}

Query parameters#

  • objectstring
    Required

    Unique name of the object in the URL.

    format:
    abc:0-9@owner
  • valueRefstring
    Required

    Identifier returned when the blob was stored (POST).

    example: Mqn0WDHP8cuLYkMIjxAqmSdz8vRkTDDhB5Ie6Sn3

Headers#

Send these headers with the request. Names are case-insensitive per HTTP rules.
  • x-api-keyRequired

    Your BigState API key.

    *provide api key here*

See authentication headers here.

Response parameters#

  • 200Response body · object

    Success. Response body is raw bytes. `Content-Type` and `Content-Disposition` (suggested filename) come from metadata stored at upload (`filemimetype` and `filename` on POST), so the download name matches that upload, not an arbitrary client label.

    • bodyany

      Raw file bytes (not JSON).

  • 401

    Unauthorized.

  • 403

    Access denied. The caller does not have sufficient rights to perform this operation.

  • 404

    No blob exists for this object and valueRef.

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "\"Object must be formatted as object"

    }
    • errornumber

      Numeric error code. See the error codes reference for the full list.

    • descstring

      Human-readable description of the error.

Examples#

Download blob by valueRef

GET returns raw bytes for the stored object and reference.

curl 'https://api.bigstate.dev/v1/value?object=Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6%3Aposition%3Avalueref%40Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6&valueRef=Mqn0WDHP8cuLYkMIjxAqmSdz8vRkTDDhB5Ie6Sn3' \

  --header 'x-api-key: YOUR_API_KEY'
UploadMatch

© 2024 BigState