SHAPTH
Use Case
wsObjectCreate

Objekte erstellen

Dieser Use Case beschreibt das Erstellen eines neuen Objekt-Eintrags über GraphQL.

Berechtigungws_object:manage
Endpoint
POST
/api/graphql/service

Weitere Informationen zu Basis-URLs und Umgebungen stehen im Kapitel Endpunkte.

Playground(nur GraphQL)
PRE

wsObjectCreate

Die Mutation verwendet ein ressourcenspezifisches Create-Input. Felder mit XWasser-Code müssen mit gültigen Codewerten aus den fachlichen Codelisten befüllt werden.

Request-Parameter

Die Badges zeigen die Nullbarkeit aus dem GraphQL-Schema. Non-null bedeutet, dass der Wert im jeweiligen Eingabeobjekt gesetzt sein muss. Nullable bedeutet, dass der Wert optional oder fachlich konditional ist.

FeldDetails
input
SchemaNon-null
TypWsObjectCreateInput!
Eingabeobjekt für wsObjectCreate.
input
authorityId
SchemaNon-null
TypID!
ID der zuständigen Behörde.
systemId
SchemaNon-null
TypID!
ID der zugeordneten Anlage nach TrinkwV.
handOver
SchemaNullable
TypBoolean
Steuert, ob die Pflegeverantwortung direkt übergeben werden soll.
releaseForOfficial
SchemaNullable
TypBoolean
In Klärung.
fields
SchemaNon-null
TypWsObjectCreateFieldsInput!
Fachliche Felder.
input.fields
name
SchemaNon-null
TypString!
Name des Objekts.
kind
SchemaNon-null
TypString!
XWasser-Code für die Objektart.
areaId
SchemaNullable
TypString
ID des Wasserversorgungsgebiets.
geoLatitude
SchemaNullable
TypDecimal
Geografische Breite.
geoLongitude
SchemaNullable
TypDecimal
Geografische Länge.
geoEasting
SchemaNullable
TypDecimal
Ostwert.
geoNorthing
SchemaNullable
TypDecimal
Nordwert.
frameworks
SchemaNon-null
Typ[WsObjectFrameworkInput!]!
Rahmen der Trinkwasserbereitstellung. Mögliche Werte siehe XWasser-Codeliste unten.
input.fields.frameworks
code
SchemaNon-null
TypString!
XWasser-Code für den Rahmen der Trinkwasserbereitstellung.
input.fields
opState
SchemaNon-null
TypString!
XWasser-Code für den Betriebszustand.
commissionDate
SchemaNullable
TypDateTime
Datum der Inbetriebnahme.
decommissionDate
SchemaNullable
TypDateTime
Datum der Außerbetriebnahme.
address
SchemaNon-null
TypCreateAddress!
Adresse des Eintrags.
input.fields.address
street
SchemaNon-null
TypString!
Straße.
house
SchemaNon-null
TypString!
Hausnummer.
zip
SchemaNon-null
TypString!
Postleitzahl.
place
SchemaNon-null
TypString!
Ort.
additional
SchemaNullable
TypString
Adresszusatz.
state
SchemaNon-null
TypString!
Bundesland oder Staat.
input.fields
altId
SchemaNullable
TypString
Alternative Kennung.
altIdFmt
SchemaNullable
TypString
Format der alternativen Kennung.
envId
SchemaNullable
TypString
Umweltkennung.
envIdFmt
SchemaNullable
TypString
Format der Umweltkennung.
comment
SchemaNullable
TypString
Freitextkommentar.
mutation WsObjectCreate($input: WsObjectCreateInput!) {
wsObjectCreate(input: $input) {
  r
  id
  name
  areaId
  geoLatitude
  geoLongitude
  geoEasting
  geoNorthing
  commissionDate
  decommissionDate
  address {
    street
    house
    zip
    place
    additional
    state
  }
  altId
  envId
  comment
  kind { code }
  opState { code }
  altIdFmt { code }
  envIdFmt { code }
  frameworks { code }
  active
  editable
  authority { id name ty }
  responsible { id name ty }
}
}
{
"input": {
  "authorityId": "<DUMMY-SHAPTH-ID>",
  "systemId": "<DUMMY-SHAPTH-ID>",
  "handOver": false,
  "releaseForOfficial": true,
  "fields": {
    "name": "API Testobjekt",
    "kind": "1540",
    "areaId": "<DUMMY-SHAPTH-ID>",
    "geoLatitude": 48.137154,
    "geoLongitude": 11.576124,
    "geoEasting": 1234,
    "geoNorthing": 1234,
    "frameworks": [{ "code": "1020" }],
    "opState": "1020",
    "commissionDate": "2025-01-01T00:00:00+00:00",
    "decommissionDate": "2026-01-01T00:00:00+00:00",
    "address": {
      "street": "Musterstraße",
      "house": "1",
      "zip": "80331",
      "place": "München",
      "additional": "Gebäude A",
      "state": "BY"
    },
    "altId": "<DUMMY-ALT-ID>",
    "altIdFmt": "9010",
    "envId": "<DUMMY-UMWELT_ID>",
    "envIdFmt": "1009",
    "comment": "Beispielkommentar"
  }
}
}
{
"data": {
  "wsObjectCreate": {
    "r": "R092901B140EF8706000",
    "id": "BY175OB0721",
    "name": "Objekt Beispiel",
    "areaId": "DEBY/0022054530211840/1780994403118",
    "geoLatitude": "48.137154",
    "geoLongitude": "11.576124",
    "geoEasting": "1234",
    "geoNorthing": "1234",
    "commissionDate": "2025-01-01T00:00:00+00:00",
    "decommissionDate": "2026-01-01T00:00:00+00:00",
    "address": {
      "street": "Musterstraße",
      "house": "1",
      "zip": "80331",
      "place": "München",
      "additional": "Gebäude A",
      "state": "BY"
    },
    "altId": "TO-ALT-0001",
    "envId": "ENV-0001",
    "comment": "Beispielkommentar",
    "kind": { "code": "1540" },
    "opState": { "code": "1020" },
    "altIdFmt": { "code": "9010" },
    "envIdFmt": { "code": "1009" },
    "frameworks": [{ "code": "1020" }],
    "active": true,
    "editable": true,
    "authority": {
      "id": "BY123GA801",
      "name": "Muster Gesundheitsamt",
      "ty": "HDP"
    },
    "responsible": {
      "id": "BY123GA801",
      "name": "Muster Gesundheitsamt",
      "ty": "HDP"
    }
  }
}
}

