Translations:Datenimport/-export Schnittstelle/37/en: Unterschied zwischen den Versionen

← Zum vorherigen Versionsunterschied Zum nächsten Versionsunterschied →

Version vom 2. April 2026, 08:10 Uhr

Information zur Nachricht (bearbeiten)

Zu dieser Nachricht ist keine Dokumentation vorhanden. Sofern du weißt, wo und in welchem Zusammenhang sie genutzt wird, kannst du anderen Übersetzern bei ihrer Arbeit helfen, indem du eine Dokumentation hinzufügst.

Nachricht im Original (Datenimport/-export Schnittstelle)

* Maßnahmen (Measures)
** PUT /api/v2/measures ersetzt PUT /api/measures
*** Einstellungen zur Wirksamkeitspüfung können nicht mehr gesetzt oder verändert werden, da dies auf interne IDs angewiesen ist
*** Der "ID" Parameter verweist jetzt auf die in HITGuard hinterlegte "ID in Drittsystem" und nicht mehr die interne ID
** PUT /api/measures/close/{id}
*** wurde als veraltet markiert, da dies eine interne ID verwendet hat → nur noch PUT /api/measures/close/byKey verwenden!
** Generell
*** Der Parameter "state" verwendet jetzt Enumerationswerte
* Kanten der Strukturanalyse (AssetEdges)
** PUT /api/v2/asset-edges ersetzt PUT /api/asset-edges
*** Die Parameter "sourceType" und "targetType" verwenden jetzt Enumerationswerte
* Ressourcen (Resources)
** alle Endpunkte wurden in "v1" als veraltet markiert
*** Der Parameter "modelSegment" verwendet jetzt Enumerationswerte
* Risiken (Risks)
** GET /api/v2/risks ersetzt GET /api/risks/{managementSystemId}
*** Der Pfad-Parameter "managementSystemId" wurde entfernt. Stattdessen können jetzt die optionalen Query-Parameter "managementSystemId" und "includePublicRisks" verwendet werden um Risiken abzufragen und zu filtern.
** GET /api/v2/risks/{id} ersetzt GET /api/risks/byKey/{id}
*** Endpunkt wurde angepasst um konsistent zu den anderen Endpunkten zu sein.
** PUT /api/v2/risks ersetzt PUT /api/risks
*** Das Datenmodell wurde angepasst. Die "managementSystemId" wird nicht mehr auf oberer Ebene vergeben sondern je Risiko. Das Modell ist jetzt "RiskCreateOrUpdateDtoV2" und nicht mehr "HazardSituationImportDto"
*** Es kann jetzt auch der Status des Risiko über die API aktualisiert werden. Erlaubte werte sind: Active, Inactive, Accepted, Rejected
*** Es kann jetzt auch die Strategie des Risiko über die API aktualisiert werden. Erlaubte werte sind abhängig davon ob es ein Schadensausmaß oder ein Nutzen zugewiesen ist (also ob es sich um ein Risiko oder eine Chance handelt). Ist es ein Schadensausmaß sind die erlaubte Werte: Undefined, Avoidance, Reduction, Transfer, Acceptance. Ist es ein Nutzen sind sind die erlaubte Werte: Undefined, Enhance, Share, Exploit, Ignore.
*** Es ist nun möglich die Anmerkungen zum Risiko zu ändern
*** Es ist nun möglich den Sachbearbeiter zu ändern
** POST /api/v2/risks/submit neuer Endpunkt zum importieren von Risiken im Status "Eingereicht"
** DELETE /api/v2/risks/{id} ersetzt DELETE /api/risks/{id}
** alle Endpunkte wurden in "v1" als veraltet markiert
** GET Endpunkte returnieren mehr Informationen zum Risiko wie Anmerkungen, Strategie und Sachbearbeiter

Measures
- PUT /api/v2/measures replaces PUT /api/measures
  - Configurations regarding the necessity test can no longer be set or changed, as those use internal IDs
  - The parameter "ID" now refers to the HITGuard field "External ID" and no longer the internal ID
- PUT /api/measures/close/{id}
  - was marked as deprecated as it used an internal ID → only use PUT /api/measures/close/byKey going forward!
- General
  - The parameter "state" now uses enumeration values
Asset edges
- PUT /api/v2/asset-edges replaces PUT /api/asset-edges
  - The parameters "sourceType" and "targetType" now use enumeration values
Resources
- all endpoints in "v1" were marked as deprecated
  - The parameter "modelSegment" now uses enumeration values
Risks
- GET /api/v2/risks replaces GET /api/risks/{managementSystemId}
  - The path parameter "managementSystemId" was removed. Instead you can now use the optional query parameters "managementSystemId" and "includePublicRisks" to retrieve and filter risks.
- GET /api/v2/risks/{id} replaces GET /api/risks/byKey/{id}
  - Endpoints were adjusted to be consistent with the other endpoints.
- PUT /api/v2/risks replaces PUT /api/risks
  - The data-model was adjusted. The "managementSystemId" is not set at top level but per risk. The model is now "RiskCreateOrUpdateDtoV2" not "HazardSituationImportDto"
  - It is now possible to modify the state of a risk via the api. Valid values are: Active, Inactive, Accepted, Rejected
  - It is now possible to modify the strategy of a risk via the api. The permitted values depend on whether a severity or an benefit has been assigned (i.e. whether it is a risk or an opportunity). If it is a severity, the permitted values are: Undefined, Avoidance, Reduction, Transfer, Acceptance. If it is a benefit, the permitted values are: Undefined, Enhance, Share, Exploit, Ignore.
  - It is now possible to edit the risk remarks
  - It is now possible to change the advisor of the risk
- POST /api/v2/risks/submit new endpoint for importing risks in state "Submitted"
- DELETE /api/v2/risks/{id} replaces DELETE /api/risks/{id}
- all endpoints in "v1" were marked as deprecated
- GET endpoints return mor information about the risk such as remarks, strategy and advisors.

@@ Zeile 21: / Zeile 21: @@
 *** The data-model was adjusted. The "managementSystemId" is not set at top level but per risk. The model is now "RiskCreateOrUpdateDtoV2" not "HazardSituationImportDto"
 *** It is now possible to modify the state of a risk via the api. Valid values are: Active, Inactive, Accepted, Rejected
+*** It is now possible to modify the strategy of a risk via the api. The permitted values depend on whether a severity or an benefit has been assigned (i.e. whether it is a risk or an opportunity). If it is a severity, the permitted values are: Undefined, Avoidance, Reduction, Transfer, Acceptance. If it is a benefit, the permitted values are: Undefined, Enhance, Share, Exploit, Ignore.
+*** It is now possible to edit the risk remarks
+*** It is now possible to change the advisor of the risk
 ** POST /api/v2/risks/submit new endpoint for importing risks in state "Submitted"
 ** DELETE /api/v2/risks/{id} replaces DELETE /api/risks/{id}
 ** all endpoints in "v1" were marked as deprecated
+** GET endpoints return mor information about the risk such as remarks, strategy and advisors.