REST API

GET Root

[instance-name]/root
javascript

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

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

GET Object

[instance-name]/object/:objectid
javascript

Returns description and values of a distinct object.

Path parameters
Parameter Type Description

objectId

long

The requested object’s id
Query parameters
Parameter Type Description Default

valueLength

long

Limit size of returned value elements, e.g. String values.

unlimited

fixedOffset

long

Fixed size members start offset.

0

fixedLength

long

Amount of returned fixed size members.

unlimited

variableOffset

long

Variable size members start offset.

0

variableLength

long

Amount of returned variable size members.

unlimited

references

boolean

Determines if top-level references of the object should be returned as well.

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

GET Type Dictionary

[instance-name]/dictionary
javascript

Returns the type dictionary as text output.

Response
[Type dictionary contents]
json

GET Statistics

[instance-name]/maintenance/filesStatistics
javascript

Returns statistics of the used storage files and channels.

Response
{
	"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"
}
json