XWasser-Codes

Wenn eines dieser Felder geschrieben wird, muss ein gültiger Codewert aus der jeweiligen XWasser-Codeliste übergeben werden. Die allgemeine XWasser-Übersicht ist im XRepository unter XWasser auffindbar.

FeldCodelisteXRepositoryDatei
kindArt des ObjektsCodeliste im XRepository öffnen.Art des Objekts_3.xml
frameworks.codeRahmen der TrinkwasserbereitstellungCodeliste im XRepository öffnen.Rahmen der Trinkwasserbereitstellung_2.xml
opStateBetriebszustandCodeliste im XRepository öffnen.Betriebszustand_1.xml
altIdFmtFormat Alternative ID GesundheitCodeliste im XRepository öffnen.Format Alternative ID_Gesundheit_1.xml
envIdFmtFormat Alternative ID UmweltCodeliste im XRepository öffnen.Format Alternative ID_Umwelt_1.xml

Art des Objekts

Verwendete Version: Art des Objekts_3.xml · Hinweis: Ggf. aktuelle Codeliste im XRepository öffnen.

CodeArt des ObjektsBeschreibung
1010ApothekeApotheke
1020ArztpraxisArztpraxis
1030AutowaschanlageAutowaschanlage
1040Befüllungsanlagen von Eisenbahnverkehrsunternehmen (EVU)Befüllungsanlagen von Eisenbahnverkehrsunternehmen (EVU)
1050BürogebäudeBürogebäude
1060Campingplatz / Heim / Ferienlager o. ä.Campingplatz / Heim / Ferienlager o. ä.
1070Einrichtung für ambulantes Operieren, Dialyseeinrichtung, Entbindungseinrichtung, Tagesklinik, RehabilitationEinrichtung für ambulantes Operieren, Dialyseeinrichtung, Entbindungseinrichtung, Tagesklinik, Rehabilitation
1080Einrichtungen des Leichen- und BestattungswesensEinrichtungen des Leichen- und Bestattungswesens
1090Einrichtungen zur Entsorgung von Abwasser und AbfällenEinrichtungen zur Entsorgung von Abwasser und Abfällen
1100FabrikFabrik
1110FeuerwehrFeuerwehr
1120FlughafenFlughafen
1130Gastronomischer BetriebGastronomischer Betrieb
1140Gemeinschaftsunterkunft gem. §36 IfSGGemeinschaftsunterkunft, die unter die Verordnungsermächtigung zum Infektionsschutz bei bestimmten Einrichtungen, Unternehmen und Personen gem. §36 IfSG fallen und nicht anderweitig aufgelistet sind (Obdachlosenunterkünfte; Einrichtungen zur gemeinschaftlichen Unterbringung von Asylbewerbern, vollziehbar Ausreisepflichtigen, Flüchtlingen und Spätaussiedlern; sonstige Massenunterkünfte; Justizvollzugsanstalten).
1150Gotteshaus (Kirche, Moschee, Synagoge, …)Gotteshaus (Kirche, Moschee, Synagoge, …)
1160Hafen / BootsanlegestelleHafen / Bootsanlegestelle
1170Hochbehälter, Druckerhöhungsanlage o. ä.Hochbehälter, Druckerhöhungsanlage o. ä.
1180Hotel / Gaststätte / Jugendherberge o. ä.Hotel / Gaststätte / Jugendherberge o. ä.
1190HydrantHydrant
1200Kindertagesstätte, Kinderhort, o. ä.Kindertagesstätte, Kinderhort, o. ä.
1210Kloster/OrdenshausKloster/Ordenshaus
1220KrankenhausKrankenhaus
1230Landwirtschaftlicher Betrieb / BauernhofLandwirtschaftlicher Betrieb / Bauernhof
1240LebensmittelunternehmenLebensmittelunternehmen
1250MeeresbauwerkMeeresbauwerk
1260Mietobjekt (< 5 Wohneinheiten)Mietobjekt (< 5 Wohneinheiten)
1270Mietobjekt (>= 5 Wohneinheiten)Mietobjekt (>= 5 Wohneinheiten)
1280Militärbasis/-stützpunktMilitärbasis/-stützpunkt
1290Mobile medizinische Einrichtung (bspw. Rettungswagen/Rettungshelikopter)Mobile medizinische Einrichtung (bspw. Rettungswagen/Rettungshelikopter)
1300Mobiles Objekt (Landfahrzeug außer Zug und mobile medizinische Einrichtungen)Mobiles Objekt (Landfahrzeug außer Zug und mobile medizinische Einrichtungen)
1310Mobiles Objekt (Luftfahrzeug)Mobiles Objekt (Luftfahrzeug)
1320Mobiles Objekt (Sonstiges)Sonstiges Mobiles Objekt (Ist in der Beschreibung genau zu bezeichnen)
1330Mobiles Objekt (Wasserfahrzeug/Schiff)Mobiles Objekt (Wasserfahrzeug/Schiff)
1340Mobiles Objekt (Zug)Mobiles Objekt (Zug)
1350Museum / AusstellungMuseum / Ausstellung
1360Oberirdische Brunnenstube/Brunnenhausoberirdische Brunnenstube/Brunnenhaus
1370Objekt in öffentlicher Hand (z. B. Behörden)Objekt in öffentlicher Hand (z. B. Behörden)
1380(Öffentlicher) Trinkwasserbrunnen(Öffentlicher) Trinkwasserbrunnen
1390(Öffentliches) Verteilungsnetz(Öffentliches) Verteilungsnetz
1400Pensionen und Ferienwohnungen mit wechselndem PersonenkreisPensionen und Ferienwohnungen mit wechselndem Personenkreis
1410Pflege-/Altenheim oder -einrichtungPflege-/Altenheim oder -einrichtung
1420Privater HaushaltPrivater Haushalt
1430PumpenhausPumpenhaus
1440QuelleQuelle
1450Schule oder sonstige BildungseinrichtungSchule oder sonstige Bildungseinrichtung
1460Sport-/FreizeiteinrichtungSport-/Freizeiteinrichtung
1470Stadion / Konzerthalle / MessegeländeStadion / Konzerthalle / Messegelände
1480StudentenwohnheimStudentenwohnheim
1490TalsperreTalsperre
1500Tankstelle / (Autobahn-)RaststätteTankstelle / (Autobahn-)Raststätte
1510UniversitätUniversität
1520Unterirdische Brunnenstubeunterirdische Brunnenstube
1530Wassertransport-FahrzeugWassertransport-Fahrzeug
1540WasserwerkWasserwerk
1550Volksfeste, Märkte und ähnliche VeranstaltungenVolksfeste, Märkte und ähnliche Veranstaltungen
1560TiefbehälterTiefbehälter
1570ÜberpumpwerkÜberpumpwerk
1580ZwischenpumpwerkZwischenpumpwerk
1590TiefspiegelbrunnenTiefspiegelbrunnen
1600BerghütteBerghütte
1610SeilbahnstationSeilbahnstation
9010SonstigesSonstiges (Ist in der Beschreibung genau zu bezeichnen)

