Value match

List stored values for a given object, filtered by an optional glob pattern (e.g. on file name), with required pagination next. The response is JSON: next, values with valueRef, fileName, fileMimeType, and fileSize (bytes).

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

Query parameters#

  • objectstring
    Required

    Unique name of the object in the URL.

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

    Pagination cursor (required): use `0` for the first page; thereafter use the value returned by the previous response as the `next` query parameter. The response body returns the cursor for the next page. A value of `-1` means there is no further page — you have the last page of data.

    example: 0
  • patternstring
    Optional

    Optional glob-style pattern to filter.

    Values

    • pattern
    • *pattern
    • pattern*
    • *pattern*
    example: *

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. Pagination cursor and value metadata rows for this page (JSON body).

    {

      "next": -1,

      "values": [

        {

          "valueRef": "u81kO8O3Pywb1yoxOZ2X6OJiwjihpEY42SQYRzbg",

          "fileName": "photo.png",

          "fileMimeType": "image/png",

          "fileSize": 7

        }

      ]

    }
    • nextnumber

      Pagination cursor (required): use `0` for the first page; thereafter use the value returned by the previous response as the `next` query parameter. The response body returns the cursor for the next page. A value of `-1` means there is no further page — you have the last page of data.

      example: 0
    • valuesarray[object]

      Entries that matched the pattern on this page.

      • values[0].valueRefstring

        Blob identifier.

      • values[0].fileNamestring

        Stored file name.

      • values[0].fileMimeTypestring

        Stored MIME type.

      • values[0].fileSizenumber

        Size of the stored blob in bytes.

  • 401

    Unauthorized.

  • 403

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

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "Invalid request"

    }
    • errornumber

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

    • descstring

      Human-readable description of the error.

Examples#

Match values by pattern

List value metadata for an object; optional glob pattern on names (paginated with next).

curl 'https://api.bigstate.dev/v1/value/match?object=Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6%3Aposition%3Avalueref%40Z5H1QxoGRz5vc6VeNIwwpVC6biVkYTqXe9SGQJJ6&next=0&pattern=*photo*' \

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

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

  --header 'Accept: application/json'
GetDelete

© 2024 BigState