Zum Hauptinhalt springen

Die Version einer Systemsoftware über die mStudio API verändern

Voraussetzungen​

Dieser Artikel geht davon aus, dass du bereits eine App-Installation erstellt hast und die ID dieser App-Installation kennst. Du kannst auch den GET/v2/app-installations/{appInstallationId}/-Endpunkt verwenden, um die aktuelle Konfiguration dieser App-Installation zu inspizieren. Relevant für diesen Artikel ist die .systemSoftware-Eigenschaft; diese enthält eine Map, die die ID der Systemsoftware (als Schlüssel) und die aktuell installierte Version enthält.

Die IDs der Systemsoftware und der Version bestimmen​

Zunächst musst du die IDs der Systemsoftware und der Version bestimmen, zu der du wechseln möchtest. Dies kannst du tun, indem du den GET/v2/system-softwares/-Endpunkt aufrufst und das Ergebnis nach der gewünschten .name-Eigenschaft filterst.

Mithilfe dieser ID kannst du dann den GET/v2/system-softwares/{systemSoftwareId}/versions/-Endpunkt aufrufen, um eine Liste aller verfügbaren Versionen für diese Systemsoftware zu erhalten. Um nur bestimmte Versionen auszuwählen, kannst du den versionRange-Query-Parameter verwenden. Dieser Parameter akzeptiert jede gültige semantische Versionsbedingung, wie z.B. >= 14.0.0 oder ^14.0.0.

Verändern der Systemsoftware-Version​

Um die Systemsoftware-Version zu verändern, verwende den PATCH/v2/app-installations/{appInstallationId}/-Endpunkt. Du musst nur die .systemSoftware-Eigenschaft im Request-Body angeben, die die ID der Systemsoftware und die Version enthält, zu der du wechseln möchtest:

PATCH /v2/app-installations/{appInstallationId} HTTP/1.1
Host: api.mittwald.de
Content-Type: application/json

{
  "systemSoftware": {
    "<insert system software id>": {
      "systemSoftwareVersion": "<insert system software version id>",
      "updatePolicy": "patchLevel"
    }
  }
}
See full request reference at: PATCH/v2/app-installations/{appInstallationId}/