Rahmen der Trinkwasserbereitstellung

Verwendete Version: Rahmen der Trinkwasserbereitstellung_2.xml · Hinweis: Ggf. aktuelle Codeliste im XRepository öffnen.

CodeRahmen der TrinkwasserbereitstellungBeschreibung
1010Gewerbliche Tätigkeit gem. §2 Abs. 8 TrinkwVGewerbliche Tätigkeit gem. §2 Abs. 8 TrinkwV
1020Öffentliche TätigkeitÖffentliche Tätigkeit gem. §2 Abs. 9 TrinkwV
1030Gewerbliche und öffentliche TätigkeitGewerbliche und öffentliche Tätigkeit
1040Private TätigkeitPrivate Tätigkeit

Betriebszustand

Verwendete Version: Betriebszustand_1.xml · Hinweis: Ggf. aktuelle Codeliste im XRepository öffnen.

CodeBetriebszustandBeschreibung
1010Außer BetriebObjekt ist außer Betrieb / stillgelegt
1020In BetriebObjekt ist in Betrieb
1030In Planung / in EntwicklungObjekt ist in Planung / in Entwicklung und noch nicht in Betrieb
1040Zeitweilig außer Betrieb (für f-Anlagen)Objekt ist zeitweilig außer Betrieb (für f-Anlagen)
1050Zeitweilig in Betrieb (für f-Anlagen)Objekt ist zeitweilig in Betrieb (für f-Anlagen)

