REST API

This is the manual for older MicroStream versions (Version < 5.0).

The new documentation (Version >= 5.0) is located at:

https://docs.microstream.one/

Root

GET [instance-name]/root

Returns the name and object id of the current storage root element.

200 http://localhost:4567/microstream/root

{
    name: "ROOT",
    objectId: "1000000000000000028"
}

Object

GET [instance-name]/object/:objectid

Returns description and values of a distinct object.

Path Parameters

Name	Type	Description
objectid	integer	The requested object's id

Query Parameters

Name	Type	Description
valueLength	integer	Limit size of returned value elements, e.g. String values. Default is unlimited.
fixedOffset	integer	Fixed size members start offset, default is 0.
fixedLength	integer	Amount of returned fixed size members, default is unlimited.
variableOffset	integer	Variable size members start offset, default is 0.
variableLength	integer	Amount of returned variable size members, default is unlimited.
references	boolean	Determines if top-level references of the object should be returned as well.

200 http://localhost:4567/microstream/object/1000000000000000028

{
    "objectId": "1000000000000000028",
    "typeId": "110",
    "length": "0",
    "variableLength": [
    "3"
    ],
    "simplified": false,
    "data": [
        [
            "1000000000000000029",
            "1000000000000000030",
            "1000000000000000031"
        ]
    ],
    "references": null
}

404 http://localhost:4567/microstream/object/1000000000000000123

No entity found for objectId 1000000000000000123

Type Dictionary

GET [instance-name]/dictionary

The type dictionary as plain text.

200 http://localhost:4567/microstream/dictionary

[Type dictionary contents]

Statistics

GET [instance-name]/maintenance/filesStatistics

Statistics of the used storage files and channels.

200 http://localhost:4567/maintenance/filesStatistics

{
    "creationTime": "2020-04-15T13:32:26.003Z",
    "channelStatistics": {
        "0": {
            "channelIndex": 0,
            "files": [
                {
                    "fileNumber": "1",
                    "file": "storage\\channel_0\\channel_0_1.dat",
                    "fileCount": "1",
                    "liveDataLength": "2898",
                    "totalDataLength": "2930"
                }
            ],
            "fileCount": "1",
            "liveDataLength": "2898",
            "totalDataLength": "2930"
        }
    },
    "fileCount": "1",
    "liveDataLength": "2898",
    "totalDataLength": "2930"
}