SHAPTH
Use Case
wsAreaUpdate

Wasserversorgungsgebiete aktivieren und deaktivieren

Dieser Use Case beschreibt Aktivieren und Deaktivieren vorhandener Wasserversorgungsgebiete. Technisch wird dafür dieselbe Update-Mutation verwendet.

Berechtigungws_area:manage
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)
PRE

wsAreaUpdate

Für das Aktivieren wird fields.active auf true gesetzt, für das Deaktivieren auf false. Es gibt dafür keine separate GraphQL-Mutation.

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
TypWsAreaUpdateInput!
Eingabeobjekt für wsAreaUpdate.
input
id
SchemaNon-null
TypID!
ID des Wasserversorgungsgebiet-Eintrags.
fields
SchemaNon-null
TypWsAreaUpdateFieldsInput!
Zu ändernde Felder. Nicht gesetzte Felder bleiben unverändert.
input.fields
active
SchemaNullable
TypBoolean
Gibt an, ob der Registereintrag aktiv ist.
mutation WsAreaUpdate($input: WsAreaUpdateInput!) {
wsAreaUpdate(input: $input) {
  id
  active
}
}
{
"input": {
  "id": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "active": true
  }
}
}
{
"data": {
  "wsAreaUpdate": {
    "id": "DEBY/0022054530211840/1780994403118",
    "active": true
  }
}
}

On this page

wsAreaUpdate