Skip to Navigation
StreamDocs is used to stream documents which match chosen criteria from a database.
curl \
http://{serverName}/databases/{databaseName}/streams/docs? \
etag={etag}& \
startsWith={startsWith}& \
matches={matches}& \
exclude={exclude}& \
skipAfter={skipAfter}& \
start={start}& \
pageSize={pageSize} \
-X GET| Query parameter | Required | Description |
|---|---|---|
| etag | No | ETag of a document from which stream should start (mutually exclusive with 'startsWith') |
| startsWith | No | prefix for which documents should be streamed (mutually exclusive with 'etag') |
| matches | No | pipe ('|') separated values for which document keys (after 'keyPrefix') should be matched ('?' any single character, '*' any characters) |
| exclude | No | pipe ('|') separated values for which document keys (after 'keyPrefix') should not be matched ('?' any single character, '*' any characters) |
| skipAfter | No | skip document fetching until given key is found and return documents after that key |
| start | No | number of documents that should be skipped |
| pageSize | No | maximum number of documents that will be retrieved |
| Header | Required | Description |
|---|---|---|
| Single-Use-Auth-Token | No | Required if authentication is enabled. |
| Status code | Description |
|---|---|
200 |
OK |
| Return Value | Description |
|---|---|
| Results | list of json documents |
Streams products.
curl -X GET "http://localhost:8080/databases/NorthWind/streams/docs?startsWith=products%2F"
< HTTP/1.1 200 OK
{"Results": [ jsonDocument, jsonDocument, ... ] }Dear User,
By browsing on this website you are agreeing to our ‘Terms & Conditions’ and the ‘Privacy Policy’ in regards to your rights and personal data handling.