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

Autorisierungen

Authorization

Pfadparameter

facilityIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Namestring · max: 70Erforderlich

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

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullfähigOptional

AcquisitionDatestring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullfähigOptional

WarrantyEndstring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullfähigOptional

Positionstring | nullfähigOptional

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

ValidTostring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Erforderlich

ComponentCatalogIdinteger · int32Erforderlich

UnderComponentIdsinteger · int32[] | nullfähigOptional

Antworten

201

Created

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component

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-11-03",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-11-03",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-11-03",
  "ValidTo": "2025-11-03",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-11-03",
    "InstallationDate": "2025-11-03",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-11-03",
    "SummationMeter": true,
    "ReplacedByComponentId": 1,
    "MeteringDeviceTypeId": 1,
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "UnderComponentIds": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

1

---

Version 1.2

---

post

Autorisierungen

Authorization

Pfadparameter

facilityIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Namestring · max: 70Erforderlich

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

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullfähigOptional

AcquisitionDatestring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullfähigOptional

WarrantyEndstring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullfähigOptional

Positionstring | nullfähigOptional

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

ValidTostring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Erforderlich

ComponentCatalogIdinteger · int32Erforderlich

UnderComponentIdsinteger · int32[] | nullfähigOptional

Antworten

201

Created

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

post

/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component

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-11-03",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-11-03",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-11-03",
  "ValidTo": "2025-11-03",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-11-03",
    "InstallationDate": "2025-11-03",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-11-03",
    "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

Autorisierungen

Authorization

Pfadparameter

facilityIdinteger · int32Erforderlich

componentIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Namestring · max: 70Erforderlich

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

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullfähigOptional

AcquisitionDatestring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullfähigOptional

WarrantyEndstring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullfähigOptional

Positionstring | nullfähigOptional

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

ValidTostring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Erforderlich

ComponentCatalogIdinteger · int32Erforderlich

UnderComponentIdsinteger · int32[] | nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

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-11-03",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-11-03",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-11-03",
  "ValidTo": "2025-11-03",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-11-03",
    "InstallationDate": "2025-11-03",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-11-03",
    "SummationMeter": true,
    "ReplacedByComponentId": 1,
    "MeteringDeviceTypeId": 1,
    "ValuationFactorKq": 1,
    "ValuationFactorKc": 1,
    "Virtual": true
  },
  "UnderComponentIds": [
    1
  ]
}

application/jsontext/jsonapplication/*+json

1

---

Version 1.2

---

put

Autorisierungen

Authorization

Pfadparameter

facilityIdinteger · int32Erforderlich

componentIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Rumpf

application/jsontext/jsonapplication/*+json

Namestring · max: 70Erforderlich

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

RepairRelevancebooleanOptional

LeaseRelevancebooleanOptional

Commentstring | nullfähigOptional

AcquisitionDatestring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyPeriodstring | nullfähigOptional

WarrantyEndstring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

WarrantyConditionsstring | nullfähigOptional

Positionstring | nullfähigOptional

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

ValidTostring · date | nullfähigOptionalExample: 2025-11-03Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ComponentStatusIdinteger · int32Erforderlich

ComponentCatalogIdinteger · int32Erforderlich

UnderComponentIdsinteger · int32[] | nullfähigOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

put

/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

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-11-03",
  "WarrantyPeriod": "text",
  "WarrantyEnd": "2025-11-03",
  "WarrantyConditions": "text",
  "Position": "text",
  "ValidFrom": "2025-11-03",
  "ValidTo": "2025-11-03",
  "ComponentStatusId": 1,
  "ComponentCatalogId": 1,
  "Offset": {
    "Id": 1,
    "Value": 1,
    "Description": "text"
  },
  "MeteringDevice": {
    "MeterSerialNumber": "text",
    "UniqueMeterIdentifier": "text",
    "EndOfGaugingTerm": "2025-11-03",
    "InstallationDate": "2025-11-03",
    "InitialValueOfMeteringDevice": 1,
    "RemovalDate": "2025-11-03",
    "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

Autorisierungen

Authorization

Pfadparameter

facilityIdinteger · int32Erforderlich

componentIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

/openwowi/v1.0/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

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

Autorisierungen

Authorization

Pfadparameter

facilityIdinteger · int32Erforderlich

componentIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

Antworten

200

OK

text/plainapplication/jsontext/json

Antwortinteger · int32

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

delete

/openwowi/v1.2/ManageFacilityAndComponents/Facility/{facilityId}/Component/{componentId}

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