Streams
Endpoints to work with streams.
For the definition of the stream and explanation how it should be used, see this page.
You need to be authenticated and have your OAuth access token before sending requests. See authentication for more details.
POST/database/{$databaseName}/stream
Open a stream
POST Example
curl \
-X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {YOUR_ACCESS_TOKEN}' \
-d '' \
https://dtxs-server.example.com/database/TestDatabase/documentsParameters
| Parameter | Required | Description | Example |
|---|---|---|---|
| databaseName | yes, extracted from endpoint URL | Name of the database where the document is. | TestDatabase |
Responses
| Code | Description | Return value | Example |
|---|---|---|---|
| 200 | Success. | UID of a chuck of a sent document | 1683e60c-e85b-11ef-b10c-04bf1ba25820 |
| 400 | Unknown error. | ||
| 401 | Not authorized. | ||
| 404 | Database does not exist. | ||
| 406 | Format of the request is not valid. |