Innerhalb des Build-Moduls stehen zwei REST-APIs zur Verfügung:
- Build Management Service
- Build Validation Service
Build Validierungsdienst (REST)
Im Validierungsdienst können Sie Validierungsregeln konfigurieren, um den Inhalt während eines Imports zu prüfen. Diese Validierungsregeln können auf eine oder mehrere Importvorlagen angewendet werden, wodurch Sie die volle Kontrolle darüber erhalten, welche Validierung auf welchen Import angewendet werden soll. Dies ist in der Regel dem Netzbetreiber vorbehalten, da dieser der Eigentümer und Entscheidungsträger des Netzwerks ist.
Die Swagger API-Dokumentation ist verfügbar unter https://validation.build.gridsz.com/swagger/
Build Management Dienst (REST)
Über den Management Dienst können Sie Aktualisierungen für spezifische Entitäten innerhalb des Build-Moduls bereitstellen. Dies umfasst beispielsweise Aktualisierungen für ein kommerzielles Gebiet oder einen PoP. Zusätzlich können Sie alle relevanten Informationen der Entitäten für Ihre eigenen Datenanforderungen abrufen.
BUILD-Benutzer haben die Möglichkeit, Gebäude mithilfe der Build Management APIs zu verwalten, einschließlich:
- Ein bestehendes Gebäude mithilfe der Gebäude-ID abrufen
- Mehrere Gebäude abrufen
- mithilfe externer Gebäude-IDs (üblicherweise pand_id)
- durch Angabe von Adress-IDs
- Alle Adressen eines Gebäudes mithilfe der Gebäude-ID abrufen
- Ein neues Gebäude erstellen
- Ein bestehendes Gebäude anhand der Gebäude-ID aktualisieren
- Adressen eines bestehenden Gebäudes anhand der Gebäude-ID aktualisieren
- Ein bestehendes Gebäude löschen nach
- Gebäude-ID
- Externe Gebäude-ID
Die Swagger API-Dokumentation ist verfügbar unter https://management.build.gridsz.com/swagger/
Alle Anforderungs- und Antwortbeispiele der API finden Sie in den Spezifikationen. Betrachten Sie beispielsweise die API zum Erstellen eines neuen Gebäudes. Das Anforderungsbeispiel ist unten zugänglich, gefolgt vom Antwortbeispiel.
