Property | Value |
Model name | CDM V01 |
Technical name | |
Description | |
Author | |
DB vendor | Plain JSON--no DB |
Version | |
Comments |
Property | Value |
Group name | ConstructionManagement |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Defects |
Technical name | |
Activated | true |
Id | |
Description | |
Group | ConstructionManagement |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
DefectsId | string | false | |||
ProjectId | string | false |
Property | Value |
Name | DefectsId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Defects", "additionalProperties": false, "properties": { "DefectsId": { "type": "string" }, "ProjectId": { "type": "string" } } }
{ "DefectsId": "Lorem", "ProjectId": "Lorem" }
Property | Value |
Document name | WarrantiesClaims |
Technical name | |
Activated | true |
Id | |
Description | |
Group | ConstructionManagement |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ClaimId | string | false |
Property | Value |
Name | ClaimId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "WarrantiesClaims", "additionalProperties": false, "properties": { "ClaimId": { "type": "string" } } }
{ "ClaimId": "Lorem" }
Property | Value |
Group name | Digital Twin |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | AreaMeasurement |
Technical name | ArMsrmnt |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
AreaMeasurementId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
Standard | string | false | Area measurement standard e.g: GIF, DIN, Not Defined | ||
Type | string | false | Type of the standard area e.g: NF2, circulation area | ||
Value | number | false | Value of measurement e.g: 200; 100.66; 16.76 | [{"dataType":"float"}] | |
Unit | string | false | Unit area is measured with e.g: m², ft² | ||
ValidFrom | string | false | Date measurement was taken e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date measurement is not valid anymore /needs to be renewed | [{"dataType":"dateTime"}] | |
SiteId | string | false | fk | Reference to the site measurement belongs to | |
LandId | string | false | fk | Reference to the land measurement belongs to | |
BuildingId | string | false | fk | Reference to the building measurement belongs to. | |
UnitId | string | false | fk | Reference to the unit measurement belongs to | |
SpaceId | string | false | fk | Reference to the space measurement belongs to | |
FloorId | string | false | fk | Reference to the floor measurement belongs to | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | AreaMeasurementId |
Technical name | ArMsrmntd |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Standard |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Area measurement standard e.g: GIF, DIN, Not Defined |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | Typ |
Activated | true |
Id | |
Type | string |
Description | Type of the standard area e.g: NF2, circulation area |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | Vl |
Activated | true |
Id | |
Type | number |
Description | Value of measurement e.g: 200; 100.66; 16.76 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | Unt |
Activated | true |
Id | |
Type | string |
Description | Unit area is measured with e.g: m², ft² |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | VldFrm |
Activated | true |
Id | |
Type | string |
Description | Date measurement was taken e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date measurement is not valid anymore /needs to be renewed |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the site measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LandId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the land measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Land |
Foreign field | LandId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | Bldngd |
Activated | true |
Id | |
Type | string |
Description | Reference to the building measurement belongs to. |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | UnitId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the unit measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Unit |
Foreign field | UnitId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceId |
Technical name | Spcd |
Activated | true |
Id | |
Type | string |
Description | Reference to the space measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Space |
Foreign field | SpaceId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the floor measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Floor |
Foreign field | FloorId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "AreaMeasurement", "additionalProperties": false, "properties": { "ArMsrmntd": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "Standard": { "type": "string", "description": "Area measurement standard e.g: GIF, DIN, Not Defined" }, "Typ": { "type": "string", "description": "Type of the standard area e.g: NF2, circulation area" }, "Vl": { "type": "number", "description": "Value of measurement e.g: 200; 100.66; 16.76" }, "Unt": { "type": "string", "description": "Unit area is measured with e.g: m², ft²" }, "VldFrm": { "type": "string", "description": "Date measurement was taken e.g: 10.10.20" }, "ValidUntil": { "type": "string", "description": "Date measurement is not valid anymore /needs to be renewed" }, "SiteId": { "type": "string", "description": "Reference to the site measurement belongs to" }, "LandId": { "type": "string", "description": "Reference to the land measurement belongs to" }, "Bldngd": { "type": "string", "description": "Reference to the building measurement belongs to." }, "UnitId": { "type": "string", "description": "Reference to the unit measurement belongs to" }, "Spcd": { "type": "string", "description": "Reference to the space measurement belongs to" }, "FloorId": { "type": "string", "description": "Reference to the floor measurement belongs to" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "ArMsrmntd": "Lorem", "Standard": "Lorem", "Typ": "Lorem", "Vl": -91, "Unt": "Lorem", "VldFrm": "Lorem", "ValidUntil": "Lorem", "SiteId": "Lorem", "LandId": "Lorem", "Bldngd": "Lorem", "UnitId": "Lorem", "Spcd": "Lorem", "FloorId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | BSensingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
BSensingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the BSensingObject belongs to | |
Type | string | false | Type of sensing object e.g: fire alarm system, gas-warning system, smoke detectors | ||
Class | string | false | Class of object in this case sensing object | ||
Name | string | false | Name of sensing object | ||
TransferSystem | string | false | Does a transfer system exists (Y/N) | ||
NetworkTopology | string | false | Description of network topology | ||
PowerSupply | string | false | Power supply of sensing object e.g: long-term battery, short-term battery, centralised supply | ||
NumberOfAntennae | number | false | Number of antennae | ||
NumberOfAutomatic Sensors | number | false | Number of automatic sensors | ||
NumberOfCameras | number | false | Number of cameras | ||
NumberOfMonitors | number | false | Number of monitors | ||
NumberOfBoosters | number | false | Number of boosters | ||
NumberOfSignalingDevice | number | false | Number of signaling devices | ||
NumberOfSmokeExtractors | number | false | Number of smoke extractors | ||
NumberOfSubstations | number | false | Number of substations | ||
RingPiping | string | false | Info on piping seal |
Property | Value |
Name | BSensingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the BSensingObject belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of sensing object e.g: fire alarm system, gas-warning system, smoke detectors |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Class of object in this case sensing object |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of sensing object |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TransferSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Does a transfer system exists (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NetworkTopology |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Description of network topology |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PowerSupply |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Power supply of sensing object e.g: long-term battery, short-term battery, centralised supply |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfAntennae |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of antennae |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfAutomatic Sensors |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of automatic sensors |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfCameras |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of cameras |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfMonitors |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of monitors |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfBoosters |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of boosters |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfSignalingDevice |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of signaling devices |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfSmokeExtractors |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of smoke extractors |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfSubstations |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of substations |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RingPiping |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Info on piping seal |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "BSensingObject", "additionalProperties": false, "properties": { "BSensingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the BSensingObject belongs to" }, "Type": { "type": "string", "description": "Type of sensing object e.g: fire alarm system, gas-warning system, smoke detectors" }, "Class": { "type": "string", "description": "Class of object in this case sensing object" }, "Name": { "type": "string", "description": "Name of sensing object" }, "TransferSystem": { "type": "string", "description": "Does a transfer system exists (Y/N)" }, "NetworkTopology": { "type": "string", "description": "Description of network topology" }, "PowerSupply": { "type": "string", "description": "Power supply of sensing object e.g: long-term battery, short-term battery, centralised supply" }, "NumberOfAntennae": { "type": "number", "description": "Number of antennae" }, "NumberOfAutomatic Sensors": { "type": "number", "description": "Number of automatic sensors" }, "NumberOfCameras": { "type": "number", "description": "Number of cameras" }, "NumberOfMonitors": { "type": "number", "description": "Number of monitors" }, "NumberOfBoosters": { "type": "number", "description": "Number of boosters" }, "NumberOfSignalingDevice": { "type": "number", "description": "Number of signaling devices" }, "NumberOfSmokeExtractors": { "type": "number", "description": "Number of smoke extractors" }, "NumberOfSubstations": { "type": "number", "description": "Number of substations" }, "RingPiping": { "type": "string", "description": "Info on piping seal" } } }
{ "BSensingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Name": "Lorem", "TransferSystem": "Lorem", "NetworkTopology": "Lorem", "PowerSupply": "Lorem", "NumberOfAntennae": 15, "NumberOfAutomatic Sensors": -51, "NumberOfCameras": -62, "NumberOfMonitors": -50, "NumberOfBoosters": -27, "NumberOfSignalingDevice": -3, "NumberOfSmokeExtractors": 61, "NumberOfSubstations": 8, "RingPiping": "Lorem" }
Property | Value |
Document name | Building |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
BuildingId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
BuildingCode | string | false | User specific Building Code e.g: BC001 | ||
Name | string | false | User specific building name e.g: EMEA Headquarter, Office Berlin | ||
Type | string | false | Type of building use e.g: office, storage, production | ||
BuildingClass | string | false | Energy Class of Building e.g: A | ||
ValidFrom | string | false | Date construction process is finished or lease contract started e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | true | Date building is either sold, demolished or lease contract ends e.g: 12.10.23 | [{"dataType":"dateTime"}] | |
ConstructionYear | string | false | Year of construction e.g: 2002 | [{"dataType":"dateTime"}] | |
ParkingSpaces | number | false | Number of parking spaces | ||
EnergyType | string | false | Type of energy used | ||
WaterType | string | false | Type of water used | ||
HeatingType1 | string | false | Primary Type of heating | ||
HeatingType2 | string | false | Secondary Type of heating | ||
AirConditioning | boolean | false | Does air conditioning exist? (Y/N) (Needed for precise future emissions projection of building) | ||
PrimaryUsage | string | false | E.g. Office, Residential, Data room etc. | ||
SecondaryUsage | string | false | E.g. Office, Residential, Data room etc. | ||
PortfolioId | string | false | fk | Reference to the Portfolio which the building belongs to | |
LandId | string | false | fk | Reference to the Land which the building belongs to | |
SiteId | string | false | fk | Reference to the Site which the building belongs to | |
CertificateId | string | false | fk | Reference to the certificate which belongs to the building | |
AddressId | string | false | fk | Reference to Address which the building belongs to | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | User specific Building Code e.g: BC001 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | User specific building name e.g: EMEA Headquarter, Office Berlin |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of building use e.g: office, storage, production |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Energy Class of Building e.g: A |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | VldFrm |
Activated | true |
Id | |
Type | string |
Description | Date construction process is finished or lease contract started e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | Vldntl |
Activated | true |
Id | |
Type | string |
Description | Date building is either sold, demolished or lease contract ends e.g: 12.10.23 |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ConstructionYear |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Year of construction e.g: 2002 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ParkingSpaces |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of parking spaces |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EnergyType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of energy used |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WaterType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of water used |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | HeatingType1 |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Primary Type of heating |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | HeatingType2 |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Secondary Type of heating |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AirConditioning |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Does air conditioning exist? (Y/N) (Needed for precise future emissions projection of building) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | PrimaryUsage |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | E.g. Office, Residential, Data room etc. |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SecondaryUsage |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | E.g. Office, Residential, Data room etc. |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PortfolioId |
Technical name | Prtfld |
Activated | true |
Id | |
Type | string |
Description | Reference to the Portfolio which the building belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Portfolio |
Foreign field | PortfolioId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LandId |
Technical name | Lndd |
Activated | true |
Id | |
Type | string |
Description | Reference to the Land which the building belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Land |
Foreign field | LandId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | Std |
Activated | true |
Id | |
Type | string |
Description | Reference to the Site which the building belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CertificateId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the certificate which belongs to the building |
Dependencies | |
Required | |
Primary key | |
Foreign collection | Certificate |
Foreign field | CertificateId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AddressId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to Address which the building belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Address1 |
Foreign field | AddressId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Building", "additionalProperties": false, "properties": { "BuildingId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "BuildingCode": { "type": "string", "description": "User specific Building Code e.g: BC001" }, "Name": { "type": "string", "description": "User specific building name e.g: EMEA Headquarter, Office Berlin" }, "Type": { "type": "string", "description": "Type of building use e.g: office, storage, production" }, "BuildingClass": { "type": "string", "description": "Energy Class of Building e.g: A" }, "VldFrm": { "type": "string", "description": "Date construction process is finished or lease contract started e.g: 10.10.20" }, "Vldntl": { "type": "string", "description": "Date building is either sold, demolished or lease contract ends e.g: 12.10.23 " }, "ConstructionYear": { "type": "string", "description": "Year of construction e.g: 2002" }, "ParkingSpaces": { "type": "number", "description": "Number of parking spaces" }, "EnergyType": { "type": "string", "description": "Type of energy used" }, "WaterType": { "type": "string", "description": "Type of water used" }, "HeatingType1": { "type": "string", "description": "Primary Type of heating" }, "HeatingType2": { "type": "string", "description": "Secondary Type of heating" }, "AirConditioning": { "type": "boolean", "description": "Does air conditioning exist? (Y/N) (Needed for precise future emissions projection of building)" }, "PrimaryUsage": { "type": "string", "description": "E.g. Office, Residential, Data room etc." }, "SecondaryUsage": { "type": "string", "description": "E.g. Office, Residential, Data room etc." }, "Prtfld": { "type": "string", "description": "Reference to the Portfolio which the building belongs to" }, "Lndd": { "type": "string", "description": "Reference to the Land which the building belongs to" }, "Std": { "type": "string", "description": "Reference to the Site which the building belongs to" }, "CertificateId": { "type": "string", "description": "Reference to the certificate which belongs to the building" }, "AddressId": { "type": "string", "description": "Reference to Address which the building belongs to" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } }, "required": [ "Vldntl" ] }
{ "BuildingId": "Lorem", "BuildingCode": "Lorem", "Name": "Lorem", "Type": "Lorem", "BuildingClass": "Lorem", "VldFrm": "Lorem", "Vldntl": "Lorem", "ConstructionYear": "Lorem", "ParkingSpaces": 28, "EnergyType": "Lorem", "WaterType": "Lorem", "HeatingType1": "Lorem", "HeatingType2": "Lorem", "AirConditioning": true, "PrimaryUsage": "Lorem", "SecondaryUsage": "Lorem", "Prtfld": "Lorem", "Lndd": "Lorem", "Std": "Lorem", "CertificateId": "Lorem", "AddressId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | CStoringObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
CStoringObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the storing object belongs to | |
Type | string | false | Type of storing object e.g: compressed air tank, heating oil tank, expansion vessel | ||
Class | string | false | Class of object in this case storing object | ||
Name | string | false | Name of storing object | ||
ContainerVolume | number | false | Volume of container e.g: 55.6; 460; 1000 | [{"dataType":"float"}] | |
FillingWeight | number | false | Weight of storing object including the filling | [{"dataType":"float"}] | |
Installation | string | false | Type of installation e.g: earth installation, open space installation | ||
NominalVolume | number | false | Largest possible volume of container e.g: 20.5; 250; 400 | [{"dataType":"float"}] | |
NumberOfContainers | number | false | Number of different storing containers | ||
StorageVolume | number | false | Actual storage volume of StoringObject | [{"dataType":"float"}] | |
TotalVolume | number | false | Total volume of storing object | [{"dataType":"float"}] | |
Volume | number | false | [{"dataType":"float"}] | ||
OperatingPressure | number | false | Pressure while being in operation | [{"dataType":"float"}] |
Property | Value |
Name | CStoringObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the storing object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of storing object e.g: compressed air tank, heating oil tank, expansion vessel |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Class of object in this case storing object |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of storing object |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContainerVolume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Volume of container e.g: 55.6; 460; 1000 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | FillingWeight |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Weight of storing object including the filling |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Installation |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of installation e.g: earth installation, open space installation |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NominalVolume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Largest possible volume of container e.g: 20.5; 250; 400 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | NumberOfContainers |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of different storing containers |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | StorageVolume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Actual storage volume of StoringObject |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | TotalVolume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Total volume of storing object |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Volume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | OperatingPressure |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Pressure while being in operation |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "CStoringObject", "additionalProperties": false, "properties": { "CStoringObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the storing object belongs to" }, "Type": { "type": "string", "description": "Type of storing object e.g: compressed air tank, heating oil tank, expansion vessel" }, "Class": { "type": "string", "description": "Class of object in this case storing object" }, "Name": { "type": "string", "description": "Name of storing object" }, "ContainerVolume": { "type": "number", "description": "Volume of container e.g: 55.6; 460; 1000" }, "FillingWeight": { "type": "number", "description": "Weight of storing object including the filling" }, "Installation": { "type": "string", "description": "Type of installation e.g: earth installation, open space installation" }, "NominalVolume": { "type": "number", "description": "Largest possible volume of container e.g: 20.5; 250; 400" }, "NumberOfContainers": { "type": "number", "description": "Number of different storing containers" }, "StorageVolume": { "type": "number", "description": "Actual storage volume of StoringObject" }, "TotalVolume": { "type": "number", "description": "Total volume of storing object" }, "Volume": { "type": "number" }, "OperatingPressure": { "type": "number", "description": "Pressure while being in operation" } } }
{ "CStoringObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Name": "Lorem", "ContainerVolume": 43, "FillingWeight": 93, "Installation": "Lorem", "NominalVolume": -1, "NumberOfContainers": 30, "StorageVolume": -95, "TotalVolume": -64, "Volume": -91, "OperatingPressure": 54 }
Property | Value |
Document name | Certificate |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
CertificateId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
BuildingId | string | false | fk | Reference to the Building which the building belongs to | |
Type | string | false | Type of Certificate e.g: LEED, BREEAM, DGNB | ||
Name | string | false | Name of Certificate e.g: DGNB Platin, DGNB Silber, DGNB Bronze | ||
Value | string | false | E.g. Score, Grade if applicable for the certificate, A++ | ||
IssuingDate | string | false | Date certificate was issued | [{"dataType":"DateTime"}] | |
ValidFrom | string | false | Date certificate is valid from e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date certificate expires e.g: 12.10.23 | [{"dataType":"dateTime"}] | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | CertificateId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the Building which the building belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of Certificate e.g: LEED, BREEAM, DGNB |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of Certificate e.g: DGNB Platin, DGNB Silber, DGNB Bronze |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | E.g. Score, Grade if applicable for the certificate, A++ |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | IssuingDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date certificate was issued |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"DateTime"}] |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date certificate is valid from e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date certificate expires e.g: 12.10.23 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Certificate", "additionalProperties": false, "properties": { "CertificateId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "BuildingId": { "type": "string", "description": "Reference to the Building which the building belongs to" }, "Type": { "type": "string", "description": "Type of Certificate e.g: LEED, BREEAM, DGNB" }, "Name": { "type": "string", "description": "Name of Certificate e.g: DGNB Platin, DGNB Silber, DGNB Bronze" }, "Value": { "type": "string", "description": "E.g. Score, Grade if applicable for the certificate, A++" }, "IssuingDate": { "type": "string", "description": "Date certificate was issued" }, "ValidFrom": { "type": "string", "description": "Date certificate is valid from e.g: 10.10.20" }, "ValidUntil": { "type": "string", "description": "Date certificate expires e.g: 12.10.23 " }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "CertificateId": "Lorem", "BuildingId": "Lorem", "Type": "Lorem", "Name": "Lorem", "Value": "Lorem", "IssuingDate": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | EEmittingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
EEmittingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the emitting object belongs to | |
Type | string | false | |||
Class | string | false | |||
Name | string | false | |||
CollectorSurface | string | false | |||
ConnectiontosecondaryCircuit | string | false | |||
CoolingMediumType | string | false | |||
DecentralizedConstruction | string | false | |||
Dehumidifying | string | false | |||
Density | number | false | [{"dataType":"float"}] | ||
DriveEnergy | string | false | |||
ElectricalPower | number | false | [{"dataType":"float"}] | ||
EnergyEfficiencyClass | string | false | |||
EnergySupply | number | false | [{"dataType":"float"}] | ||
ExhaustAirVolumeFlow | number | false | [{"dataType":"float"}] | ||
ExtinguishingAgent | string | false | |||
FireClass | string | false | |||
FireExtinguisherTransportType | string | false | |||
FittingType | string | false | |||
Fuel | string | false | |||
GrateType | string | false | |||
HeatingType | string | false | |||
FilterClass | string | false | |||
Humidifying | string | false | |||
InstallationSite | string | false | |||
InstalledElectricalLoad | number | false | [{"dataType":"float"}] | ||
InsulationThickness | string | false | |||
MaximumBurnerCapacity | number | false | [{"dataType":"float"}] | ||
MaximumVolumeFlow | number | false | [{"dataType":"float"}] | ||
MinimumBurnerCapacity | number | false | [{"dataType":"float"}] | ||
MediumSupplied | string | false | |||
NominalPower | number | false | [{"dataType":"float"}] | ||
NumberOfAlarmValveStations | number | false | Number of alarm valve stations | ||
NumberOfCirculationPumps | number | false | Number of circulation pumps | ||
NumberOfCompartmentValves | number | false | Number of compartment valve | ||
NumberOfHeatingCircuits | number | false | Number of heating circuits | ||
NumberOfCoolingCircuits | number | false | Number of cooling circuits | ||
NumberOfInlets | number | false | Number of Inlets | ||
NumberOfSprinklerHeads | number | false | Number of sprinkler heads | ||
NumberOfSupplyPoints | number | false | Number of supply points | ||
NumberOfZoneChecks | number | false | Number of zone checks | ||
OperatingMode | string | false | |||
PipingSystem | string | false | |||
Power | number | false | [{"dataType":"float"}] | ||
PurposeOfHeating | string | false | |||
RadiatorType | string | false | |||
RecoolingSystemType | string | false | |||
RecoolingUnitType | string | false | |||
StorageColume | string | false | |||
ThearmalHeatingPower | number | false | [{"dataType":"float"}] | ||
ThermalPower | number | false | [{"dataType":"float"}] | ||
TraceHeating | string | false | |||
WaterSupply | string | false |
Property | Value |
Name | EEmittingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the emitting object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CollectorSurface |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ConnectiontosecondaryCircuit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CoolingMediumType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DecentralizedConstruction |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Dehumidifying |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Density |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | DriveEnergy |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ElectricalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | EnergyEfficiencyClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EnergySupply |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ExhaustAirVolumeFlow |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ExtinguishingAgent |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FireClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FireExtinguisherTransportType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FittingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Fuel |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GrateType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | HeatingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FilterClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Humidifying |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | InstallationSite |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | InstalledElectricalLoad |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | InsulationThickness |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaximumBurnerCapacity |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MaximumVolumeFlow |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MinimumBurnerCapacity |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MediumSupplied |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NominalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | NumberOfAlarmValveStations |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of alarm valve stations |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfCirculationPumps |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of circulation pumps |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfCompartmentValves |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of compartment valve |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfHeatingCircuits |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of heating circuits |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfCoolingCircuits |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of cooling circuits |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfInlets |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of Inlets |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfSprinklerHeads |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of sprinkler heads |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfSupplyPoints |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of supply points |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfZoneChecks |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of zone checks |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | OperatingMode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PipingSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Power |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | PurposeOfHeating |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RadiatorType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RecoolingSystemType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RecoolingUnitType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | StorageColume |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ThearmalHeatingPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ThermalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | TraceHeating |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WaterSupply |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "EEmittingObject", "additionalProperties": false, "properties": { "EEmittingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the emitting object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "Name": { "type": "string" }, "CollectorSurface": { "type": "string" }, "ConnectiontosecondaryCircuit": { "type": "string" }, "CoolingMediumType": { "type": "string" }, "DecentralizedConstruction": { "type": "string" }, "Dehumidifying": { "type": "string" }, "Density": { "type": "number" }, "DriveEnergy": { "type": "string" }, "ElectricalPower": { "type": "number" }, "EnergyEfficiencyClass": { "type": "string" }, "EnergySupply": { "type": "number" }, "ExhaustAirVolumeFlow": { "type": "number" }, "ExtinguishingAgent": { "type": "string" }, "FireClass": { "type": "string" }, "FireExtinguisherTransportType": { "type": "string" }, "FittingType": { "type": "string" }, "Fuel": { "type": "string" }, "GrateType": { "type": "string" }, "HeatingType": { "type": "string" }, "FilterClass": { "type": "string" }, "Humidifying": { "type": "string" }, "InstallationSite": { "type": "string" }, "InstalledElectricalLoad": { "type": "number" }, "InsulationThickness": { "type": "string" }, "MaximumBurnerCapacity": { "type": "number" }, "MaximumVolumeFlow": { "type": "number" }, "MinimumBurnerCapacity": { "type": "number" }, "MediumSupplied": { "type": "string" }, "NominalPower": { "type": "number" }, "NumberOfAlarmValveStations": { "type": "number", "description": "Number of alarm valve stations" }, "NumberOfCirculationPumps": { "type": "number", "description": "Number of circulation pumps" }, "NumberOfCompartmentValves": { "type": "number", "description": "Number of compartment valve" }, "NumberOfHeatingCircuits": { "type": "number", "description": "Number of heating circuits" }, "NumberOfCoolingCircuits": { "type": "number", "description": "Number of cooling circuits" }, "NumberOfInlets": { "type": "number", "description": "Number of Inlets" }, "NumberOfSprinklerHeads": { "type": "number", "description": "Number of sprinkler heads" }, "NumberOfSupplyPoints": { "type": "number", "description": "Number of supply points" }, "NumberOfZoneChecks": { "type": "number", "description": "Number of zone checks" }, "OperatingMode": { "type": "string" }, "PipingSystem": { "type": "string" }, "Power": { "type": "number" }, "PurposeOfHeating": { "type": "string" }, "RadiatorType": { "type": "string" }, "RecoolingSystemType": { "type": "string" }, "RecoolingUnitType": { "type": "string" }, "StorageColume": { "type": "string" }, "ThearmalHeatingPower": { "type": "number" }, "ThermalPower": { "type": "number" }, "TraceHeating": { "type": "string" }, "WaterSupply": { "type": "string" } } }
{ "EEmittingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Name": "Lorem", "CollectorSurface": "Lorem", "ConnectiontosecondaryCircuit": "Lorem", "CoolingMediumType": "Lorem", "DecentralizedConstruction": "Lorem", "Dehumidifying": "Lorem", "Density": -18, "DriveEnergy": "Lorem", "ElectricalPower": -54, "EnergyEfficiencyClass": "Lorem", "EnergySupply": 54, "ExhaustAirVolumeFlow": 55, "ExtinguishingAgent": "Lorem", "FireClass": "Lorem", "FireExtinguisherTransportType": "Lorem", "FittingType": "Lorem", "Fuel": "Lorem", "GrateType": "Lorem", "HeatingType": "Lorem", "FilterClass": "Lorem", "Humidifying": "Lorem", "InstallationSite": "Lorem", "InstalledElectricalLoad": -51, "InsulationThickness": "Lorem", "MaximumBurnerCapacity": 39, "MaximumVolumeFlow": -69, "MinimumBurnerCapacity": 12, "MediumSupplied": "Lorem", "NominalPower": -24, "NumberOfAlarmValveStations": -81, "NumberOfCirculationPumps": 48, "NumberOfCompartmentValves": 2, "NumberOfHeatingCircuits": 41, "NumberOfCoolingCircuits": -83, "NumberOfInlets": 4, "NumberOfSprinklerHeads": 65, "NumberOfSupplyPoints": 79, "NumberOfZoneChecks": 5, "OperatingMode": "Lorem", "PipingSystem": "Lorem", "Power": 82, "PurposeOfHeating": "Lorem", "RadiatorType": "Lorem", "RecoolingSystemType": "Lorem", "RecoolingUnitType": "Lorem", "StorageColume": "Lorem", "ThearmalHeatingPower": -73, "ThermalPower": -70, "TraceHeating": "Lorem", "WaterSupply": "Lorem" }
Property | Value |
Document name | FProtectingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
FProtectingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the emitting object belongs to | |
Type | string | false | |||
Class | string | false | |||
Name | string | false | |||
InstallationSituation | string | false | |||
ProofOfUsability | string | false |
Property | Value |
Name | FProtectingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the emitting object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | InstallationSituation |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProofOfUsability |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "FProtectingObject", "additionalProperties": false, "properties": { "FProtectingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the emitting object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "Name": { "type": "string" }, "InstallationSituation": { "type": "string" }, "ProofOfUsability": { "type": "string" } } }
{ "FProtectingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Name": "Lorem", "InstallationSituation": "Lorem", "ProofOfUsability": "Lorem" }
Property | Value |
Document name | Floor |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
FloorId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
FloorCode | string | false | User specific Floor Code e.g: F003 | ||
Name | string | false | Name of floor e.g: EG; 1st floor; UG | ||
FloorNumber | number | false | Number of floor e.g: 4; 19 | ||
ValidFrom | string | false | Date area measurement was taken e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | true | Date area measurement need to be renewed e.g: 12.10.23 | [{"dataType":"dateTime"}] | |
BuildingId | string | false | fk | Reference to the Building which the Floor belongs to | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | FloorId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | User specific Floor Code e.g: F003 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of floor e.g: EG; 1st floor; UG |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorNumber |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of floor e.g: 4; 19 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date area measurement was taken e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date area measurement need to be renewed e.g: 12.10.23 |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | BuildingId |
Technical name | Bldngd |
Activated | true |
Id | |
Type | string |
Description | Reference to the Building which the Floor belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Floor", "additionalProperties": false, "properties": { "FloorId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "FloorCode": { "type": "string", "description": "User specific Floor Code e.g: F003" }, "Name": { "type": "string", "description": "Name of floor e.g: EG; 1st floor; UG" }, "FloorNumber": { "type": "number", "description": "Number of floor e.g: 4; 19" }, "ValidFrom": { "type": "string", "description": "Date area measurement was taken e.g: 10.10.20" }, "ValidUntil": { "type": "string", "description": "Date area measurement need to be renewed e.g: 12.10.23 " }, "Bldngd": { "type": "string", "description": "Reference to the Building which the Floor belongs to" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } }, "required": [ "ValidUntil" ] }
{ "FloorId": "Lorem", "FloorCode": "Lorem", "Name": "Lorem", "FloorNumber": 36, "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Bldngd": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | GGeneratingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
GGeneratingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the generating object belongs to | |
Type | string | false | |||
Class | string | false | |||
Name | string | false | |||
AutomaticFeed | boolean | false | |||
ApplicationArea | string | false | |||
Ceiling | string | false | |||
CompressorType | string | false | |||
CollectingContainer | string | false | |||
ConstructionStandards | string | false | |||
ContainerVolume | number | false | [{"dataType":"float"}] | ||
ContainingFeces | string | false | |||
Direction | string | false | |||
DischargeHeight | number | false | [{"dataType":"float"}] | ||
ElectricalPeak | number | false | [{"dataType":"float"}] | ||
ElectricalPower | number | false | [{"dataType":"float"}] | ||
ExplosionSafe | string | false | |||
FanSeries | string | false | |||
FlowRate | number | false | [{"dataType":"float"}] | ||
LifterType | string | false | |||
LiftingHeight | number | false | [{"dataType":"float"}] | ||
Lighting | string | false | |||
LoadBearingCapacity | number | false | [{"dataType":"float"}] | ||
MaximumPressure | number | false | [{"dataType":"float"}] | ||
MobileSystem | string | false | |||
MotorNominalPower | number | false | [{"dataType":"float"}] | ||
MotorPower | number | false | [{"dataType":"float"}] | ||
MotorRatedCurrent | number | false | [{"dataType":"float"}] | ||
NumberOfCells | number | false | Number of cells | ||
NumberOfDrives | number | false | Number of drivers | ||
NumberOfModules | number | false | Number of modules | ||
NumberOfPowerInverters | number | false | Number of power inverters | ||
NumberOfPumps | number | false | Number of pumps | ||
NumberOfStops | number | false | Number of stops | ||
NumberOfTapping | number | false | Number of tapping | ||
OptimalVolumeStream | number | false | [{"dataType":"float"}] | ||
PassengerCapacity | number | false | Capacity of passengers | ||
ProtectionType | string | false | |||
RatedCapacity | number | false | |||
Rated | string | false | |||
RatedElectricalPower | number | false | [{"dataType":"float"}] | ||
RotationSpeedControl | number | false | [{"dataType":"float"}] | ||
RotorDiameter | number | false | [{"dataType":"float"}] | ||
SafeFallProtection | string | false | |||
SpeedControl | boolean | false | |||
TiltingAngle | number | false | [{"dataType":"float"}] | ||
Triggering | string | false | |||
Voltage | number | false | [{"dataType":"float"}] | ||
VolumeFlow | number | false | [{"dataType":"float"}] | ||
VolumeOfFuelReserves | number | false | [{"dataType":"float"}] |
Property | Value |
Name | GGeneratingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the generating object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AutomaticFeed |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | ApplicationArea |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Ceiling |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CompressorType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CollectingContainer |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ConstructionStandards |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContainerVolume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ContainingFeces |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Direction |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DischargeHeight |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ElectricalPeak |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ElectricalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ExplosionSafe |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FanSeries |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FlowRate |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | LifterType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LiftingHeight |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Lighting |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LoadBearingCapacity |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MaximumPressure |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MobileSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MotorNominalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MotorPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | MotorRatedCurrent |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | NumberOfCells |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of cells |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfDrives |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of drivers |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfModules |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of modules |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfPowerInverters |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of power inverters |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfPumps |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of pumps |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfStops |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of stops |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfTapping |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of tapping |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | OptimalVolumeStream |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | PassengerCapacity |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Capacity of passengers |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProtectionType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RatedCapacity |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Rated |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RatedElectricalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | RotationSpeedControl |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | RotorDiameter |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | SafeFallProtection |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpeedControl |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | TiltingAngle |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Triggering |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Voltage |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | VolumeFlow |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | [{"dataType":"float"}] |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | VolumeOfFuelReserves |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | [{"dataType":"float"}] |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "GGeneratingObject", "additionalProperties": false, "properties": { "GGeneratingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the generating object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "Name": { "type": "string" }, "AutomaticFeed": { "type": "boolean" }, "ApplicationArea": { "type": "string" }, "Ceiling": { "type": "string" }, "CompressorType": { "type": "string" }, "CollectingContainer": { "type": "string" }, "ConstructionStandards": { "type": "string" }, "ContainerVolume": { "type": "number" }, "ContainingFeces": { "type": "string" }, "Direction": { "type": "string" }, "DischargeHeight": { "type": "number" }, "ElectricalPeak": { "type": "number" }, "ElectricalPower": { "type": "number" }, "ExplosionSafe": { "type": "string" }, "FanSeries": { "type": "string" }, "FlowRate": { "type": "number" }, "LifterType": { "type": "string" }, "LiftingHeight": { "type": "number" }, "Lighting": { "type": "string" }, "LoadBearingCapacity": { "type": "number" }, "MaximumPressure": { "type": "number" }, "MobileSystem": { "type": "string" }, "MotorNominalPower": { "type": "number" }, "MotorPower": { "type": "number" }, "MotorRatedCurrent": { "type": "number" }, "NumberOfCells": { "type": "number", "description": "Number of cells" }, "NumberOfDrives": { "type": "number", "description": "Number of drivers" }, "NumberOfModules": { "type": "number", "description": "Number of modules" }, "NumberOfPowerInverters": { "type": "number", "description": "Number of power inverters" }, "NumberOfPumps": { "type": "number", "description": "Number of pumps" }, "NumberOfStops": { "type": "number", "description": "Number of stops" }, "NumberOfTapping": { "type": "number", "description": "Number of tapping" }, "OptimalVolumeStream": { "type": "number" }, "PassengerCapacity": { "type": "number", "description": "Capacity of passengers" }, "ProtectionType": { "type": "string" }, "RatedCapacity": { "type": "number" }, "Rated": { "type": "string" }, "RatedElectricalPower": { "type": "number" }, "RotationSpeedControl": { "type": "number" }, "RotorDiameter": { "type": "number" }, "SafeFallProtection": { "type": "string" }, "SpeedControl": { "type": "boolean" }, "TiltingAngle": { "type": "number" }, "Triggering": { "type": "string" }, "Voltage": { "type": "number" }, "VolumeFlow": { "type": "number", "description": "[{\"dataType\":\"float\"}]" }, "VolumeOfFuelReserves": { "type": "number", "description": "[{\"dataType\":\"float\"}]" } } }
{ "GGeneratingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Name": "Lorem", "AutomaticFeed": true, "ApplicationArea": "Lorem", "Ceiling": "Lorem", "CompressorType": "Lorem", "CollectingContainer": "Lorem", "ConstructionStandards": "Lorem", "ContainerVolume": 26, "ContainingFeces": "Lorem", "Direction": "Lorem", "DischargeHeight": -26, "ElectricalPeak": 75, "ElectricalPower": 22, "ExplosionSafe": "Lorem", "FanSeries": "Lorem", "FlowRate": -59, "LifterType": "Lorem", "LiftingHeight": -2, "Lighting": "Lorem", "LoadBearingCapacity": 31, "MaximumPressure": -90, "MobileSystem": "Lorem", "MotorNominalPower": -65, "MotorPower": 48, "MotorRatedCurrent": -69, "NumberOfCells": -14, "NumberOfDrives": 23, "NumberOfModules": -37, "NumberOfPowerInverters": 45, "NumberOfPumps": -44, "NumberOfStops": -2, "NumberOfTapping": -9, "OptimalVolumeStream": -62, "PassengerCapacity": 25, "ProtectionType": "Lorem", "RatedCapacity": -38, "Rated": "Lorem", "RatedElectricalPower": 71, "RotationSpeedControl": -16, "RotorDiameter": 47, "SafeFallProtection": "Lorem", "SpeedControl": true, "TiltingAngle": -49, "Triggering": "Lorem", "Voltage": -7, "VolumeFlow": 64, "VolumeOfFuelReserves": -69 }
Property | Value |
Document name | HMatterProcessingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
HMatterProcessingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the matter processing object belongs to | |
Type | string | false | |||
Class | string | false | |||
ThermalPower | string | false | |||
TypeOfUse | string | false | |||
AbsorberArea | number | false | [{"dataType":"float"}] | ||
AirFilterType | string | false | |||
Backwashable | string | false | |||
EnergyEfficiencyClass | string | false |
Property | Value |
Name | HMatterProcessingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the matter processing object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ThermalPower |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TypeOfUse |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AbsorberArea |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | AirFilterType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Backwashable |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EnergyEfficiencyClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "HMatterProcessingObject", "additionalProperties": false, "properties": { "HMatterProcessingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the matter processing object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "ThermalPower": { "type": "string" }, "TypeOfUse": { "type": "string" }, "AbsorberArea": { "type": "number" }, "AirFilterType": { "type": "string" }, "Backwashable": { "type": "string" }, "EnergyEfficiencyClass": { "type": "string" } } }
{ "HMatterProcessingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "ThermalPower": "Lorem", "TypeOfUse": "Lorem", "AbsorberArea": -12, "AirFilterType": "Lorem", "Backwashable": "Lorem", "EnergyEfficiencyClass": "Lorem" }
Property | Value |
Document name | Land |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
LandId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
Type | string | false | Type of land e.g: agricultural, recreational, industrial, non-industrial, traffic | ||
New Field | string | false | Development level of land e.g: full/partial/non | ||
ParcelNr | number | false | District/Zoning registered number for the Plot of land | ||
LandCode | number | false | Code representing country | ||
ValidFrom | string | false | Date land was recorded e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date land is not valid anymore /needs to be checked | [{"dataType":"dateTime"}] | |
Name | string | false | Name of Land e.g: park, garden, parking | ||
SiteId | string | false | fk | Reference to the site which the land belongs to | |
GeorefId | string | false | A reference to Guid from the geo-coordinate entity | ||
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | LandId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | Customer ID from previous system (ID before onboarding data to BM) |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of land e.g: agricultural, recreational, industrial, non-industrial, traffic |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | New Field |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Development level of land e.g: full/partial/non |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ParcelNr |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | District/Zoning registered number for the Plot of land |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LandCode |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Code representing country |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date land was recorded e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date land is not valid anymore /needs to be checked |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of Land e.g: park, garden, parking |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | Std |
Activated | true |
Id | |
Type | string |
Description | Reference to the site which the land belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GeorefId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | A reference to Guid from the geo-coordinate entity |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Land", "additionalProperties": false, "properties": { "LandId": { "type": "string" }, "Type": { "type": "string", "description": "Type of land e.g: agricultural, recreational, industrial, non-industrial, traffic" }, "New Field": { "type": "string", "description": "Development level of land e.g: full/partial/non" }, "ParcelNr": { "type": "number", "description": "District/Zoning registered number for the Plot of land" }, "LandCode": { "type": "number", "description": "Code representing country" }, "ValidFrom": { "type": "string", "description": "Date land was recorded e.g: 10.10.20" }, "ValidUntil": { "type": "string", "description": "Date land is not valid anymore /needs to be checked" }, "Name": { "type": "string", "description": "Name of Land e.g: park, garden, parking" }, "Std": { "type": "string", "description": "Reference to the site which the land belongs to" }, "GeorefId": { "type": "string", "description": "A reference to Guid from the geo-coordinate entity" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "LandId": "Lorem", "Type": "Lorem", "New Field": "Lorem", "ParcelNr": -92, "LandCode": -97, "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Name": "Lorem", "Std": "Lorem", "GeorefId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | MDrivingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
MDrivingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the driving object belongs to | |
Type | string | false | |||
Class | string | false | |||
Fuel | string | false | |||
MotorNominalPower | number | false | [{"dataType":"float"}] | ||
NominalThermalPower | number | false | [{"dataType":"float"}] | ||
ExplosionSafe | boolean | false | |||
OperatingMode | string | false | |||
RatedElectricalPower | number | false | [{"dataType":"float"}] | ||
Voltage | number | false | [{"dataType":"float"}] |
Property | Value |
Name | MDrivingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the driving object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Fuel |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MotorNominalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | NominalThermalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ExplosionSafe |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | OperatingMode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RatedElectricalPower |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Voltage |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "MDrivingObject", "additionalProperties": false, "properties": { "MDrivingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the driving object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "Fuel": { "type": "string" }, "MotorNominalPower": { "type": "number" }, "NominalThermalPower": { "type": "number" }, "ExplosionSafe": { "type": "boolean" }, "OperatingMode": { "type": "string" }, "RatedElectricalPower": { "type": "number" }, "Voltage": { "type": "number" } } }
{ "MDrivingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Fuel": "Lorem", "MotorNominalPower": 79, "NominalThermalPower": 34, "ExplosionSafe": true, "OperatingMode": "Lorem", "RatedElectricalPower": 59, "Voltage": 34 }
Property | Value |
Document name | Product |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ProductId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
Name | string | false | Name of product e.g: Brandschutztür, Fire extinguisher | ||
Description | string | false | Description of Product | ||
Class | string | false | Class product belomgs to e.g: 344.10 Interior Doors | ||
Type | string | false | Type of product e.g: equipment | ||
ValidFrom | string | false | Date product was installed e.g: 29.10.19 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date product needs to be renewed e.g: 30.11.21 | [{"dataType":"dateTime"}] | |
GuaranteeEnd | string | false | End date of guarantee | [{"dataType":"dateTime"}] | |
LifeSpanYear | number | false | Life span of product e.g: 30 years | ||
ConditionStatus | string | false | Condition of product e.g: poor, very good | ||
MaintenanceGroup | string | false | Maintenance group of product | ||
MaintenanceRelevance | string | false | Relevance of maintenance e.g: high, important | ||
EquipmentDimension | string | false | Height, width and depth of product | ||
ProductName | string | false | Manufacturer Name e.g: T-30-1-Klappe | ||
ProductCode | string | false | Product specific code (from producer) | ||
ProductType | string | false | Manufacturer Type e.g: Brandschutztür | ||
URLLibrary | string | false | Product website | ||
ProducerCode | string | false | Name of producer/manufacturer e.g: Celler Eisenbau | ||
SupplierCode | string | false | Name of supplier (if different supplier than producer) | ||
Year | string | false | Year product was manufactured e.g: 2020 | [{"dataType":"dateTime"}] | |
SerialNumber | string | false | Serial number of product e.g: xan51425612 | ||
CE-Identification | string | false | European identification number | ||
DeliveryVolume | number | false | [{"dataType":"float"}] | ||
ContentQuantity | number | false | Number of products included in one order | ||
NetContent | number | false | |||
Payload | number | false | Payload of Product | ||
SpaceId | string | false | fk | Reference to the Space which the Equipment belongs to | |
BusinessPartnerId | string | false | fk | Reference to the business partner | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of product e.g: Brandschutztür, Fire extinguisher |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Description |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Description of Product |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Class product belomgs to e.g: 344.10 Interior Doors |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of product e.g: equipment |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date product was installed e.g: 29.10.19 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date product needs to be renewed e.g: 30.11.21 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | GuaranteeEnd |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | End date of guarantee |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | LifeSpanYear |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Life span of product e.g: 30 years |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ConditionStatus |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Condition of product e.g: poor, very good |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaintenanceGroup |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Maintenance group of product |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaintenanceRelevance |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Relevance of maintenance e.g: high, important |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EquipmentDimension |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Height, width and depth of product |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductName |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Manufacturer Name e.g: T-30-1-Klappe |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Product specific code (from producer) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Manufacturer Type e.g: Brandschutztür |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | URLLibrary |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Product website |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProducerCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of producer/manufacturer e.g: Celler Eisenbau |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SupplierCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of supplier (if different supplier than producer) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Year |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Year product was manufactured e.g: 2020 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | SerialNumber |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Serial number of product e.g: xan51425612 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CE-Identification |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | European identification number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DeliveryVolume |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | ContentQuantity |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of products included in one order |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NetContent |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Payload |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Payload of Product |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceId |
Technical name | Spcd |
Activated | true |
Id | |
Type | string |
Description | Reference to the Space which the Equipment belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Space |
Foreign field | SpaceId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BusinessPartnerId |
Technical name | BsnssPrtnrd |
Activated | true |
Id | |
Type | string |
Description | Reference to the business partner |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | BusinessPartner |
Foreign field | BusinessPartnerId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Product", "additionalProperties": false, "properties": { "ProductId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "Name": { "type": "string", "description": "Name of product e.g: Brandschutztür, Fire extinguisher" }, "Description": { "type": "string", "description": "Description of Product" }, "Class": { "type": "string", "description": "Class product belomgs to e.g: 344.10 Interior Doors" }, "Type": { "type": "string", "description": "Type of product e.g: equipment" }, "ValidFrom": { "type": "string", "description": "Date product was installed e.g: 29.10.19" }, "ValidUntil": { "type": "string", "description": "Date product needs to be renewed e.g: 30.11.21" }, "GuaranteeEnd": { "type": "string", "description": "End date of guarantee" }, "LifeSpanYear": { "type": "number", "description": "Life span of product e.g: 30 years" }, "ConditionStatus": { "type": "string", "description": "Condition of product e.g: poor, very good" }, "MaintenanceGroup": { "type": "string", "description": "Maintenance group of product" }, "MaintenanceRelevance": { "type": "string", "description": "Relevance of maintenance e.g: high, important" }, "EquipmentDimension": { "type": "string", "description": "Height, width and depth of product" }, "ProductName": { "type": "string", "description": "Manufacturer Name e.g: T-30-1-Klappe" }, "ProductCode": { "type": "string", "description": "Product specific code (from producer)" }, "ProductType": { "type": "string", "description": "Manufacturer Type e.g: Brandschutztür" }, "URLLibrary": { "type": "string", "description": "Product website" }, "ProducerCode": { "type": "string", "description": "Name of producer/manufacturer e.g: Celler Eisenbau" }, "SupplierCode": { "type": "string", "description": "Name of supplier (if different supplier than producer)" }, "Year": { "type": "string", "description": "Year product was manufactured e.g: 2020" }, "SerialNumber": { "type": "string", "description": "Serial number of product e.g: xan51425612" }, "CE-Identification": { "type": "string", "description": "European identification number" }, "DeliveryVolume": { "type": "number" }, "ContentQuantity": { "type": "number", "description": "Number of products included in one order" }, "NetContent": { "type": "number" }, "Payload": { "type": "number", "description": "Payload of Product" }, "Spcd": { "type": "string", "description": "Reference to the Space which the Equipment belongs to" }, "BsnssPrtnrd": { "type": "string", "description": "Reference to the business partner" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "ProductId": "Lorem", "Name": "Lorem", "Description": "Lorem", "Class": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "GuaranteeEnd": "Lorem", "LifeSpanYear": 39, "ConditionStatus": "Lorem", "MaintenanceGroup": "Lorem", "MaintenanceRelevance": "Lorem", "EquipmentDimension": "Lorem", "ProductName": "Lorem", "ProductCode": "Lorem", "ProductType": "Lorem", "URLLibrary": "Lorem", "ProducerCode": "Lorem", "SupplierCode": "Lorem", "Year": "Lorem", "SerialNumber": "Lorem", "CE-Identification": "Lorem", "DeliveryVolume": -65, "ContentQuantity": -7, "NetContent": 23, "Payload": -10, "Spcd": "Lorem", "BsnssPrtnrd": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | QControllingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
QControllingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the controlling object belongs to | |
Type | string | false | |||
Class | string | false | |||
AutomaticDrive | boolean | false | |||
SafetyRequirements | string | false | |||
DriveManufacturer | string | false | |||
EmergencyExitLock | string | false | |||
FireResistanceClass | string | false | |||
FittingType | string | false | |||
FixingSystem | string | false | |||
FrameSurface | string | false | |||
GlassSurface | string | false | |||
GateSafetyRequirements | string | false | |||
LockingDevice | string | false | |||
OpeningType | string | false | |||
ReadingSystem | string | false | |||
TypeOfGate | string | false | |||
TypeOfGateControl | string | false | |||
ClosingSystem | string | false | |||
NumberOfDrives | number | false | Number of drives | ||
NumberOfPanels | number | false | Number of panels | ||
NumberOfTransponders | number | false | Number of transponders |
Property | Value |
Name | QControllingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the controlling object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AutomaticDrive |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | SafetyRequirements |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DriveManufacturer |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EmergencyExitLock |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FireResistanceClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FittingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FixingSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FrameSurface |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GlassSurface |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GateSafetyRequirements |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LockingDevice |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | OpeningType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReadingSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TypeOfGate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TypeOfGateControl |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ClosingSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfDrives |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of drives |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfPanels |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of panels |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfTransponders |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of transponders |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "QControllingObject", "additionalProperties": false, "properties": { "QControllingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the controlling object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "AutomaticDrive": { "type": "boolean" }, "SafetyRequirements": { "type": "string" }, "DriveManufacturer": { "type": "string" }, "EmergencyExitLock": { "type": "string" }, "FireResistanceClass": { "type": "string" }, "FittingType": { "type": "string" }, "FixingSystem": { "type": "string" }, "FrameSurface": { "type": "string" }, "GlassSurface": { "type": "string" }, "GateSafetyRequirements": { "type": "string" }, "LockingDevice": { "type": "string" }, "OpeningType": { "type": "string" }, "ReadingSystem": { "type": "string" }, "TypeOfGate": { "type": "string" }, "TypeOfGateControl": { "type": "string" }, "ClosingSystem": { "type": "string" }, "NumberOfDrives": { "type": "number", "description": "Number of drives" }, "NumberOfPanels": { "type": "number", "description": "Number of panels" }, "NumberOfTransponders": { "type": "number", "description": "Number of transponders" } } }
{ "QControllingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "AutomaticDrive": true, "SafetyRequirements": "Lorem", "DriveManufacturer": "Lorem", "EmergencyExitLock": "Lorem", "FireResistanceClass": "Lorem", "FittingType": "Lorem", "FixingSystem": "Lorem", "FrameSurface": "Lorem", "GlassSurface": "Lorem", "GateSafetyRequirements": "Lorem", "LockingDevice": "Lorem", "OpeningType": "Lorem", "ReadingSystem": "Lorem", "TypeOfGate": "Lorem", "TypeOfGateControl": "Lorem", "ClosingSystem": "Lorem", "NumberOfDrives": -29, "NumberOfPanels": -10, "NumberOfTransponders": -53 }
Property | Value |
Document name | RRestrictingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RRestrictingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the restricting object belongs to | |
Type | string | false | |||
Class | string | false | |||
AutomaticDrive | boolean | false | |||
NumberOfDrives | number | false | Number of drives |
Property | Value |
Name | RRestrictingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the restricting object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AutomaticDrive |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | NumberOfDrives |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of drives |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "RRestrictingObject", "additionalProperties": false, "properties": { "RRestrictingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the restricting object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "AutomaticDrive": { "type": "boolean" }, "NumberOfDrives": { "type": "number", "description": "Number of drives" } } }
{ "RRestrictingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "AutomaticDrive": true, "NumberOfDrives": -21 }
Property | Value |
Document name | Servitudes |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ServitudeId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
Type | string | false | Type of servitude e.g: Public Servitude, Personal Servitude (Usufruct, Usus) | ||
ValidFrom | string | false | Date servitude starts e.g: 29.10.19 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date servitude ends e.g: 30.11.21 | [{"dataType":"dateTime"}] | |
LandId | string | false | fk | Reference to the land which the servitudes belongs to | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | ServitudeId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of servitude e.g: Public Servitude, Personal Servitude (Usufruct, Usus) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date servitude starts e.g: 29.10.19 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date servitude ends e.g: 30.11.21 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | LandId |
Technical name | Lndd |
Activated | true |
Id | |
Type | string |
Description | Reference to the land which the servitudes belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Land |
Foreign field | LandId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Servitudes", "additionalProperties": false, "properties": { "ServitudeId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "Type": { "type": "string", "description": "Type of servitude e.g: Public Servitude, Personal Servitude (Usufruct, Usus)" }, "ValidFrom": { "type": "string", "description": "Date servitude starts e.g: 29.10.19" }, "ValidUntil": { "type": "string", "description": "Date servitude ends e.g: 30.11.21" }, "Lndd": { "type": "string", "description": "Reference to the land which the servitudes belongs to" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "ServitudeId": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Lndd": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | Site |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
SiteId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
Name | string | true | Name of Site e.g: Siemensstadt | ||
SiteCode | string | false | User specific Site Code e.g: SB001 | ||
Type | string | false | Ownership type of site e.g: owned, leased | ||
ValidFrom | string | false | Date site is acquired / lease starts e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | true | Date site is sold /lease contract ends e.g: 12.10.30 | [{"dataType":"dateTime"}] | |
AddressId | string | false | fk | Reference to the corresponding Address Entity | |
BusinessPartnerId | string | false | fk | ||
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of Site e.g: Siemensstadt |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | User specific Site Code e.g: SB001 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Ownership type of site e.g: owned, leased |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date site is acquired / lease starts e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | Vldntl |
Activated | true |
Id | |
Type | string |
Description | Date site is sold /lease contract ends e.g: 12.10.30 |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | AddressId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the corresponding Address Entity |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Address1 |
Foreign field | AddressId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BusinessPartnerId |
Technical name | BsnssPrtnrd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | BusinessPartner |
Foreign field | BusinessPartnerId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Site", "additionalProperties": false, "properties": { "SiteId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "Name": { "type": "string", "description": "Name of Site e.g: Siemensstadt" }, "SiteCode": { "type": "string", "description": "User specific Site Code e.g: SB001" }, "Type": { "type": "string", "description": "Ownership type of site e.g: owned, leased" }, "ValidFrom": { "type": "string", "description": "Date site is acquired / lease starts e.g: 10.10.20" }, "Vldntl": { "type": "string", "description": "Date site is sold /lease contract ends e.g: 12.10.30 " }, "AddressId": { "type": "string", "description": "Reference to the corresponding Address Entity" }, "BsnssPrtnrd": { "type": "string" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } }, "required": [ "Name", "Vldntl" ] }
{ "SiteId": "Lorem", "Name": "Lorem", "SiteCode": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "Vldntl": "Lorem", "AddressId": "Lorem", "BsnssPrtnrd": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | Space |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
SpaceId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
Name | string | true | Name of space e.g: WC, Meeting room 3c | ||
SpaceCode | string | false | User specific Space Code e.g: MR003 | ||
SpaceNumber | string | false | Number of space e.g: 4 | ||
Type | string | false | Type of space e.g: office, laboratory, storage | ||
ValidFrom | string | false | Date space is defined e.g: 10.10.20 | [{"dataType":"dateTime"}] | |
ValidUntil | string | true | Date space needs to be re-checked / changes e.g: 12.10.30 | [{"dataType":"dateTime"}] | |
SpaceHightUsable | number | false | Usable Hight of space e.g: 3.3 sqm | [{"dataType":"float"}] | |
SpaceHight | number | false | Actual space hight e.g: 3.6 sqm | [{"dataType":"float"}] | |
SpaceVolumeGross | number | false | Gross volume of space including surrounding walls e.g: 90.5 cubic meters | [{"dataType":"float"}] | |
SpaceVolumeNet | number | false | Gross volume of space excluding surrounding walls e.g: 88.3 cubic meters | [{"dataType":"float"}] | |
FloorMaterial | string | false | Material of floor e.g: wood | ||
WallMaterial | string | false | Material of wall e.g: cement | ||
CeilingMaterial | string | false | Material of ceiling e.g: cement | ||
Rentability | boolean | false | Status of the space is eligible for renting out (Y/N) | ||
EffectZonesHeating | string | false | |||
EffectZonesCooling | string | false | |||
EffectZonesVentilation | string | false | |||
ClimateHeated | boolean | false | Define if space is climate heated (Y/N) | ||
ClimateCooled | boolean | false | Define if space is climate cooled (Y/N) | ||
CoUseArea | boolean | false | Is the space used by multiple tenants (Y/N) | ||
MaximumOccupancy | number | false | Define maximum occupancy of space e.g: 5 | ||
VentilationType | string | false | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery | ||
FloorId | string | false | fk | Reference to the floor which the space belongs to | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of space e.g: WC, Meeting room 3c |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | User specific Space Code e.g: MR003 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceNumber |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Number of space e.g: 4 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of space e.g: office, laboratory, storage |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date space is defined e.g: 10.10.20 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date space needs to be re-checked / changes e.g: 12.10.30 |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | SpaceHightUsable |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Usable Hight of space e.g: 3.3 sqm |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | SpaceHight |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Actual space hight e.g: 3.6 sqm |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | SpaceVolumeGross |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Gross volume of space including surrounding walls e.g: 90.5 cubic meters |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | SpaceVolumeNet |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Gross volume of space excluding surrounding walls e.g: 88.3 cubic meters |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | FloorMaterial |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Material of floor e.g: wood |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WallMaterial |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Material of wall e.g: cement |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CeilingMaterial |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Material of ceiling e.g: cement |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Rentability |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Status of the space is eligible for renting out (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | EffectZonesHeating |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EffectZonesCooling |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EffectZonesVentilation |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ClimateHeated |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Define if space is climate heated (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | ClimateCooled |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Define if space is climate cooled (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | CoUseArea |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Is the space used by multiple tenants (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | MaximumOccupancy |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Define maximum occupancy of space e.g: 5 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | VentilationType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorId |
Technical name | Flrd |
Activated | true |
Id | |
Type | string |
Description | Reference to the floor which the space belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Floor |
Foreign field | FloorId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Space", "additionalProperties": false, "properties": { "Name": { "type": "string", "description": "Name of space e.g: WC, Meeting room 3c" }, "SpaceId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "SpaceCode": { "type": "string", "description": "User specific Space Code e.g: MR003" }, "SpaceNumber": { "type": "string", "description": "Number of space e.g: 4" }, "Type": { "type": "string", "description": "Type of space e.g: office, laboratory, storage" }, "ValidFrom": { "type": "string", "description": "Date space is defined e.g: 10.10.20" }, "ValidUntil": { "type": "string", "description": "Date space needs to be re-checked / changes e.g: 12.10.30" }, "SpaceHightUsable": { "type": "number", "description": "Usable Hight of space e.g: 3.3 sqm" }, "SpaceHight": { "type": "number", "description": "Actual space hight e.g: 3.6 sqm" }, "SpaceVolumeGross": { "type": "number", "description": "Gross volume of space including surrounding walls e.g: 90.5 cubic meters" }, "SpaceVolumeNet": { "type": "number", "description": "Gross volume of space excluding surrounding walls e.g: 88.3 cubic meters" }, "FloorMaterial": { "type": "string", "description": "Material of floor e.g: wood" }, "WallMaterial": { "type": "string", "description": "Material of wall e.g: cement" }, "CeilingMaterial": { "type": "string", "description": "Material of ceiling e.g: cement" }, "Rentability": { "type": "boolean", "description": "Status of the space is eligible for renting out (Y/N)" }, "EffectZonesHeating": { "type": "string" }, "EffectZonesCooling": { "type": "string" }, "EffectZonesVentilation": { "type": "string" }, "ClimateHeated": { "type": "boolean", "description": "Define if space is climate heated (Y/N)" }, "ClimateCooled": { "type": "boolean", "description": "Define if space is climate cooled (Y/N)" }, "CoUseArea": { "type": "boolean", "description": "Is the space used by multiple tenants (Y/N)" }, "MaximumOccupancy": { "type": "number", "description": "Define maximum occupancy of space e.g: 5" }, "VentilationType": { "type": "string", "description": "Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery" }, "Flrd": { "type": "string", "description": "Reference to the floor which the space belongs to" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } }, "required": [ "Name", "ValidUntil" ] }
{ "Name": "Lorem", "SpaceId": "Lorem", "SpaceCode": "Lorem", "SpaceNumber": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "SpaceHightUsable": -75, "SpaceHight": 14, "SpaceVolumeGross": -60, "SpaceVolumeNet": -46, "FloorMaterial": "Lorem", "WallMaterial": "Lorem", "CeilingMaterial": "Lorem", "Rentability": true, "EffectZonesHeating": "Lorem", "EffectZonesCooling": "Lorem", "EffectZonesVentilation": "Lorem", "ClimateHeated": true, "ClimateCooled": true, "CoUseArea": true, "MaximumOccupancy": 13, "VentilationType": "Lorem", "Flrd": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | UHoldingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
UHoldingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the holding object belongs to | |
FireWall | boolean | false | Is it a firewall (Y/N) | ||
AcousticsInsulation | string | false | Existing type of acoustic insulation | ||
FireResistanceClass | string | false | |||
SurfaceArea | string | false | |||
WallStrength | string | false | |||
TypeOfSurface | string | false | |||
WallConstruction | string | false | |||
LoadBearingWall | boolean | false | Is it a load bearing wall (Y/N) |
Property | Value |
Name | UHoldingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the holding object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FireWall |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Is it a firewall (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | AcousticsInsulation |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Existing type of acoustic insulation |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FireResistanceClass |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SurfaceArea |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WallStrength |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TypeOfSurface |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WallConstruction |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LoadBearingWall |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | Is it a load bearing wall (Y/N) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "UHoldingObject", "additionalProperties": false, "properties": { "UHoldingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the holding object belongs to" }, "FireWall": { "type": "boolean", "description": "Is it a firewall (Y/N)" }, "AcousticsInsulation": { "type": "string", "description": "Existing type of acoustic insulation" }, "FireResistanceClass": { "type": "string" }, "SurfaceArea": { "type": "string" }, "WallStrength": { "type": "string" }, "TypeOfSurface": { "type": "string" }, "WallConstruction": { "type": "string" }, "LoadBearingWall": { "type": "boolean", "description": "Is it a load bearing wall (Y/N)" } } }
{ "UHoldingObjectId": "Lorem", "ProductId": "Lorem", "FireWall": true, "AcousticsInsulation": "Lorem", "FireResistanceClass": "Lorem", "SurfaceArea": "Lorem", "WallStrength": "Lorem", "TypeOfSurface": "Lorem", "WallConstruction": "Lorem", "LoadBearingWall": true }
Property | Value |
Document name | Unit |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
UnitId | string | false | dk | Customer ID from previous system (ID before onboarding data to BM) | |
Type | string | false | Type of Unit e.g: part of building, rental unit | ||
Name | string | false | Name of space e.g: east wing, apartment C406 | ||
Code | string | false | User-specific code for unit | ||
ValidFrom | string | false | Date unit is defined / rented out | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date unit needs to be redefined / lease contract ends | [{"dataType":"dateTime"}] | |
SiteId | string | false | fk | Reference to the site unit belongs to | |
LandId | string | false | fk | Reference to the land unit belongs to | |
BuildingId | string | false | fk | Reference to the building measurement belongs to | |
SpaceId | string | false | fk | Reference to the space measurement belongs to | |
FloorId | string | false | fk | Reference to the floor measurement belongs to | |
AddressId | string | false | fk | Reference to Address which the building belongs to | |
Guid | string | false | Globally Unique Identifier number |
Property | Value |
Name | UnitId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of Unit e.g: part of building, rental unit |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of space e.g: east wing, apartment C406 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Code |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | User-specific code for unit |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date unit is defined / rented out |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date unit needs to be redefined / lease contract ends |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the site unit belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LandId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the land unit belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Land |
Foreign field | LandId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the building measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the space measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Space |
Foreign field | SpaceId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the floor measurement belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Floor |
Foreign field | FloorId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AddressId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to Address which the building belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Address1 |
Foreign field | AddressId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Unit", "additionalProperties": false, "properties": { "UnitId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "Type": { "type": "string", "description": "Type of Unit e.g: part of building, rental unit" }, "Name": { "type": "string", "description": "Name of space e.g: east wing, apartment C406" }, "Code": { "type": "string", "description": "User-specific code for unit" }, "ValidFrom": { "type": "string", "description": "Date unit is defined / rented out" }, "ValidUntil": { "type": "string", "description": "Date unit needs to be redefined / lease contract ends " }, "SiteId": { "type": "string", "description": "Reference to the site unit belongs to" }, "LandId": { "type": "string", "description": "Reference to the land unit belongs to" }, "BuildingId": { "type": "string", "description": "Reference to the building measurement belongs to" }, "SpaceId": { "type": "string", "description": "Reference to the space measurement belongs to" }, "FloorId": { "type": "string", "description": "Reference to the floor measurement belongs to" }, "AddressId": { "type": "string", "description": "Reference to Address which the building belongs to" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "UnitId": "Lorem", "Type": "Lorem", "Name": "Lorem", "Code": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "SiteId": "Lorem", "LandId": "Lorem", "BuildingId": "Lorem", "SpaceId": "Lorem", "FloorId": "Lorem", "AddressId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | XInterfacingObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Digital Twin |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
XInterfacingObjectId | string | false | Customer ID from previous system (ID before onboarding data to BM) | ||
ProductId | string | false | fk | Reference to the product which the interfacing object belongs to | |
Type | string | false | |||
Class | string | false | |||
Activator | string | false | |||
AVSVCoulingSwit | string | false | |||
CircuitBreaker | string | false | |||
ElectricalConnection | string | false | |||
EmergencyPowerFeeds | string | false | |||
FittingType | string | false | |||
FuesProtection | string | false | |||
FuseProtection | string | false | |||
ModelRange | string | false | |||
NumberOfCabinets | number | false | Number of cabinets | ||
NumberOfConverters | number | false | Number of converters | ||
NumberOfFeeds | number | false | Number of feeds | ||
NumberOfPowerCircuits | number | false | Number of power circuits | ||
NumberOFSafetExits | number | false | Number of safe exits | ||
OperatingVoltage | number | false | [{"dataType":"float"}] | ||
OvervoltageProtection | string | false | |||
Power | number | false | [{"dataType":"float"}] | ||
PrimaryVoltage | number | false | [{"dataType":"float"}] | ||
SecondaryVoltage | number | false | [{"dataType":"float"}] | ||
VandalProofing | string | false | |||
Version | string | false | |||
Voltage | number | false | [{"dataType":"float"}] |
Property | Value |
Name | XInterfacingObjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Customer ID from previous system (ID before onboarding data to BM) |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProductId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to the product which the interfacing object belongs to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Product |
Foreign field | ProductId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Class |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Activator |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AVSVCoulingSwit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CircuitBreaker |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ElectricalConnection |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EmergencyPowerFeeds |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FittingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FuesProtection |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FuseProtection |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ModelRange |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfCabinets |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of cabinets |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfConverters |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of converters |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfFeeds |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of feeds |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOfPowerCircuits |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of power circuits |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NumberOFSafetExits |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Number of safe exits |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | OperatingVoltage |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | OvervoltageProtection |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Power |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | PrimaryVoltage |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | SecondaryVoltage |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | VandalProofing |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Version |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Voltage |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "XInterfacingObject", "additionalProperties": false, "properties": { "XInterfacingObjectId": { "type": "string", "description": "Customer ID from previous system (ID before onboarding data to BM)" }, "ProductId": { "type": "string", "description": "Reference to the product which the interfacing object belongs to" }, "Type": { "type": "string" }, "Class": { "type": "string" }, "Activator": { "type": "string" }, "AVSVCoulingSwit": { "type": "string" }, "CircuitBreaker": { "type": "string" }, "ElectricalConnection": { "type": "string" }, "EmergencyPowerFeeds": { "type": "string" }, "FittingType": { "type": "string" }, "FuesProtection": { "type": "string" }, "FuseProtection": { "type": "string" }, "ModelRange": { "type": "string" }, "NumberOfCabinets": { "type": "number", "description": "Number of cabinets" }, "NumberOfConverters": { "type": "number", "description": "Number of converters" }, "NumberOfFeeds": { "type": "number", "description": "Number of feeds" }, "NumberOfPowerCircuits": { "type": "number", "description": "Number of power circuits" }, "NumberOFSafetExits": { "type": "number", "description": "Number of safe exits" }, "OperatingVoltage": { "type": "number" }, "OvervoltageProtection": { "type": "string" }, "Power": { "type": "number" }, "PrimaryVoltage": { "type": "number" }, "SecondaryVoltage": { "type": "number" }, "VandalProofing": { "type": "string" }, "Version": { "type": "string" }, "Voltage": { "type": "number" } } }
{ "XInterfacingObjectId": "Lorem", "ProductId": "Lorem", "Type": "Lorem", "Class": "Lorem", "Activator": "Lorem", "AVSVCoulingSwit": "Lorem", "CircuitBreaker": "Lorem", "ElectricalConnection": "Lorem", "EmergencyPowerFeeds": "Lorem", "FittingType": "Lorem", "FuesProtection": "Lorem", "FuseProtection": "Lorem", "ModelRange": "Lorem", "NumberOfCabinets": 8, "NumberOfConverters": -72, "NumberOfFeeds": 69, "NumberOfPowerCircuits": 1, "NumberOFSafetExits": 62, "OperatingVoltage": -60, "OvervoltageProtection": "Lorem", "Power": 87, "PrimaryVoltage": -15, "SecondaryVoltage": -19, "VandalProofing": "Lorem", "Version": "Lorem", "Voltage": -28 }
Property | Value |
Group name | Documentation |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Document |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Documentation |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
DocumentId | string | false |
Property | Value |
Name | DocumentId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Document", "additionalProperties": false, "properties": { "DocumentId": { "type": "string" } } }
{ "DocumentId": "Lorem" }
Property | Value |
Document name | DocumentClassificationMasterData |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Documentation |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ClassificationId | string | false |
Property | Value |
Name | ClassificationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "DocumentClassificationMasterData", "additionalProperties": false, "properties": { "ClassificationId": { "type": "string" } } }
{ "ClassificationId": "Lorem" }
Property | Value |
Group name | EnergyAndRessources |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Climate |
Technical name | |
Activated | true |
Id | |
Description | |
Group | EnergyAndRessources |
RESTful API | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description | Comments |
Guid | string | false | Globally Unique Identifier number | ||
Experiment | string | false | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 | ||
Temporal resolution | string | false | Temporal resolution of data (can be the time period over which raw data is aggregated) | ||
GCM | string | false | Global climate model used | ||
RCM | string | false | Regional climate model used | ||
SimV | string | false | Run number of certain climate model or model combination | ||
EnsM | string | false | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' | ||
Value | string | false | Value of observed variable | [{"dataType":"float"}] | |
Unit | string | false | Unit of observed value | ||
ValidFrom | string | false | Date observation starts e.g: 29.10.19 15:15 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date observation end e.g: 29.10.19 15:30 | [{"dataType":"dateTime"}] | |
LocationType | string | false | Type of spatial reference e.g. Zip code or geographic coordinates | ||
CoordinateSystem | string | false | Specific coordinate system used | ||
Location | string | false | Localisation of observed data in case of non-grid location types | ||
Lat | number | false | Latitude coordinate in case of geographic coordinates | ||
Lon | number | false | Longitude coordinate in case of geographic coordinates | ||
PosX | number | false | |||
PosY | number | false | Vertical coordinate in case of projected coordinates | ||
Variable | string | false | Observed variable |
Property | Value |
Name | Experiment |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Temporal resolution |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Temporal resolution of data (can be the time period over which raw data is aggregated) |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GCM |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Global climate model used |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RCM |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Regional climate model used |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SimV |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Run number of certain climate model or model combination |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EnsM |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Value of observed variable |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Unit of observed value |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date observation starts e.g: 29.10.19 15:15 |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date observation end e.g: 29.10.19 15:30 |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | LocationType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of spatial reference e.g. Zip code or geographic coordinates |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CoordinateSystem |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Specific coordinate system used |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Location |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Localisation of observed data in case of non-grid location types |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Lat |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Latitude coordinate in case of geographic coordinates |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Lon |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Longitude coordinate in case of geographic coordinates |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PosX |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PosY |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Vertical coordinate in case of projected coordinates |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Variable |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Observed variable |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Climate", "properties": { "Experiment": { "type": "string", "description": "Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6" }, "Temporal resolution": { "type": "string", "description": "Temporal resolution of data (can be the time period over which raw data is aggregated)" }, "GCM": { "type": "string", "description": "Global climate model used" }, "RCM": { "type": "string", "description": "Regional climate model used" }, "SimV": { "type": "string", "description": "Run number of certain climate model or model combination" }, "EnsM": { "type": "string", "description": "Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'" }, "Value": { "type": "string", "description": "Value of observed variable" }, "Unit": { "type": "string", "description": "Unit of observed value" }, "ValidFrom": { "type": "string", "description": "Date observation starts e.g: 29.10.19 15:15" }, "ValidUntil": { "type": "string", "description": "Date observation end e.g: 29.10.19 15:30" }, "LocationType": { "type": "string", "description": "Type of spatial reference e.g. Zip code or geographic coordinates" }, "CoordinateSystem": { "type": "string", "description": "Specific coordinate system used" }, "Location": { "type": "string", "description": "Localisation of observed data in case of non-grid location types" }, "Lat": { "type": "number", "description": "Latitude coordinate in case of geographic coordinates" }, "Lon": { "type": "number", "description": "Longitude coordinate in case of geographic coordinates" }, "PosX": { "type": "number" }, "PosY": { "type": "number", "description": "Vertical coordinate in case of projected coordinates" }, "Variable": { "type": "string", "description": "Observed variable" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "Experiment": "Lorem", "Temporal resolution": "Lorem", "GCM": "Lorem", "RCM": "Lorem", "SimV": "Lorem", "EnsM": "Lorem", "Value": "Lorem", "Unit": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "LocationType": "Lorem", "CoordinateSystem": "Lorem", "Location": "Lorem", "Lat": -61, "Lon": -40, "PosX": 84, "PosY": 16, "Variable": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | EmissionFactor |
Technical name | |
Activated | true |
Id | |
Description | |
Group | EnergyAndRessources |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
Guid | string | false | Globally Unique Identifier number | ||
Country | string | false | Country in which the emission factor is valid | ||
Type | string | false | Type of resource consumption the emission factor refers to | ||
ValidFrom | string | false | Date validity starts e.g: 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date validity ends e.g: 31.13.19 23:59 | [{"dataType":"dateTime"}] | |
Value | number | false | Value of emission factor | [{"dataType":"float"}] | |
Unit | string | false | Unit of emission factor in terms of kgCO2e per unit of resource consumption | ||
Source | string | false | Source of emission factor e.g. 'International Energy Agency' | ||
SpaceType | string | false | Differentiated emission factor for certain space type (within a building) | ||
Region | string | false | |||
City | string | false | |||
SiteId | string | false | fk | Differentiated emission factor for certain site | |
BuildingId | string | false | fk | Differentiated emission factor for certain building | |
BusinessPartnerId | string | false | fk | Identifier of business partner that has entered a user-defined emission factor | |
OperationalMeasurementGuid | string | false | fk | Differentiated emission factor for certain operational measurement |
Property | Value |
Name | Country |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Country in which the emission factor is valid |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of resource consumption the emission factor refers to |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity starts e.g: 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity ends e.g: 31.13.19 23:59 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Value of emission factor |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Unit of emission factor in terms of kgCO2e per unit of resource consumption |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Source |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Source of emission factor e.g. 'International Energy Agency' |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Differentiated emission factor for certain space type (within a building) |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Region |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | City |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Differentiated emission factor for certain site |
Dependencies | |
Required | |
Primary key | |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Differentiated emission factor for certain building |
Dependencies | |
Required | |
Primary key | |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BusinessPartnerId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of business partner that has entered a user-defined emission factor |
Dependencies | |
Required | |
Primary key | |
Foreign collection | BusinessPartner |
Foreign field | BusinessPartnerId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | OperationalMeasurementGuid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Differentiated emission factor for certain operational measurement |
Dependencies | |
Required | |
Primary key | |
Foreign collection | OperationalMeasurement |
Foreign field | Guid |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "EmissionFactor", "additionalProperties": false, "properties": { "Country": { "type": "string", "description": "Country in which the emission factor is valid" }, "Type": { "type": "string", "description": "Type of resource consumption the emission factor refers to" }, "ValidFrom": { "type": "string", "description": "Date validity starts e.g: 01.01.19 00:00" }, "ValidUntil": { "type": "string", "description": "Date validity ends e.g: 31.13.19 23:59" }, "Value": { "type": "number", "description": "Value of emission factor" }, "Unit": { "type": "string", "description": "Unit of emission factor in terms of kgCO2e per unit of resource consumption" }, "Source": { "type": "string", "description": "Source of emission factor e.g. 'International Energy Agency'" }, "SpaceType": { "type": "string", "description": "Differentiated emission factor for certain space type (within a building)" }, "Region": { "type": "string" }, "City": { "type": "string" }, "SiteId": { "type": "string", "description": "Differentiated emission factor for certain site" }, "BuildingId": { "type": "string", "description": "Differentiated emission factor for certain building" }, "BusinessPartnerId": { "type": "string", "description": "Identifier of business partner that has entered a user-defined emission factor" }, "OperationalMeasurementGuid": { "type": "string", "description": "Differentiated emission factor for certain operational measurement" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "Country": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Value": -14, "Unit": "Lorem", "Source": "Lorem", "SpaceType": "Lorem", "Region": "Lorem", "City": "Lorem", "SiteId": "Lorem", "BuildingId": "Lorem", "BusinessPartnerId": "Lorem", "OperationalMeasurementGuid": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | OperationalMeasurement |
Technical name | |
Activated | true |
Id | |
Description | |
Group | EnergyAndRessources |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
Guid | string | false | dk | Globally Unique Identifier number | |
Parent | string | false | Parent (Guid) of individual operational measurement | ||
Purpose | string | false | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas | ||
Accuracy | string | false | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
Type | string | false | General type of operational measurement e.g. energy, water or waste | ||
SubType | string | false | Specific type of operational measurement e.g. district heating or water discharge | ||
Name | string | false | Name of individual operational measurement. (user-provided) | ||
Value | integer | false | Value of individual operational measurement | [{"dataType":"float"}] | |
Unit | string | false | Unit of operational measurement e.g. 'kWh' or 'm³' | ||
ProcuredBy | string | false | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol | ||
SpaceType | string | false | Reference to specific space type (or 'whole building') | ||
LCA | string | false | Related life cycle assessment stage according to ISO 14040 e.g. 'B6' | ||
PostingDate | string | false | Date of measurement posting e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
MeasurementDate | string | false | Date of measurement e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ValidFrom | string | false | Date validity starts e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date validity end e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ProjectionBaseYear | string | false | Base year of operational value projected into the future | [{"dataType":"dateTime"}] | |
ProjectionBaseGuid | string | false | Identifier (Guid) of operational value projected into the future | Identifier (Guid) of operational value projected into the future | |
MeterNumber | integer | false | Name of meter providing value (user-provided) | ||
PortfolioId | string | false | fk | Identifier of portfolio | |
SiteId | string | false | fk | Identifier of site | |
LandId | string | false | fk | Identifier of land | |
BuildingId | string | false | fk | Identifier of building | |
FloorId | string | false | fk | Identifier of floor | |
SpaceId | string | false | fk | Identifier of space | |
WorkplaceId | string | false | fk | Identifier of workspace | |
MeterId | string | false | Identifier of meter providing value | ||
BusinessPartnerId | string | false | fk | Identifier of business partner |
Property | Value |
Name | Parent |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Parent (Guid) of individual operational measurement |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Purpose |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Accuracy |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | General type of operational measurement e.g. energy, water or waste |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SubType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Specific type of operational measurement e.g. district heating or water discharge |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of individual operational measurement. (user-provided) |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | integer |
Description | Value of individual operational measurement |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Unit of operational measurement e.g. 'kWh' or 'm³' |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProcuredBy |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference to specific space type (or 'whole building') |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LCA |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Related life cycle assessment stage according to ISO 14040 e.g. 'B6' |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PostingDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date of measurement posting e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | MeasurementDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date of measurement e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity starts e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity end e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ProjectionBaseYear |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Base year of operational value projected into the future |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ProjectionBaseGuid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier (Guid) of operational value projected into the future |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | Identifier (Guid) of operational value projected into the future |
Property | Value |
Name | MeterNumber |
Technical name | |
Activated | true |
Id | |
Type | integer |
Description | Name of meter providing value (user-provided) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PortfolioId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of portfolio |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Portfolio |
Foreign field | PortfolioId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of site |
Dependencies | |
Required | |
Primary key | |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LandId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of land |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Land |
Foreign field | LandId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of building |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of floor |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Floor |
Foreign field | FloorId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of space |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Space |
Foreign field | SpaceId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WorkplaceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of workspace |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Workplace |
Foreign field | WorkplaceId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MeterId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of meter providing value |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BusinessPartnerId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of business partner |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | BusinessPartner |
Foreign field | BusinessPartnerId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "OperationalMeasurement", "additionalProperties": false, "properties": { "Parent": { "type": "string", "description": "Parent (Guid) of individual operational measurement" }, "Purpose": { "type": "string", "description": "Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas" }, "Accuracy": { "type": "string", "description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'" }, "Type": { "type": "string", "description": "General type of operational measurement e.g. energy, water or waste" }, "SubType": { "type": "string", "description": "Specific type of operational measurement e.g. district heating or water discharge" }, "Name": { "type": "string", "description": "Name of individual operational measurement. (user-provided)" }, "Value": { "type": "integer", "description": "Value of individual operational measurement" }, "Unit": { "type": "string", "description": "Unit of operational measurement e.g. 'kWh' or 'm³'" }, "ProcuredBy": { "type": "string", "description": "Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol" }, "SpaceType": { "type": "string", "description": "Reference to specific space type (or 'whole building')" }, "LCA": { "type": "string", "description": "Related life cycle assessment stage according to ISO 14040 e.g. 'B6'" }, "PostingDate": { "type": "string", "description": "Date of measurement posting e.g. 01.01.19 00:00" }, "MeasurementDate": { "type": "string", "description": "Date of measurement e.g. 01.01.19 00:00" }, "ValidFrom": { "type": "string", "description": "Date validity starts e.g. 01.01.19 00:00" }, "ValidUntil": { "type": "string", "description": "Date validity end e.g. 01.01.19 00:00" }, "ProjectionBaseYear": { "type": "string", "description": "Base year of operational value projected into the future" }, "ProjectionBaseGuid": { "type": "string", "description": "Identifier (Guid) of operational value projected into the future" }, "MeterNumber": { "type": "integer", "description": "Name of meter providing value (user-provided)" }, "PortfolioId": { "type": "string", "description": "Identifier of portfolio" }, "SiteId": { "type": "string", "description": "Identifier of site" }, "LandId": { "type": "string", "description": "Identifier of land" }, "BuildingId": { "type": "string", "description": "Identifier of building" }, "FloorId": { "type": "string", "description": "Identifier of floor" }, "SpaceId": { "type": "string", "description": "Identifier of space" }, "WorkplaceId": { "type": "string", "description": "Identifier of workspace" }, "MeterId": { "type": "string", "description": "Identifier of meter providing value" }, "BusinessPartnerId": { "type": "string", "description": "Identifier of business partner" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "Parent": "Lorem", "Purpose": "Lorem", "Accuracy": "Lorem", "Type": "Lorem", "SubType": "Lorem", "Name": "Lorem", "Value": -91, "Unit": "Lorem", "ProcuredBy": "Lorem", "SpaceType": "Lorem", "LCA": "Lorem", "PostingDate": "Lorem", "MeasurementDate": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "ProjectionBaseYear": "Lorem", "ProjectionBaseGuid": "Lorem", "MeterNumber": 75, "PortfolioId": "Lorem", "SiteId": "Lorem", "LandId": "Lorem", "BuildingId": "Lorem", "FloorId": "Lorem", "SpaceId": "Lorem", "WorkplaceId": "Lorem", "MeterId": "Lorem", "BusinessPartnerId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | SustainabilityIndicators |
Technical name | |
Activated | true |
Id | |
Description | |
Group | EnergyAndRessources |
RESTful API | |
Additional properties | |
Comments |
Field | Type | Req | Key | Description | Comments |
Guid | string | false | Globally Unique Identifier number | ||
Category | string | false | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs | ||
Type | string | false | Type of sustainability indicator e.g. absolute or intensity figures or stranding | ||
Subtype | string | false | Subtype of sustainability indicator e.g. net-energy or emission scope | ||
Source | string | false | Operational source of energy or emission figures e.g. electricity or water | ||
ReferenceArea | string | false | Reference area of building used as denominator in intensity calculation | ||
ReportingType | string | false | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
BaseYear | string | false | Base year of values projected into the future | [{"dataType":"dateTime"}] | |
Value | number | false | Value of sustainability indicator | [{"dataType":"float"}] | |
Unit | string | false | Unit of sustainability indicator value | ||
ValidFrom | string | false | Date validity starts e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date validity end e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
BuildingId | string | false | fk | Identifier of building |
Property | Value |
Name | Category |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of sustainability indicator e.g. absolute or intensity figures or stranding |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Subtype |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Subtype of sustainability indicator e.g. net-energy or emission scope |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Source |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Operational source of energy or emission figures e.g. electricity or water |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReferenceArea |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Reference area of building used as denominator in intensity calculation |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReportingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BaseYear |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Base year of values projected into the future |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Value of sustainability indicator |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Unit of sustainability indicator value |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity starts e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity end e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier of building |
Dependencies | |
Required | |
Primary key | |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "SustainabilityIndicators", "properties": { "Category": { "type": "string", "description": "Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs" }, "Type": { "type": "string", "description": "Type of sustainability indicator e.g. absolute or intensity figures or stranding" }, "Subtype": { "type": "string", "description": "Subtype of sustainability indicator e.g. net-energy or emission scope" }, "Source": { "type": "string", "description": "Operational source of energy or emission figures e.g. electricity or water" }, "ReferenceArea": { "type": "string", "description": "Reference area of building used as denominator in intensity calculation" }, "ReportingType": { "type": "string", "description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based" }, "BaseYear": { "type": "string", "description": "Base year of values projected into the future" }, "Value": { "type": "number", "description": "Value of sustainability indicator" }, "Unit": { "type": "string", "description": "Unit of sustainability indicator value" }, "ValidFrom": { "type": "string", "description": "Date validity starts e.g. 01.01.19 00:00" }, "ValidUntil": { "type": "string", "description": "Date validity end e.g. 01.01.19 00:00" }, "BuildingId": { "type": "string", "description": "Identifier of building" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "Category": "Lorem", "Type": "Lorem", "Subtype": "Lorem", "Source": "Lorem", "ReferenceArea": "Lorem", "ReportingType": "Lorem", "BaseYear": "Lorem", "Value": -98, "Unit": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "BuildingId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | SustainabilityTargets |
Technical name | |
Activated | true |
Id | |
Description | |
Group | EnergyAndRessources |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
Guid | string | false | Globally Unique Identifier number | ||
Type | string | false | Overall type of target e.g. energy or carbon | ||
SubType | string | false | Subtype of target e.g. 1.5DC or 2.0DC | ||
BuildingType | string | false | Type of building e.g. residential multi-family | ||
Standard | string | false | Underlying standard of target e.g. CRREM | ||
Name | string | false | Name of individual target (user-provided) | ||
Value | number | false | Value of sustainability target | [{"dataType":"float"}] | |
Unit | string | false | Unit of sustainability target value e.g. kWh/m² | ||
ValidFrom | string | false | Date validity starts e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date validity end e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
Country | string | false | Country in which the sustainability target is valid |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Overall type of target e.g. energy or carbon |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SubType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Subtype of target e.g. 1.5DC or 2.0DC |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Type of building e.g. residential multi-family |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Standard |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Underlying standard of target e.g. CRREM |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of individual target (user-provided) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Value of sustainability target |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Unit of sustainability target value e.g. kWh/m² |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity starts e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity end e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Country |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Country in which the sustainability target is valid |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | Globally Unique Identifier number |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "SustainabilityTargets", "additionalProperties": false, "properties": { "Type": { "type": "string", "description": "Overall type of target e.g. energy or carbon" }, "SubType": { "type": "string", "description": "Subtype of target e.g. 1.5DC or 2.0DC" }, "BuildingType": { "type": "string", "description": "Type of building e.g. residential multi-family" }, "Standard": { "type": "string", "description": "Underlying standard of target e.g. CRREM" }, "Name": { "type": "string", "description": "Name of individual target (user-provided)" }, "Value": { "type": "number", "description": "Value of sustainability target" }, "Unit": { "type": "string", "description": "Unit of sustainability target value e.g. kWh/m²" }, "ValidFrom": { "type": "string", "description": "Date validity starts e.g. 01.01.19 00:00" }, "ValidUntil": { "type": "string", "description": "Date validity end e.g. 01.01.19 00:00" }, "Country": { "type": "string", "description": "Country in which the sustainability target is valid" }, "Guid": { "type": "string" } } }
{ "Type": "Lorem", "SubType": "Lorem", "BuildingType": "Lorem", "Standard": "Lorem", "Name": "Lorem", "Value": 13, "Unit": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Country": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | gHgEmissions |
Technical name | |
Activated | true |
Id | |
Description | |
Group | EnergyAndRessources |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
Guid | string | false | Globally Unique Identifier number | ||
Title | string | false | Name of individual emission value (user-provided) | ||
Parent | string | false | Parent (Guid) of individual emission value | ||
EmissionScope | string | false | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol | ||
ReportingType | string | false | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
Type | string | false | General source of emission e.g. energy, water or waste | ||
SubType | string | false | Specific source of emission e.g. district heating or water discharge | ||
LCA | string | false | Related life cycle assessment stage according to ISO 14040 e.g. 'B6' | ||
ProjectionBaseYear | string | false | Base year of emissions projected into the future | [{"dataType":"dateTime"}] | |
ValidFrom | string | false | Date validity starts e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
ValidUntil | string | false | Date validity end e.g. 01.01.19 00:00 | [{"dataType":"dateTime"}] | |
Value | number | false | Value of individual emission | [{"dataType":"float"}] | |
Unit | string | false | Unit of emission value: kgCO2e | ||
BasedOnUserEmission | string | false | Indication whether emission value is based on user-provided emission factor (Y/N/NA) | ||
Accuracy | string | false | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
SiteId | string | false | fk | Identifier (Guid) of related site | |
BuildingId | string | false | fk | ||
OperationalMeasurementGuid | string | false | fk |
Property | Value |
Name | Title |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Name of individual emission value (user-provided) |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Parent |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Parent (Guid) of individual emission value |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EmissionScope |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReportingType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | General source of emission e.g. energy, water or waste |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SubType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Specific source of emission e.g. district heating or water discharge |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LCA |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Related life cycle assessment stage according to ISO 14040 e.g. 'B6' |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProjectionBaseYear |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Base year of emissions projected into the future |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity starts e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Date validity end e.g. 01.01.19 00:00 |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | Value of individual emission |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Unit of emission value: kgCO2e |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BasedOnUserEmission |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Indication whether emission value is based on user-provided emission factor (Y/N/NA) |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Accuracy |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Identifier (Guid) of related site |
Dependencies | |
Required | |
Primary key | |
Foreign collection | Site |
Foreign field | SiteId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | OperationalMeasurementGuid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | OperationalMeasurement |
Foreign field | Guid |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | Globally Unique Identifier number |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "gHgEmissions", "additionalProperties": false, "properties": { "Title": { "type": "string", "description": "Name of individual emission value (user-provided)" }, "Parent": { "type": "string", "description": "Parent (Guid) of individual emission value" }, "EmissionScope": { "type": "string", "description": "Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol" }, "ReportingType": { "type": "string", "description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based" }, "Type": { "type": "string", "description": "General source of emission e.g. energy, water or waste" }, "SubType": { "type": "string", "description": "Specific source of emission e.g. district heating or water discharge" }, "LCA": { "type": "string", "description": "Related life cycle assessment stage according to ISO 14040 e.g. 'B6'" }, "ProjectionBaseYear": { "type": "string", "description": "Base year of emissions projected into the future" }, "ValidFrom": { "type": "string", "description": "Date validity starts e.g. 01.01.19 00:00" }, "ValidUntil": { "type": "string", "description": "Date validity end e.g. 01.01.19 00:00" }, "Value": { "type": "number", "description": "Value of individual emission" }, "Unit": { "type": "string", "description": "Unit of emission value: kgCO2e" }, "BasedOnUserEmission": { "type": "string", "description": "Indication whether emission value is based on user-provided emission factor (Y/N/NA)" }, "Accuracy": { "type": "string", "description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'" }, "SiteId": { "type": "string", "description": "Identifier (Guid) of related site" }, "BuildingId": { "type": "string" }, "OperationalMeasurementGuid": { "type": "string" }, "Guid": { "type": "string", "description": "Globally Unique Identifier number" } } }
{ "Title": "Lorem", "Parent": "Lorem", "EmissionScope": "Lorem", "ReportingType": "Lorem", "Type": "Lorem", "SubType": "Lorem", "LCA": "Lorem", "ProjectionBaseYear": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Value": 46, "Unit": "Lorem", "BasedOnUserEmission": "Lorem", "Accuracy": "Lorem", "SiteId": "Lorem", "BuildingId": "Lorem", "OperationalMeasurementGuid": "Lorem", "Guid": "Lorem" }
Property | Value |
Group name | Facility Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | EquipmentMonitoring |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Facility Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
EquipmentId | string | false | |||
EquipmentUtilisation | string | false | |||
EquipmentService | string | false | |||
EquipmentStatus | string | false | |||
RootCause | string | false | |||
Value | number | false | |||
Unit | string | false | |||
BuildingId | string | false | |||
ActivityId | string | false |
Property | Value |
Name | EquipmentId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EquipmentUtilisation |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EquipmentService |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EquipmentStatus |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RootCause |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Unit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ActivityId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "EquipmentMonitoring", "additionalProperties": false, "properties": { "EquipmentId": { "type": "string" }, "EquipmentUtilisation": { "type": "string" }, "EquipmentService": { "type": "string" }, "EquipmentStatus": { "type": "string" }, "RootCause": { "type": "string" }, "Value": { "type": "number" }, "Unit": { "type": "string" }, "BuildingId": { "type": "string" }, "ActivityId": { "type": "string" } } }
{ "EquipmentId": "Lorem", "EquipmentUtilisation": "Lorem", "EquipmentService": "Lorem", "EquipmentStatus": "Lorem", "RootCause": "Lorem", "Value": -44, "Unit": "Lorem", "BuildingId": "Lorem", "ActivityId": "Lorem" }
Property | Value |
Document name | InspectionData |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Facility Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
InspectId | string | false |
Property | Value |
Name | InspectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "InspectionData", "additionalProperties": false, "properties": { "InspectId": { "type": "string" } } }
{ "InspectId": "Lorem" }
Property | Value |
Document name | MaintenancePlan |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Facility Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
PlanId | string | false |
Property | Value |
Name | PlanId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "MaintenancePlan", "additionalProperties": false, "properties": { "PlanId": { "type": "string" } } }
{ "PlanId": "Lorem" }
Property | Value |
Document name | ObjectStatusStrategy |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Facility Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
StatusId | string | false |
Property | Value |
Name | StatusId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "ObjectStatusStrategy", "additionalProperties": false, "properties": { "StatusId": { "type": "string" } } }
{ "StatusId": "Lorem" }
Property | Value |
Document name | TicketsNotification |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Facility Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
NotificationId | string | false |
Property | Value |
Name | NotificationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "TicketsNotification", "additionalProperties": false, "properties": { "NotificationId": { "type": "string" } } }
{ "NotificationId": "Lorem" }
Property | Value |
Group name | Financials |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Account |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Financials |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
AccountId | string | false | |||
Name | string | false | |||
Category | string | false |
Property | Value |
Name | AccountId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Category |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | Income,Expenses,Revenue,Asset,Liabilities,OffsetAccount |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Account", "additionalProperties": false, "properties": { "AccountId": { "type": "string" }, "Name": { "type": "string" }, "Category": { "type": "string", "enum": [ "Income", "Expenses", "Revenue", "Asset", "Liabilities", "OffsetAccount" ] } } }
{ "AccountId": "Lorem", "Name": "Lorem", "Category": "OffsetAccount" }
Property | Value |
Document name | Budget |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Financials |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
BudgetId | string | false | |||
Type | string | false |
Property | Value |
Name | BudgetId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Budget", "additionalProperties": false, "properties": { "BudgetId": { "type": "string" }, "Type": { "type": "string" } } }
{ "BudgetId": "Lorem", "Type": "Lorem" }
Property | Value |
Document name | CostObject |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Financials |
RESTful API | |
Additional properties | false |
Comments | The Entity for Cost Center |
Field | Type | Req | Key | Description | Comments |
CostObjectIdId | string | false | |||
Name | string | false | |||
Type | string | false | |||
Value | string | false | |||
PortfolioId | string | false | |||
SiteId | string | false | |||
BuildingId | string | false |
Property | Value |
Name | CostObjectIdId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PortfolioId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "CostObject", "additionalProperties": false, "properties": { "CostObjectIdId": { "type": "string" }, "Name": { "type": "string" }, "Type": { "type": "string" }, "Value": { "type": "string" }, "PortfolioId": { "type": "string" }, "SiteId": { "type": "string" }, "BuildingId": { "type": "string" } } }
{ "CostObjectIdId": "Lorem", "Name": "Lorem", "Type": "Lorem", "Value": "Lorem", "PortfolioId": "Lorem", "SiteId": "Lorem", "BuildingId": "Lorem" }
Property | Value |
Document name | CostTransaction |
Technical name | CstTrnsctn |
Activated | true |
Id | |
Description | |
Group | Financials |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
TransactionId | string | false | |||
PostingDate | string | false | [{ "dataType":"DateTime"}] | ||
CostObjectId | string | false | |||
CostGroupId | string | false | |||
CostCategoryId | string | false | |||
CostTypeId | string | false | |||
CostElementId | string | false | |||
CostValue | number | false | |||
Currency | string | false | |||
DocumentId | string | false | |||
AccountId | string | false |
Property | Value |
Name | TransactionId |
Technical name | Trnsctnd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PostingDate |
Technical name | PstngDt |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{ "dataType":"DateTime"}] |
Property | Value |
Name | CostObjectId |
Technical name | Cstbjctd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostGroupId |
Technical name | CstGrpd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostCategoryId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostTypeId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostElementId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostValue |
Technical name | CstVl |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Currency |
Technical name | Crrncy |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DocumentId |
Technical name | Dcmntd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AccountId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "CostTransaction", "additionalProperties": false, "properties": { "Trnsctnd": { "type": "string" }, "PstngDt": { "type": "string" }, "Cstbjctd": { "type": "string" }, "CstGrpd": { "type": "string" }, "CostCategoryId": { "type": "string" }, "CostTypeId": { "type": "string" }, "CostElementId": { "type": "string" }, "CstVl": { "type": "number" }, "Crrncy": { "type": "string" }, "Dcmntd": { "type": "string" }, "AccountId": { "type": "string" } } }
{ "Trnsctnd": "Lorem", "PstngDt": "Lorem", "Cstbjctd": "Lorem", "CstGrpd": "Lorem", "CostCategoryId": "Lorem", "CostTypeId": "Lorem", "CostElementId": "Lorem", "CstVl": -33, "Crrncy": "Lorem", "Dcmntd": "Lorem", "AccountId": "Lorem" }
Property | Value |
Document name | Invoicing |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Financials |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
InvoiceId | string | false | |||
Vat | string | false |
Property | Value |
Name | Vat |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | InvoiceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Invoicing", "additionalProperties": false, "properties": { "Vat": { "type": "string" }, "InvoiceId": { "type": "string" } } }
{ "Vat": "Lorem", "InvoiceId": "Lorem" }
Property | Value |
Group name | InvestmentManagement |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Financing |
Technical name | |
Activated | true |
Id | |
Description | |
Group | InvestmentManagement |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
FinancingId | string | false |
Property | Value |
Name | FinancingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Financing", "additionalProperties": false, "properties": { "FinancingId": { "type": "string" } } }
{ "FinancingId": "Lorem" }
Property | Value |
Document name | FondStructure |
Technical name | |
Activated | true |
Id | |
Description | |
Group | InvestmentManagement |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
FondStructureId | string | false |
Property | Value |
Name | FondStructureId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "FondStructure", "additionalProperties": false, "properties": { "FondStructureId": { "type": "string" } } }
{ "FondStructureId": "Lorem" }
Property | Value |
Group name | MarketData |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | DemandData |
Technical name | |
Activated | true |
Id | |
Description | |
Group | MarketData |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
DemandDataId | string | false |
Property | Value |
Name | DemandDataId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "DemandData", "additionalProperties": false, "properties": { "DemandDataId": { "type": "string" } } }
{ "DemandDataId": "Lorem" }
Property | Value |
Document name | DemographicData |
Technical name | |
Activated | true |
Id | |
Description | |
Group | MarketData |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
DemographicDataId | string | false |
Property | Value |
Name | DemographicDataId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "DemographicData", "additionalProperties": false, "properties": { "DemographicDataId": { "type": "string" } } }
{ "DemographicDataId": "Lorem" }
Property | Value |
Document name | LocationInformation |
Technical name | |
Activated | true |
Id | |
Description | |
Group | MarketData |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
InformationId | string | false |
Property | Value |
Name | InformationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "LocationInformation", "additionalProperties": false, "properties": { "InformationId": { "type": "string" } } }
{ "InformationId": "Lorem" }
Property | Value |
Document name | MobilityData |
Technical name | |
Activated | true |
Id | |
Description | |
Group | MarketData |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
MobilityDataId | string | false |
Property | Value |
Name | MobilityDataId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "MobilityData", "additionalProperties": false, "properties": { "MobilityDataId": { "type": "string" } } }
{ "MobilityDataId": "Lorem" }
Property | Value |
Document name | RentalData |
Technical name | |
Activated | true |
Id | |
Description | |
Group | MarketData |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RentalDataId | string | false |
Property | Value |
Name | RentalDataId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "RentalData", "additionalProperties": false, "properties": { "RentalDataId": { "type": "string" } } }
{ "RentalDataId": "Lorem" }
Property | Value |
Group name | Order Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | FrameworkContract |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ContractId | string | false | |||
ContractTpe | string | false | |||
IssuerId | string | false | |||
RecipientId | string | false | |||
ValidFrom | string | false | [{"dataType":"dateTime"}] | ||
ValidUntil | string | false | [{"dataType":"dateTime"}] | ||
Terms | string | false | |||
Value | number | false | |||
Currency | string | false | |||
DocumentId | string | false | |||
SiteId | string | false | |||
BuildingId | string | false | |||
FloorId | string | false | |||
SpaceId | string | false |
Property | Value |
Name | ContractId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractTpe |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | IssuerId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RecipientId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Terms |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Currency |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DocumentId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SiteId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FloorId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpaceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "FrameworkContract", "additionalProperties": false, "properties": { "ContractId": { "type": "string" }, "ContractTpe": { "type": "string" }, "IssuerId": { "type": "string" }, "RecipientId": { "type": "string" }, "ValidFrom": { "type": "string" }, "ValidUntil": { "type": "string" }, "Terms": { "type": "string" }, "Value": { "type": "number" }, "Currency": { "type": "string" }, "DocumentId": { "type": "string" }, "SiteId": { "type": "string" }, "BuildingId": { "type": "string" }, "FloorId": { "type": "string" }, "SpaceId": { "type": "string" } } }
{ "ContractId": "Lorem", "ContractTpe": "Lorem", "IssuerId": "Lorem", "RecipientId": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Terms": "Lorem", "Value": 82, "Currency": "Lorem", "DocumentId": "Lorem", "SiteId": "Lorem", "BuildingId": "Lorem", "FloorId": "Lorem", "SpaceId": "Lorem" }
Property | Value |
Document name | GoodIssueServiceConfirmation |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ConfirmationId | string | false |
Property | Value |
Name | ConfirmationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "GoodIssueServiceConfirmation", "additionalProperties": false, "properties": { "ConfirmationId": { "type": "string" } } }
{ "ConfirmationId": "Lorem" }
Property | Value |
Document name | Insurance |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
InsuranceId | string | false |
Property | Value |
Name | InsuranceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Insurance", "additionalProperties": false, "properties": { "InsuranceId": { "type": "string" } } }
{ "InsuranceId": "Lorem" }
Property | Value |
Document name | MaintenanceContract |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ContractId | string | false | |||
Type | string | false | |||
MaintenanceDuty | string | false | |||
CalibrationPeriod | string | false | |||
DateofApproval | string | false | [{ "dataType":"DateTime"}] | ||
CommissioningDate | string | false | |||
WarrantyPeriod | string | false | |||
ServiceLife | string | false | |||
MaintenanceInterval | string | false |
Property | Value |
Name | ContractId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaintenanceDuty |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CalibrationPeriod |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DateofApproval |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{ "dataType":"DateTime"}] |
Property | Value |
Name | CommissioningDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WarrantyPeriod |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ServiceLife |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | MaintenanceInterval |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "MaintenanceContract", "additionalProperties": false, "properties": { "ContractId": { "type": "string" }, "Type": { "type": "string" }, "MaintenanceDuty": { "type": "string" }, "CalibrationPeriod": { "type": "string" }, "DateofApproval": { "type": "string" }, "CommissioningDate": { "type": "string" }, "WarrantyPeriod": { "type": "string" }, "ServiceLife": { "type": "string" }, "MaintenanceInterval": { "type": "string" } } }
{ "ContractId": "Lorem", "Type": "Lorem", "MaintenanceDuty": "Lorem", "CalibrationPeriod": "Lorem", "DateofApproval": "Lorem", "CommissioningDate": "Lorem", "WarrantyPeriod": "Lorem", "ServiceLife": "Lorem", "MaintenanceInterval": "Lorem" }
Property | Value |
Document name | Offer |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
OfferId | string | false |
Property | Value |
Name | OfferId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Offer", "additionalProperties": false, "properties": { "OfferId": { "type": "string" } } }
{ "OfferId": "Lorem" }
Property | Value |
Document name | PurchaseOrder |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
OrderId | integer | false | |||
PurchaseOrderType | string | false |
Property | Value |
Name | OrderId |
Technical name | |
Activated | true |
Id | |
Type | integer |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PurchaseOrderType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "PurchaseOrder", "additionalProperties": false, "properties": { "OrderId": { "type": "integer" }, "PurchaseOrderType": { "type": "string" } } }
{ "OrderId": -71, "PurchaseOrderType": "Lorem" }
Property | Value |
Document name | PurchaseRequisition |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
PurchaseId | string | false |
Property | Value |
Name | PurchaseId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "PurchaseRequisition", "additionalProperties": false, "properties": { "PurchaseId": { "type": "string" } } }
{ "PurchaseId": "Lorem" }
Property | Value |
Document name | Rating |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RatingId | string | false |
Property | Value |
Name | RatingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Rating", "additionalProperties": false, "properties": { "RatingId": { "type": "string" } } }
{ "RatingId": "Lorem" }
Property | Value |
Document name | Refusal |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RefusalId | string | false |
Property | Value |
Name | RefusalId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Refusal", "additionalProperties": false, "properties": { "RefusalId": { "type": "string" } } }
{ "RefusalId": "Lorem" }
Property | Value |
Document name | RequestForProposal |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RequestId | string | false |
Property | Value |
Name | RequestId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "RequestForProposal", "additionalProperties": false, "properties": { "RequestId": { "type": "string" } } }
{ "RequestId": "Lorem" }
Property | Value |
Document name | Service |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ServiceID | string | false |
Property | Value |
Name | ServiceID |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Service", "additionalProperties": false, "properties": { "ServiceID": { "type": "string" } } }
{ "ServiceID": "Lorem" }
Property | Value |
Document name | WorkOrder |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
WorkOrderId | string | false |
Property | Value |
Name | WorkOrderId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "WorkOrder", "additionalProperties": false, "properties": { "WorkOrderId": { "type": "string" } } }
{ "WorkOrderId": "Lorem" }
Property | Value |
Document name | WorkOrderConformation |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Order Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ConformationId | string | false |
Property | Value |
Name | ConformationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "WorkOrderConformation", "additionalProperties": false, "properties": { "ConformationId": { "type": "string" } } }
{ "ConformationId": "Lorem" }
Property | Value |
Group name | Organizational Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Address1 |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Organizational Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
AddressId | string | false | dk |
Property | Value |
Name | AddressId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Address1", "additionalProperties": false, "properties": { "AddressId": { "type": "string" } } }
{ "AddressId": "Lorem" }
Property | Value |
Document name | Address2 |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Organizational Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Address2", "additionalProperties": false }
{}
Property | Value |
Document name | Authorization |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Organizational Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
AuthorizationId | string | false |
Property | Value |
Name | AuthorizationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Authorization", "additionalProperties": false, "properties": { "AuthorizationId": { "type": "string" } } }
{ "AuthorizationId": "Lorem" }
Property | Value |
Document name | BusinessPartner |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Organizational Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
BusinessPartnerId | string | false | dk | ||
Title | string | false | |||
ForeName | string | false | |||
Type | string | false | |||
ZipCode | string | false | |||
Country | string | false | |||
City | string | false | |||
HouseNumber | string | false | |||
Street | string | false | |||
Surname | string | false | |||
Vat | number | false |
Property | Value |
Name | BusinessPartnerId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Title |
Technical name | Ttl |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ForeName |
Technical name | FrNm |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ZipCode |
Technical name | ZpCd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Country |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | City |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | HouseNumber |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Street |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Surname |
Technical name | Srnm |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Vat |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "BusinessPartner", "additionalProperties": false, "properties": { "BusinessPartnerId": { "type": "string" }, "Ttl": { "type": "string" }, "FrNm": { "type": "string" }, "Type": { "type": "string" }, "ZpCd": { "type": "string" }, "Country": { "type": "string" }, "City": { "type": "string" }, "HouseNumber": { "type": "string" }, "Street": { "type": "string" }, "Srnm": { "type": "string" }, "Vat": { "type": "number" } } }
{ "BusinessPartnerId": "Lorem", "Ttl": "Lorem", "FrNm": "Lorem", "Type": "Lorem", "ZpCd": "Lorem", "Country": "Lorem", "City": "Lorem", "HouseNumber": "Lorem", "Street": "Lorem", "Srnm": "Lorem", "Vat": 55 }
Property | Value |
Document name | CompanyStructureBusinessUnit |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Organizational Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
CompanyStructureId | string | false |
Property | Value |
Name | CompanyStructureId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "CompanyStructureBusinessUnit", "additionalProperties": false, "properties": { "CompanyStructureId": { "type": "string" } } }
{ "CompanyStructureId": "Lorem" }
Property | Value |
Document name | Role |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Organizational Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RoleId | string | false | |||
BuildingId | string | false | fk |
Property | Value |
Name | RoleId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Role", "additionalProperties": false, "properties": { "RoleId": { "type": "string" }, "BuildingId": { "type": "string" } } }
{ "RoleId": "Lorem", "BuildingId": "Lorem" }
Property | Value |
Group name | Portfolio & Asset Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | PartOfPortfolio |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Portfolio & Asset Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
LineId | string | false |
Property | Value |
Name | LineId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "PartOfPortfolio", "additionalProperties": false, "properties": { "LineId": { "type": "string" } } }
{ "LineId": "Lorem" }
Property | Value |
Document name | Portfolio |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Portfolio & Asset Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
PortfolioId | string | false | dk | ||
PortfolioCode | string | false | |||
Name | string | true | |||
Type | string | false | |||
ValidFrom | string | true | [{"dataType":"dateTime"}] | ||
ValidUntil | string | false | [{"dataType":"dateTime"}] | ||
GrossArea | number | false | [{"dataType":"float"}] | ||
BusinessPartnerId | string | false | fk | ||
Guid | string | false |
Property | Value |
Name | PortfolioId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PortfolioCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | true |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | GrossArea |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments | [{"dataType":"float"}] |
Property | Value |
Name | BusinessPartnerId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | BusinessPartner |
Foreign field | BusinessPartnerId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Guid |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Portfolio", "additionalProperties": false, "properties": { "PortfolioId": { "type": "string" }, "PortfolioCode": { "type": "string" }, "Name": { "type": "string" }, "Type": { "type": "string" }, "ValidFrom": { "type": "string" }, "ValidUntil": { "type": "string" }, "GrossArea": { "type": "number" }, "BusinessPartnerId": { "type": "string" }, "Guid": { "type": "string" } }, "required": [ "Name", "ValidFrom" ] }
{ "PortfolioId": "Lorem", "PortfolioCode": "Lorem", "Name": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "GrossArea": 67, "BusinessPartnerId": "Lorem", "Guid": "Lorem" }
Property | Value |
Document name | StrategicProgramsandMeasures |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Portfolio & Asset Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
LineId | string | false |
Property | Value |
Name | LineId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "StrategicProgramsandMeasures", "additionalProperties": false, "properties": { "LineId": { "type": "string" } } }
{ "LineId": "Lorem" }
Property | Value |
Document name | Valuation |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Portfolio & Asset Management |
RESTful API | |
Additional properties | |
Comments |
Property | Value |
Name | ValuationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Status |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | Any |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Description |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Text |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Keywords |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | URL |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValuationType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Jurisdiction |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LandId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DocumentId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RoleId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TransactionId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValueId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | IncomeId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostGroupId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CentroId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CertificateId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Building.PrimaryUse |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Building.SecondaryUse |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Building.Purpose |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Land.ParcelId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Land.PartOfParcelId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Building.Address |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Role.Owner |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Role.Tenant |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Role.Other |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PreviousValuationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PreviousTransaction.Capital |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PreviousTransaction.Rent |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProfessionalStandard |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AccountingStandard |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | JurisdictionalStandard |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ExtendOfInvestigation |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | LimitationsRestrictions |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReportDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReportDateRange |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValuationDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValuationDateRange |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PremiseOfValue |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BasisOfValue |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | NonIVSBasisValue |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Assumptions |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SpecialAssumptions |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Constrains |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value.Capital |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Value.Rental |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Cost.Acquisition |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Income.Rent |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Income.Income |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Explaination |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Approach |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BuildingId.ComparableEvidence |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Statistics |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Valuation", "properties": { "ValuationId": { "type": "string" }, "Name": { "type": "string" }, "Status": { "type": "string" }, "ValidFrom": { "type": "string" }, "ValidUntil": { "type": "string" }, "Any": { "type": "string" }, "Description": { "type": "string" }, "Text": { "type": "string" }, "Keywords": { "type": "string" }, "URL": { "type": "string" }, "ValuationType": { "type": "string" }, "Jurisdiction": { "type": "string" }, "LandId": { "type": "string" }, "BuildingId": { "type": "string" }, "DocumentId": { "type": "string" }, "RoleId": { "type": "string" }, "TransactionId": { "type": "string" }, "ValueId": { "type": "string" }, "IncomeId": { "type": "string" }, "CostGroupId": { "type": "string" }, "CentroId": { "type": "string" }, "CertificateId": { "type": "string" }, "Building.PrimaryUse": { "type": "string" }, "Building.SecondaryUse": { "type": "string" }, "Building.Purpose": { "type": "string" }, "Land.ParcelId": { "type": "string" }, "Land.PartOfParcelId": { "type": "string" }, "Building.Address": { "type": "string" }, "Role.Owner": { "type": "string" }, "Role.Tenant": { "type": "string" }, "Role.Other": { "type": "string" }, "PreviousValuationId": { "type": "string" }, "PreviousTransaction.Capital": { "type": "string" }, "PreviousTransaction.Rent": { "type": "string" }, "ProfessionalStandard": { "type": "string" }, "AccountingStandard": { "type": "string" }, "JurisdictionalStandard": { "type": "string" }, "ExtendOfInvestigation": { "type": "string" }, "LimitationsRestrictions": { "type": "string" }, "ReportDate": { "type": "string" }, "ReportDateRange": { "type": "string" }, "ValuationDate": { "type": "string" }, "ValuationDateRange": { "type": "string" }, "PremiseOfValue": { "type": "string" }, "BasisOfValue": { "type": "string" }, "NonIVSBasisValue": { "type": "string" }, "Assumptions": { "type": "string" }, "SpecialAssumptions": { "type": "string" }, "Constrains": { "type": "string" }, "Value.Capital": { "type": "string" }, "Value.Rental": { "type": "string" }, "Cost.Acquisition": { "type": "string" }, "Income.Rent": { "type": "string" }, "Income.Income": { "type": "string" }, "Explaination": { "type": "string" }, "Approach": { "type": "string" }, "BuildingId.ComparableEvidence": { "type": "string" }, "Statistics": { "type": "string" } } }
{ "ValuationId": "Lorem", "Name": "Lorem", "Status": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "Any": "Lorem", "Description": "Lorem", "Text": "Lorem", "Keywords": "Lorem", "URL": "Lorem", "ValuationType": "Lorem", "Jurisdiction": "Lorem", "LandId": "Lorem", "BuildingId": "Lorem", "DocumentId": "Lorem", "RoleId": "Lorem", "TransactionId": "Lorem", "ValueId": "Lorem", "IncomeId": "Lorem", "CostGroupId": "Lorem", "CentroId": "Lorem", "CertificateId": "Lorem", "Building.PrimaryUse": "Lorem", "Building.SecondaryUse": "Lorem", "Building.Purpose": "Lorem", "Land.ParcelId": "Lorem", "Land.PartOfParcelId": "Lorem", "Building.Address": "Lorem", "Role.Owner": "Lorem", "Role.Tenant": "Lorem", "Role.Other": "Lorem", "PreviousValuationId": "Lorem", "PreviousTransaction.Capital": "Lorem", "PreviousTransaction.Rent": "Lorem", "ProfessionalStandard": "Lorem", "AccountingStandard": "Lorem", "JurisdictionalStandard": "Lorem", "ExtendOfInvestigation": "Lorem", "LimitationsRestrictions": "Lorem", "ReportDate": "Lorem", "ReportDateRange": "Lorem", "ValuationDate": "Lorem", "ValuationDateRange": "Lorem", "PremiseOfValue": "Lorem", "BasisOfValue": "Lorem", "NonIVSBasisValue": "Lorem", "Assumptions": "Lorem", "SpecialAssumptions": "Lorem", "Constrains": "Lorem", "Value.Capital": "Lorem", "Value.Rental": "Lorem", "Cost.Acquisition": "Lorem", "Income.Rent": "Lorem", "Income.Income": "Lorem", "Explaination": "Lorem", "Approach": "Lorem", "BuildingId.ComparableEvidence": "Lorem", "Statistics": "Lorem" }
Property | Value |
Group name | Project Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Activity |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ActivityId | string | false |
Property | Value |
Name | ActivityId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Activity", "additionalProperties": false, "properties": { "ActivityId": { "type": "string" } } }
{ "ActivityId": "Lorem" }
Property | Value |
Document name | CompletionExcecution |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ExecutionId | string | false |
Property | Value |
Name | ExecutionId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "CompletionExcecution", "additionalProperties": false, "properties": { "ExecutionId": { "type": "string" } } }
{ "ExecutionId": "Lorem" }
Property | Value |
Document name | Milestones |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
MilestonesId | string | false |
Property | Value |
Name | MilestonesId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Milestones", "additionalProperties": false, "properties": { "MilestonesId": { "type": "string" } } }
{ "MilestonesId": "Lorem" }
Property | Value |
Document name | Project |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ProjectId | string | false |
Property | Value |
Name | ProjectId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Project", "additionalProperties": false, "properties": { "ProjectId": { "type": "string" } } }
{ "ProjectId": "Lorem" }
Property | Value |
Document name | ProjectDates |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ProjectDatesId | string | false |
Property | Value |
Name | ProjectDatesId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "ProjectDates", "additionalProperties": false, "properties": { "ProjectDatesId": { "type": "string" } } }
{ "ProjectDatesId": "Lorem" }
Property | Value |
Document name | ProjectWorkBreakDownStructure |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
BreakDownId | string | false |
Property | Value |
Name | BreakDownId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "ProjectWorkBreakDownStructure", "additionalProperties": false, "properties": { "BreakDownId": { "type": "string" } } }
{ "BreakDownId": "Lorem" }
Property | Value |
Document name | Risk |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Project Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RiskId | string | false |
Property | Value |
Name | RiskId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Risk", "additionalProperties": false, "properties": { "RiskId": { "type": "string" } } }
{ "RiskId": "Lorem" }
Property | Value |
Group name | Property Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Dunning |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
DunningId | string | false |
Property | Value |
Name | DunningId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Dunning", "additionalProperties": false, "properties": { "DunningId": { "type": "string" } } }
{ "DunningId": "Lorem" }
Property | Value |
Document name | LeaseContract |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
CompanyCode | string | false | |||
Region | string | false | |||
ContractCode | string | false | |||
Name | string | false | |||
ContractGroup | string | false | |||
Lessee | string | false | |||
Lessor | string | false | |||
ContractStatus | string | false | |||
ContractStartDate | string | false | |||
ContractEndDate | string | false | |||
ContractPeriod | string | false | |||
RentalUnit | string | false | |||
Space | string | false | |||
Floor | string | false | |||
Building | string | false | |||
AddressLine1 | string | false | |||
PostalCode | string | false | |||
City | string | false | |||
Country | string | false | |||
ContractDescription | string | false | |||
DateEffectiveContractLine | string | false | |||
EndDateContractLine | string | false | |||
StartDateModification | string | false | |||
AmountPer | string | false | Weekly Monthly Quarterly HalfYearly Yearly | ||
Amount | number | false | |||
EndDateModification | string | false | |||
ContractCurrency | string | false | |||
BaseC urrency | string | false | |||
FxRate | string | false | |||
YearlyTotal | string | false | |||
ReportingCurrency | string | false | |||
ContractLinePeriod | string | false | |||
CostGroup | number | false | |||
ProfitCenter | number | false | |||
BusinessArea | number | false | |||
CostCategory | number | false | |||
FinancialReportingEntity | string | false | |||
PaymentInAdvance | string | false | |||
PaymentFrequency | string | false | |||
DateofFirstPAyment | string | false | |||
ShortTermLease | string | false | |||
AccountingStandard | string | false | |||
ContractType | string | false | |||
DiscountRate | string | false |
Property | Value |
Name | CompanyCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Region |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Name |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractGroup |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Lessee |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Lessor |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractStatus |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractStartDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractEndDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractPeriod |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RentalUnit |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Space |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Floor |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Building |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AddressLine1 |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PostalCode |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | City |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Country |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractDescription |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DateEffectiveContractLine |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EndDateContractLine |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | StartDateModification |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AmountPer |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | Weekly Monthly Quarterly HalfYearly Yearly |
Property | Value |
Name | Amount |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | EndDateModification |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractCurrency |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BaseC urrency |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FxRate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | YearlyTotal |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ReportingCurrency |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractLinePeriod |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostGroup |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ProfitCenter |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BusinessArea |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | CostCategory |
Technical name | |
Activated | true |
Id | |
Type | number |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | FinancialReportingEntity |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PaymentInAdvance |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PaymentFrequency |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DateofFirstPAyment |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ShortTermLease |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AccountingStandard |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | DiscountRate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "LeaseContract", "additionalProperties": false, "properties": { "CompanyCode": { "type": "string" }, "Region": { "type": "string" }, "ContractCode": { "type": "string" }, "Name": { "type": "string" }, "ContractGroup": { "type": "string" }, "Lessee": { "type": "string" }, "Lessor": { "type": "string" }, "ContractStatus": { "type": "string" }, "ContractStartDate": { "type": "string" }, "ContractEndDate": { "type": "string" }, "ContractPeriod": { "type": "string" }, "RentalUnit": { "type": "string" }, "Space": { "type": "string" }, "Floor": { "type": "string" }, "Building": { "type": "string" }, "AddressLine1": { "type": "string" }, "PostalCode": { "type": "string" }, "City": { "type": "string" }, "Country": { "type": "string" }, "ContractDescription": { "type": "string" }, "DateEffectiveContractLine": { "type": "string" }, "EndDateContractLine": { "type": "string" }, "StartDateModification": { "type": "string" }, "AmountPer": { "type": "string" }, "Amount": { "type": "number" }, "EndDateModification": { "type": "string" }, "ContractCurrency": { "type": "string" }, "BaseC urrency": { "type": "string" }, "FxRate": { "type": "string" }, "YearlyTotal": { "type": "string" }, "ReportingCurrency": { "type": "string" }, "ContractLinePeriod": { "type": "string" }, "CostGroup": { "type": "number" }, "ProfitCenter": { "type": "number" }, "BusinessArea": { "type": "number" }, "CostCategory": { "type": "number" }, "FinancialReportingEntity": { "type": "string" }, "PaymentInAdvance": { "type": "string" }, "PaymentFrequency": { "type": "string" }, "DateofFirstPAyment": { "type": "string" }, "ShortTermLease": { "type": "string" }, "AccountingStandard": { "type": "string" }, "ContractType": { "type": "string" }, "DiscountRate": { "type": "string" } } }
{ "CompanyCode": "Lorem", "Region": "Lorem", "ContractCode": "Lorem", "Name": "Lorem", "ContractGroup": "Lorem", "Lessee": "Lorem", "Lessor": "Lorem", "ContractStatus": "Lorem", "ContractStartDate": "Lorem", "ContractEndDate": "Lorem", "ContractPeriod": "Lorem", "RentalUnit": "Lorem", "Space": "Lorem", "Floor": "Lorem", "Building": "Lorem", "AddressLine1": "Lorem", "PostalCode": "Lorem", "City": "Lorem", "Country": "Lorem", "ContractDescription": "Lorem", "DateEffectiveContractLine": "Lorem", "EndDateContractLine": "Lorem", "StartDateModification": "Lorem", "AmountPer": "Lorem", "Amount": 16, "EndDateModification": "Lorem", "ContractCurrency": "Lorem", "BaseC urrency": "Lorem", "FxRate": "Lorem", "YearlyTotal": "Lorem", "ReportingCurrency": "Lorem", "ContractLinePeriod": "Lorem", "CostGroup": -29, "ProfitCenter": 42, "BusinessArea": 20, "CostCategory": -36, "FinancialReportingEntity": "Lorem", "PaymentInAdvance": "Lorem", "PaymentFrequency": "Lorem", "DateofFirstPAyment": "Lorem", "ShortTermLease": "Lorem", "AccountingStandard": "Lorem", "ContractType": "Lorem", "DiscountRate": "Lorem" }
Property | Value |
Document name | MarketingCampagne |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
CampagneId | string | false |
Property | Value |
Name | CampagneId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "MarketingCampagne", "additionalProperties": false, "properties": { "CampagneId": { "type": "string" } } }
{ "CampagneId": "Lorem" }
Property | Value |
Document name | RentalContract |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ContractId | string | false | |||
RentalUnitId | string | false | fk | ||
Type | string | false | |||
ValidFrom | string | false | [{"dataType":"dateTime"}] | ||
ValidUntil | string | false | [{"dataType":"dateTime"}] | ||
FixedLeaseTearm | string | false | |||
ExtensionOption | string | false | |||
RentMonth | string | false | |||
RentYear | string | false | |||
AncilarryCost | string | false | |||
GrossRentMonth | string | false | |||
GrossRentYear | string | false | |||
SigningDate | string | false | |||
ContractStatus | string | false | |||
TurnoverRent | string | false | |||
PaymentDate | string | false | |||
VATrelevant | boolean | false | |||
RentStartDate | string | false | |||
Indexation | integer | false |
Property | Value |
Name | RentalUnitId |
Technical name | Rntlntd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | RentalUnit |
Foreign field | RentalUnitId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Type |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ValidFrom |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | ValidUntil |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments | [{"dataType":"dateTime"}] |
Property | Value |
Name | FixedLeaseTearm |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ExtensionOption |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RentMonth |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RentYear |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | AncilarryCost |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GrossRentMonth |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | GrossRentYear |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | SigningDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | ContractStatus |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | TurnoverRent |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | PaymentDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | VATrelevant |
Technical name | |
Activated | true |
Id | |
Type | boolean |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Sample | |
Comments |
Property | Value |
Name | RentStartDate |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | Indexation |
Technical name | |
Activated | true |
Id | |
Type | integer |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Unit | |
Min value | |
Excl min | |
Max value | |
Excl max | |
Multiple of | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "RentalContract", "additionalProperties": false, "properties": { "Rntlntd": { "type": "string" }, "ContractId": { "type": "string" }, "Type": { "type": "string" }, "ValidFrom": { "type": "string" }, "ValidUntil": { "type": "string" }, "FixedLeaseTearm": { "type": "string" }, "ExtensionOption": { "type": "string" }, "RentMonth": { "type": "string" }, "RentYear": { "type": "string" }, "AncilarryCost": { "type": "string" }, "GrossRentMonth": { "type": "string" }, "GrossRentYear": { "type": "string" }, "SigningDate": { "type": "string" }, "ContractStatus": { "type": "string" }, "TurnoverRent": { "type": "string" }, "PaymentDate": { "type": "string" }, "VATrelevant": { "type": "boolean" }, "RentStartDate": { "type": "string" }, "Indexation": { "type": "integer" } } }
{ "Rntlntd": "Lorem", "ContractId": "Lorem", "Type": "Lorem", "ValidFrom": "Lorem", "ValidUntil": "Lorem", "FixedLeaseTearm": "Lorem", "ExtensionOption": "Lorem", "RentMonth": "Lorem", "RentYear": "Lorem", "AncilarryCost": "Lorem", "GrossRentMonth": "Lorem", "GrossRentYear": "Lorem", "SigningDate": "Lorem", "ContractStatus": "Lorem", "TurnoverRent": "Lorem", "PaymentDate": "Lorem", "VATrelevant": true, "RentStartDate": "Lorem", "Indexation": 62 }
Property | Value |
Document name | RentalUnit |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RentalUnitId | string | false | dk | ||
BuildingId | string | false | fk | ||
BusinessPartnerId | string | false | fk |
Property | Value |
Name | BuildingId |
Technical name | Bldngd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | Building |
Foreign field | BuildingId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | BusinessPartnerId |
Technical name | BsnssPrtnrd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | BusinessPartner |
Foreign field | BusinessPartnerId |
Relationship type | Foreign Key |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | RentalUnitId |
Technical name | Rntlntd |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "RentalUnit", "additionalProperties": false, "properties": { "Bldngd": { "type": "string" }, "BsnssPrtnrd": { "type": "string" }, "Rntlntd": { "type": "string" } } }
{ "Bldngd": "Lorem", "BsnssPrtnrd": "Lorem", "Rntlntd": "Lorem" }
Property | Value |
Document name | SecurityDeposit |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
DepositId | string | false |
Property | Value |
Name | DepositId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "SecurityDeposit", "additionalProperties": false, "properties": { "DepositId": { "type": "string" } } }
{ "DepositId": "Lorem" }
Property | Value |
Document name | TenantCommunication |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Property Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
LineId | string | false |
Property | Value |
Name | LineId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "TenantCommunication", "additionalProperties": false, "properties": { "LineId": { "type": "string" } } }
{ "LineId": "Lorem" }
Property | Value |
Group name | Transaction Management |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Transaction |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Transaction Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
TransactionId | string | false |
Property | Value |
Name | TransactionId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Transaction", "additionalProperties": false, "properties": { "TransactionId": { "type": "string" } } }
{ "TransactionId": "Lorem" }
Property | Value |
Document name | TransactionContract |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Transaction Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ContractId | string | false |
Property | Value |
Name | ContractId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "TransactionContract", "additionalProperties": false, "properties": { "ContractId": { "type": "string" } } }
{ "ContractId": "Lorem" }
Property | Value |
Document name | TransactionOffer |
Technical name | |
Activated | true |
Id | |
Description | |
Group | Transaction Management |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
TransactionId | string | false |
Property | Value |
Name | TransactionId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "TransactionOffer", "additionalProperties": false, "properties": { "TransactionId": { "type": "string" } } }
{ "TransactionId": "Lorem" }
Property | Value |
Group name | UserAndCustomerExperience |
Technical name | |
Activated | true |
Description | |
Comments |
Property | Value |
Document name | Furniture |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
FurnitureId | string | false |
Property | Value |
Name | FurnitureId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Furniture", "additionalProperties": false, "properties": { "FurnitureId": { "type": "string" } } }
{ "FurnitureId": "Lorem" }
Property | Value |
Document name | Occupation |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
OccupationId | string | false |
Property | Value |
Name | OccupationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Occupation", "additionalProperties": false, "properties": { "OccupationId": { "type": "string" } } }
{ "OccupationId": "Lorem" }
Property | Value |
Document name | Reservation |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
ReservationId | string | false |
Property | Value |
Name | ReservationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Reservation", "additionalProperties": false, "properties": { "ReservationId": { "type": "string" } } }
{ "ReservationId": "Lorem" }
Property | Value |
Document name | SatisfactionTenantUser |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
TransactionId | string | false |
Property | Value |
Name | TransactionId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "SatisfactionTenantUser", "additionalProperties": false, "properties": { "TransactionId": { "type": "string" } } }
{ "TransactionId": "Lorem" }
Property | Value |
Document name | SpaceUtilization |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
UtilizationId | string | false |
Property | Value |
Name | UtilizationId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "SpaceUtilization", "additionalProperties": false, "properties": { "UtilizationId": { "type": "string" } } }
{ "UtilizationId": "Lorem" }
Property | Value |
Document name | UserRequirements |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
RequirementId | string | false |
Property | Value |
Name | RequirementId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "UserRequirements", "additionalProperties": false, "properties": { "RequirementId": { "type": "string" } } }
{ "RequirementId": "Lorem" }
Property | Value |
Document name | Workplace |
Technical name | |
Activated | true |
Id | |
Description | |
Group | UserAndCustomerExperience |
RESTful API | |
Additional properties | false |
Comments |
Field | Type | Req | Key | Description | Comments |
WorkplaceId | string | false | dk | ||
AreaId | string | false | |||
WorkplaceType | string | false | |||
WorkplaceName | string | false |
Property | Value |
Name | AreaId |
Technical name | Ard |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WorkplaceId |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | true |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WorkplaceType |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
Property | Value |
Name | WorkplaceName |
Technical name | |
Activated | true |
Id | |
Type | string |
Description | |
Dependencies | |
Required | |
Primary key | false |
Foreign collection | |
Foreign field | |
Relationship type | |
Default | |
Min length | |
Max length | |
Pattern | |
Format | |
Enum | |
Sample | |
Comments |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Workplace", "additionalProperties": false, "properties": { "Ard": { "type": "string" }, "WorkplaceId": { "type": "string" }, "WorkplaceType": { "type": "string" }, "WorkplaceName": { "type": "string" } } }
{ "Ard": "Lorem", "WorkplaceId": "Lorem", "WorkplaceType": "Lorem", "WorkplaceName": "Lorem" }
Property | Value |
Name | fk Building.BuildingId to AreaMeasurement.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to Certificate.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | Certificate |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to EmissionFactor.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | EmissionFactor |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to Floor.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | Floor |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
Building | BuildingId |
Child Table | Child field |
OperationalMeasurement | BuildingId |
Property | Value |
Name | fk Building.BuildingId to OperationalMeasurement.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to RentalUnit.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | RentalUnit |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to Role.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | Role |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
Building | BuildingId |
Child Table | Child field |
SustainabilityIndicators | BuildingId |
Property | Value |
Name | fk Building.BuildingId to SustainabilityIndicators.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | SustainabilityIndicators |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to Unit.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | Unit |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Building.BuildingId to gHgEmissions.BuildingId |
Description | |
Parent Document | Building |
Parent field | BuildingId |
Parent Cardinality | 1 |
Child Document | gHgEmissions |
Child field | BuildingId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
BusinessPartner | BusinessPartnerId |
Child Table | Child field |
EmissionFactor | BusinessPartnerId |
Property | Value |
Name | fk BusinessPartner.BusinessPartnerId to EmissionFactor.BusinessPartnerId |
Description | |
Parent Document | BusinessPartner |
Parent field | BusinessPartnerId |
Parent Cardinality | 1 |
Child Document | EmissionFactor |
Child field | BusinessPartnerId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
BusinessPartner | BusinessPartnerId |
Child Table | Child field |
OperationalMeasurement | BusinessPartnerId |
Property | Value |
Name | fk BusinessPartner.BusinessPartnerId to OperationalMeasurement.BusinessPartnerId |
Description | |
Parent Document | BusinessPartner |
Parent field | BusinessPartnerId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | BusinessPartnerId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
BusinessPartner | BusinessPartnerId |
Child Table | Child field |
Portfolio | BusinessPartnerId |
Property | Value |
Name | fk BusinessPartner.BusinessPartnerId to Portfolio.BusinessPartnerId |
Description | |
Parent Document | BusinessPartner |
Parent field | BusinessPartnerId |
Parent Cardinality | 1 |
Child Document | Portfolio |
Child field | BusinessPartnerId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
BusinessPartner | BusinessPartnerId |
Child Table | Child field |
Product | BusinessPartnerId |
Property | Value |
Name | fk BusinessPartner.BusinessPartnerId to Product.BusinessPartnerId |
Description | |
Parent Document | BusinessPartner |
Parent field | BusinessPartnerId |
Parent Cardinality | 1 |
Child Document | Product |
Child field | BusinessPartnerId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
BusinessPartner | BusinessPartnerId |
Child Table | Child field |
RentalUnit | BusinessPartnerId |
Property | Value |
Name | fk BusinessPartner.BusinessPartnerId to RentalUnit.BusinessPartnerId |
Description | |
Parent Document | BusinessPartner |
Parent field | BusinessPartnerId |
Parent Cardinality | 1 |
Child Document | RentalUnit |
Child field | BusinessPartnerId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
BusinessPartner | BusinessPartnerId |
Child Table | Child field |
Site | BusinessPartnerId |
Property | Value |
Name | fk BusinessPartner.BusinessPartnerId to Site.BusinessPartnerId |
Description | |
Parent Document | BusinessPartner |
Parent field | BusinessPartnerId |
Parent Cardinality | 1 |
Child Document | Site |
Child field | BusinessPartnerId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Certificate.CertificateId to Building.CertificateId |
Description | |
Parent Document | Certificate |
Parent field | CertificateId |
Parent Cardinality | 1 |
Child Document | Building |
Child field | CertificateId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Floor.FloorId to AreaMeasurement.FloorId |
Description | |
Parent Document | Floor |
Parent field | FloorId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | FloorId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Floor.FloorId to OperationalMeasurement.FloorId |
Description | |
Parent Document | Floor |
Parent field | FloorId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | FloorId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Land.LandId to AreaMeasurement.LandId |
Description | |
Parent Document | Land |
Parent field | LandId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | LandId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Land.LandId to OperationalMeasurement.LandId |
Description | |
Parent Document | Land |
Parent field | LandId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | LandId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Land.LandId to Servitudes.LandId |
Description | |
Parent Document | Land |
Parent field | LandId |
Parent Cardinality | 1 |
Child Document | Servitudes |
Child field | LandId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
OperationalMeasurement | Guid |
Child Table | Child field |
EmissionFactor | OperationalMeasurementGuid |
Property | Value |
Name | fk OperationalMeasurement.GUID to EmissionFactor.OperationalMeasurementId |
Description | |
Parent Document | OperationalMeasurement |
Parent field | Guid |
Parent Cardinality | 1 |
Child Document | EmissionFactor |
Child field | OperationalMeasurementGuid |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
OperationalMeasurement | Guid |
Child Table | Child field |
gHgEmissions | OperationalMeasurementGuid |
Property | Value |
Name | fk OperationalMeasurement.Guid to gHgEmissions.OperationalMeasurementId |
Description | |
Parent Document | OperationalMeasurement |
Parent field | Guid |
Parent Cardinality | 1 |
Child Document | gHgEmissions |
Child field | OperationalMeasurementGuid |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Portfolio.PortfolioId to Building.PortfolioId |
Description | |
Parent Document | Portfolio |
Parent field | PortfolioId |
Parent Cardinality | 1 |
Child Document | Building |
Child field | PortfolioId |
Child Cardinality | 1 |
Comments |
Parent Table | Parent field |
Portfolio | PortfolioId |
Child Table | Child field |
OperationalMeasurement | PortfolioId |
Property | Value |
Name | fk Portfolio.PortfolioId to OperationalMeasurement.PortfolioId |
Description | |
Parent Document | Portfolio |
Parent field | PortfolioId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | PortfolioId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to BSensingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | BSensingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to CStoringObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | CStoringObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to EEmittingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | EEmittingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to FProtectingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | FProtectingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to GGeneratingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | GGeneratingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to HMatterProcessingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | HMatterProcessingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to MDrivingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | MDrivingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to QControllingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | QControllingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to RRestrictingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | RRestrictingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to UHoldingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | UHoldingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Product.ProductId to XInterfacingObject.ProductId |
Description | |
Parent Document | Product |
Parent field | ProductId |
Parent Cardinality | 1 |
Child Document | XInterfacingObject |
Child field | ProductId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk RentalUnit.RentalUnitId to RentalContract.RentalUnitId |
Description | |
Parent Document | RentalUnit |
Parent field | RentalUnitId |
Parent Cardinality | 1 |
Child Document | RentalContract |
Child field | RentalUnitId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Site.SiteId to AreaMeasurement.SiteId |
Description | |
Parent Document | Site |
Parent field | SiteId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | SiteId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Site.SiteId to EmissionFactor.SiteId |
Description | |
Parent Document | Site |
Parent field | SiteId |
Parent Cardinality | 1 |
Child Document | EmissionFactor |
Child field | SiteId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Site.SiteId to OperationalMeasurement.SiteId |
Description | |
Parent Document | Site |
Parent field | SiteId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | SiteId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Site.SiteId to gHgEmissions.SiteId |
Description | |
Parent Document | Site |
Parent field | SiteId |
Parent Cardinality | 1 |
Child Document | gHgEmissions |
Child field | SiteId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Space.SpaceId to AreaMeasurement.SpaceId |
Description | |
Parent Document | Space |
Parent field | SpaceId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | SpaceId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Space.SpaceId to OperationalMeasurement.SpaceId |
Description | |
Parent Document | Space |
Parent field | SpaceId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | SpaceId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Unit.UnitId to AreaMeasurement.UnitId |
Description | |
Parent Document | Unit |
Parent field | UnitId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | UnitId |
Child Cardinality | 1 |
Comments |
Property | Value |
Name | fk Workplace.WorkplaceId to Measurement.WorkplaceId |
Description | |
Parent Document | Workplace |
Parent field | WorkplaceId |
Parent Cardinality | 1 |
Child Document | AreaMeasurement |
Child field | ValidFrom |
Child Cardinality | n |
Comments |
Parent Table | Parent field |
Workplace | WorkplaceId |
Child Table | Child field |
OperationalMeasurement | WorkplaceId |
Property | Value |
Name | fk Workplace.WorkplaceId to OperationalMeasurement.WorkplaceId |
Description | |
Parent Document | Workplace |
Parent field | WorkplaceId |
Parent Cardinality | 1 |
Child Document | OperationalMeasurement |
Child field | WorkplaceId |
Child Cardinality | 1 |
Comments |