Ausstattungselemente

Über diese Endpunkte können Ausstattungselemente verändert werden.

Hinweise zur Funktion

Ausstattungselemente sind bewegliche Dinge im oder am Objekt. Sie müssen immer einer Ausstattungsgruppenart zugeordnet sein.

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Zu den Endpunkten besteht noch ein offener User-Request, welcher die Struktur des Datenobjektes betrifft.

Ausstattungselement anlegen

Version 1.0

---

post

Authorizations

Path parameters

facilityIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

Namestring · max: 70Required

Countnumber · decimalRequiredPattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullableOptional

AcquisitionDatestring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullableOptional

WarrantyEndstring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullableOptional

Positionstring | nullableOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Required

ComponentCatalogIdinteger · int32Required

UnderComponentIdsinteger · int32[] | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

Responseinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 714

{
  "Name": "text",
  "Count": 1,
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-06-27",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-06-27",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-06-27",
    "InstallationDate": "2025-06-27",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-06-27",
    "SummationMeter": true,
    "ReplacedByComponentId": 1,
    "MeteringDeviceTypeId": 1,
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "UnderComponentIds": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

1

---

Version 1.2

---

post

Authorizations

Path parameters

facilityIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

Namestring · max: 70Required

Countnumber · decimalRequiredPattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullableOptional

AcquisitionDatestring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullableOptional

WarrantyEndstring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullableOptional

Positionstring | nullableOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Required

ComponentCatalogIdinteger · int32Required

UnderComponentIdsinteger · int32[] | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

Responseinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 714

{
  "Name": "text",
  "Count": 1,
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-06-27",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-06-27",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-06-27",
    "InstallationDate": "2025-06-27",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-06-27",
    "SummationMeter": true,
    "ReplacedByComponentId": 1,
    "MeteringDeviceTypeId": 1,
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "UnderComponentIds": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

1

---

Ausstattungselement ändern

Version 1.0

---

put

Authorizations

Path parameters

facilityIdinteger · int32Required

componentIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

Namestring · max: 70Required

Countnumber · decimalRequiredPattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullableOptional

AcquisitionDatestring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullableOptional

WarrantyEndstring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullableOptional

Positionstring | nullableOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Required

ComponentCatalogIdinteger · int32Required

UnderComponentIdsinteger · int32[] | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responseinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

HTTPcURLJavaScriptPython

PUT /openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 714

{
  "Name": "text",
  "Count": 1,
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-06-27",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-06-27",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-06-27",
    "InstallationDate": "2025-06-27",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-06-27",
    "SummationMeter": true,
    "ReplacedByComponentId": 1,
    "MeteringDeviceTypeId": 1,
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "UnderComponentIds": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

1

---

Version 1.2

---

put

Authorizations

Path parameters

facilityIdinteger · int32Required

componentIdinteger · int32Required

Query parameters

apiKeystringOptional

Body

application/jsontext/jsonapplication/*+json

Namestring · max: 70Required

Countnumber · decimalRequiredPattern: ^(-?\d{1,12}((\.|\,)\d{1,3})?)$

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullableOptional

AcquisitionDatestring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullableOptional

WarrantyEndstring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullableOptional

Positionstring | nullableOptional

ValidFromstring · dateOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date | nullableOptionalExample: 2025-06-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Required

ComponentCatalogIdinteger · int32Required

UnderComponentIdsinteger · int32[] | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responseinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

HTTPcURLJavaScriptPython

PUT /openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 714

{
  "Name": "text",
  "Count": 1,
  "RepairRelevance": true,
  "LeaseRelevance": true,
  "Comment": "text",
  "AcquisitionDate": "2025-06-27",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-06-27",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-06-27",
  "ValidTo": "2025-06-27",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-06-27",
    "InstallationDate": "2025-06-27",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-06-27",
    "SummationMeter": true,
    "ReplacedByComponentId": 1,
    "MeteringDeviceTypeId": 1,
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "UnderComponentIds": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

1

---

Ausstattungselement löschen

Version 1.0

---

delete

Authorizations

Path parameters

facilityIdinteger · int32Required

componentIdinteger · int32Required

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responseinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

1

---

Version 1.2

---

delete

Authorizations

Path parameters

facilityIdinteger · int32Required

componentIdinteger · int32Required

Query parameters

apiKeystringOptional

Responses

200

OK

text/plainapplication/jsontext/json

Responseinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

HTTPcURLJavaScriptPython

DELETE /openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

1

---

Enumerationen für FacilityStatusId

Id	Type
1	Unaudited
2	Audited
3	Automatic

Enumerationen für "MeteringDeviceTypeId"

Id	Type
1	HeatCostAllocatorEvaporation
2	HeatCostAllocatorElectronic
3	HeatMeterHeatingWarmwater
4	MeterColdwater
5	MeterWarmwater
6	HeatMeterWarmwater
7	HeatMeterHeating
8	WarmwaterAllocatorEvaporation
9	WarmwaterAllocatorMechanical
10	CondensateMeterHeating
11	CondensateMeterWarmwater
12	MeterOil
13	MeterPower
14	MeterGas
15	PipeHeatEmission