Version get

Returns a JSON array of version rows for the object: each item has rec, at, and version (timestamps in ISO 8601 with offset).

GET
{{host}}/v1/version?object={{object name}}
VERB:GET
BASE URL:{{host}}/v1/version
QUERY STRING:?object={{object name}}

Query parameters#

  • objectstring
    Required

    Unique name of the object in the URL.

    format:
    abc:0-9@owner

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*
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

See authentication headers here.

Response parameters#

  • 200Response body · object

    Success. **JSON array** (root is the array, not an object): one object per row with **`rec`**, **`at`**, and **`version`**.

    [

      {

        "rec": "2026-03-10T12:20:49.9206295+00:00",

        "at": "2023-04-24T20:15:10.0000000+00:00",

        "version": 1

      }

    ]
    • responsearray[object]

      Root JSON value is this array (not wrapped in an object).

      • response[0].recstring

        Server record timestamp for this row (ISO 8601 with offset).

      • response[0].atstring

        Logical timestamp of the state value (ISO 8601 with offset).

      • response[0].versionnumber

        State version number (same notion as in `GET /v1/state`).

  • 401

    Unauthorized.

  • 403

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

  • 404

    No state or object data exists for the given name.

  • 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#

Get subject state version

JSON array of `{ rec, at, version }` rows for the object.

curl 'https://api.bigstate.dev/v1/version?object=Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6%3Aposition%40Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6' \

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

  --header 'Content-Type: application/json' \

  --header 'Accept: application/json'
DeleteSign in

© 2024 BigState