Format Alternative ID Gesundheit

Verwendete Version: Format Alternative ID_Gesundheit_1.xml · Hinweis: Ggf. aktuelle Codeliste im XRepository öffnen.

CodeFormat Alternative ID Gesundheit
1010TEIS/ZTEIS
1020OctoWare
1030LABDÜS
1040OKZ-Nummer/SEBAM
1050NiWaDAB
1060TWIST
9010Sonstiges

Format Alternative ID Umwelt

Verwendete Version: Format Alternative ID_Umwelt_1.xml · Hinweis: Ggf. aktuelle Codeliste im XRepository öffnen.

CodeFormat Alternative ID Umwelt
1001Schleswig-Holstein_Umwelt
1002Hamburg_Umwelt
1003Niedersachsen_Umwelt
1004Bremen_Umwelt
1005Nordrhein-Westfalen_Umwelt
1006Hessen_Umwelt
1007Rheinland-Pfalz_Umwelt
1008Baden-Württemberg_Umwelt
1009Bayern_Umwelt
1010Saarland_Umwelt
1011Berlin_Umwelt
1012Brandenburg_Umwelt
1013Mecklenburg-Vorpommern_Umwelt
1014Sachsen_Umwelt
1015Sachsen-Anhalt_Umwelt
1016Thüringen_Umwelt
1020Bundeswehr/BMVg_Umwelt
1021Eisenbahnbundesamt_Umwelt

On this page

wsObjectCreateXWasser-CodesArt des ObjektsRahmen der TrinkwasserbereitstellungBetriebszustandFormat Alternative ID GesundheitFormat Alternative ID Umwelt