| Back | Main view

Product:	IMiS/StorageConnector Services REST
Release:	9.9.2210
Date:	07/26/2023

Case:

Entity content streaming using IMiS/Storage Connector Services REST

Description:

This example demonstrates operations which are used for streaming entity object content on the IMiS/ARChive Server.

Requests and responses are in JSON format.

Below is a description of operations for the streaming entity content.

1. Open entity object stream

Operation opens entity object stream and stream handle is returned. Operation requires entity handle and object identifier.

Request
GET archives/{archiveId}/entities/H:{entityHandle}/objects/{objectId}/stream/open.json

Headers:
- Authorization: Bearer <session-token>

Response

Body:
{
  "handle": "<stream-handle>"
}

2. Read entity object partial stream

Operation reads entity object stream with specified bytes in range header.

Request
GET archives/{archiveId}/entities/H:{entityHandle}/objects/{objectId}/stream/{streamHandle}

Headers:
- Authorization: Bearer <session-token>
- Range: bytes=[beginning of content part in bytes]-[end of content part in bytes (optional)]
  - example of range header value: bytes=0-10

Response

Headers:
- Content-Range: bytes [beginning of content part in bytes]-[end of content part in bytes]/[total length of content part in bytes]
  - example of Content-Range header: bytes 0-9/93847
- Content-Type: MIME type of the content part

Body:
<content-bytes>

3. Close entity object stream

Operation closes entity object stream.

Request
GET archives/{archiveId}/entities/H:{entityHandle}/objects/{objectId}/stream/{streamHandle}/close.json

Headers:
- Authorization: Bearer <session-token>

Response

Operation returns status 200.



Related Documents:



| Back | Main view