SHAPTH
Use Case
waterSupplierUpdate

Betreiber bearbeiten

Dieser Use Case beschreibt das Bearbeiten von Betreiber-Stammdaten über GraphQL.

Berechtigungwater_supplier:update
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)
PRE
i
Funktionshinweis

Funktion eingeschränkt, in Klärung.

waterSupplierUpdate

Für fachliche Änderungen an Betreiber-Stammdaten wird waterSupplierUpdate verwendet. Nicht gesetzte Felder bleiben unverändert.

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
TypWaterSupplierUpdateInput!
Eingabeobjekt für waterSupplierUpdate.
input
id
SchemaNon-null
TypID!
ID des Betreiber-Eintrags.
fields
SchemaNon-null
TypWaterSupplierUpdateFieldsInput!
Zu ändernde Felder.
input.fields
info
SchemaNullable
TypWaterSupplierInfoInput
Betreiberinformation. Im Beispiel wird die company-Variante verwendet.
input.fields.info
company
SchemaNullable
TypWaterSupplierCompanyInfoInput
Unternehmensbezogene Betreiberinformation.
input.fields.info.company
name
SchemaNullable
TypString
Name des Unternehmens.
mutation WaterSupplierUpdate($input: WaterSupplierUpdateInput!) {
waterSupplierUpdate(input: $input) {
  id
  name
  info {
    __typename
    ... on WaterSupplierAuthorityInfo { name }
    ... on WaterSupplierCompanyInfo { name }
    ... on WaterSupplierPersonInfo { salutation title firstname lastname }
  }
  active
  editable
}
}
{
"input": {
  "id": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "info": {
      "company": {
        "name": "Beispiel Wasserversorger GmbH aktualisiert"
      }
    }
  }
}
}
{
"data": {
  "waterSupplierUpdate": {
    "id": "BT3022054360342528",
    "name": "Beispiel Wasserversorger GmbH aktualisiert",
    "info": {
      "__typename": "WaterSupplierCompanyInfo",
      "name": "Beispiel Wasserversorger GmbH aktualisiert"
    },
    "active": true,
    "editable": true
  }
}
}

On this page

waterSupplierUpdate