Storage Information

api-version: 1.0

Retrieves the information about the current storage.

GET  /{collectionId}/{storageId}/_api/rest/info

Parameters

Name	In	Required	Type	Description
collectionId	path	true	string	The ID of the storage collection.
storageId	path	true	string	The ID of the tenant.

Responses

Success 200

Name	Type	Description
type	string	The type of the storage: IStorageContext, IStorageCollectionContext or ISysAdminContext.
tenant	string	The tenant id of the storage.
baseTenat	string	The tenant id of the base storage.
template	string	Name of the storage template.
dataCultures	string[]	Available data cultures in the storage.
defaultDataCulture	string	Default data culture of the storage.
isValid	bool	true if the storage is valid, otherwise false.
region	RegionInfo	The configured region in the storage.
timeZone	TimeZoneInfo	The configured time zone in the storage.

Error 4xx

Name	Type	Description
message	string	The error message.
output	OperationResultOutput	The result output.
type	OperationResultType	The result type.
data	OperationError	The list of errors.

Examples

Get the info of a BPMN storage

Request

GET https://demo.symbioworld.com/pz/showcase/_api/rest/info/

Response (200 OK)

{
    "type": "IStorageContext",
    "tenant": "3ecb1df0-39c6-4816-b5fb-2cb902f3d3e1",
    "title": "showcase",
    "description": "",
    "baseTenant": "069bea6b-a7d4-4fb2-9b50-54f9ff07168c",
    "apiUrl": "https://demo.symbioworld.com/pz/showcase/_api/",
    "appUrl": "https://demo.symbioworld.com/pz/showcase/",
    "template": "Symbio Web Standard (BPMN)",
    "dataCultures": [
        1031,
        1033
    ],
    "defaultDataCulture": 1033,
    "mandatoryCultures": [
        1031,
        1033
    ],
    "optionalCultures": [],
    "isValid": true,
    "region": {
        "name": "DE",
        "englishName": "Germany",
        "displayName": "Germany",
        "nativeName": "Germany",
        "twoLetterISORegionName": "DE",
        "threeLetterISORegionName": "DEU",
        "threeLetterWindowsRegionName": "DEU",
        "isMetric": true,
        "geoId": 94,
        "currencyEnglishName": "Euro",
        "currencyNativeName": "Euro",
        "currencySymbol": "€",
        "isoCurrencySymbol": "EUR"
    },
    "timeZone": {
        "Id": "W. Europe Standard Time",
        "DisplayName": "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna",
        "StandardName": "W. Europe Standard Time",
        "DaylightName": "W. Europe Daylight Time",
        "BaseUtcOffset": "01:00:00",
        "AdjustmentRules": [
            {
                "DateStart": "0001-01-01T00:00:00",
                "DateEnd": "9999-12-31T00:00:00",
                "DaylightDelta": "01:00:00",
                "DaylightTransitionStart": {
                    "TimeOfDay": "0001-01-01T02:00:00",
                    "Month": 3,
                    "Week": 5,
                    "Day": 1,
                    "DayOfWeek": "Sunday",
                    "IsFixedDateRule": false
                },
                "DaylightTransitionEnd": {
                    "TimeOfDay": "0001-01-01T03:00:00",
                    "Month": 10,
                    "Week": 5,
                    "Day": 1,
                    "DayOfWeek": "Sunday",
                    "IsFixedDateRule": false
                },
                "BaseUtcOffsetDelta": "00:00:00"
            }
        ],
        "SupportsDaylightSavingTime": true
    }
}

Definitions

OperationResultOutput

Name	Type
volatile	string
permanent	string
dialog	string
inline	string

OperationResultType

Name	Type
critical	string
error	string
warning	string
success	string
unauthorized	string

OperationError

Name	Type	Description
error	string	The error message.