SHAPTH
Use Case
wsObjectUpdate

Objekte aktivieren und deaktivieren

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

Berechtigungws_object:manage
Endpoint
POST
/api/graphql/service

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

Playground(nur GraphQL)

wsObjectUpdate

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
TypWsObjectUpdateInput!
Eingabeobjekt für wsObjectUpdate.
input
id
SchemaNon-null
TypID!
ID des Objekt-Eintrags.
fields
SchemaNon-null
TypWsObjectUpdateFieldsInput!
Zu ändernde Felder. Nicht gesetzte Felder bleiben unverändert.
input.fields
active
SchemaNullable
TypBoolean
Gibt an, ob der Registereintrag aktiv ist.
mutation WsObjectUpdate($input: WsObjectUpdateInput!) {
wsObjectUpdate(input: $input) {
  id
  active
}
}
{
"input": {
  "id": "<DUMMY-SHAPTH-ID>",
  "fields": {
    "active": true
  }
}
}
{
"data": {
  "wsObjectUpdate": {
    "id": "BY175OB0721",
    "active": true
  }
}
}

On this page