buildagil openCDE API
- Möglichkeiten
- Authentifizierung
- Sichtbarkeiten & Berechtigungen
- Umgebung
- Rate Limits
- Deep Linking
- Nutzungsbedingungen
Möglichkeiten
Die buildagil openCDE API ermöglicht eine nahtlose Interaktion mit buildagil und bietet zahlreiche Funktionen und Werkzeuge, um den Datenaustausch und die Integration in bestehende Systeme zu erleichtern. Sie basiert auf der openCDE API Spezifikation von buildingSMART (BCF API / Documents API) und wurde um zusätzliche Endpoints, Möglichkeiten und Felder erweitert, um mehr Flexibilität und Funktionalität zu bieten.
Die buildagil openCDE API bietet u.a. folgende Möglichkeiten:
- Inhalte suchen
- Persönliche Aufgaben abrufen, erstellen und ändern
- Projektinformationen abrufen
- Aufgaben & Themen abrufen, erstellen und ändern
- Dokumente abrufen, hochladen, verschieben und ändern
- Dokumentenversionen abrufen
- Metadaten zu Dokumenten abrufen und ändern
- Sitzungen abrufen
- Meilensteine abrufen
- Benutzer abrufen
- Auf Erstellungen von Aufgaben & Themen, Dokumente, Sitzungen, Meilensteine und Benutzer reagieren
- Auf Änderungen von Aufgaben & Themen, Dokumente, Sitzungen und Meilensteine reagieren
Authentifizierung
Für die Authentifizierung an der buildagil openCDE API kontaktieren Sie bitte den Support unter Angabe eines Callback URLs, um die Client ID und den Client Secret zu erhalten. Diese Anmeldeinformationen sind notwendig, um sich an der buildagil openCDE API zu authentifizieren.
Die Authentifizierung basiert auf der Microsoft Identity Platform und erfolgt über den OAuth 2.0 Authorization Code Flow mit benutzerbasiertem Login. Jede Anmeldung ist entsprechend einem einzelnen Benutzer zugeordnet. Weitere Informationen zum Authorization Code Flow finden Sie in folgendem Artikel: Microsoft identity platform and OAuth 2.0 authorization code flow.
Sichtbarkeiten & Berechtigungen
Für das Abrufen und Ändern von Inhalten über die buildagil openCDE API gelten dieselben Sichtbarkeiten und Berechtigungen wie sonst auf buildagil. Details dazu sind unter Sichtbarkeiten & Berechtigungen zu finden.
Umgebung
Für die buildagil openCDE API steht ausschliesslich eine Produktivumgebung zur Verfügung.
Rate Limits
Die buildagil openCDE API verwendet ein benutzerbasiertes, dynamisches Rate Limiting. Bei einer hohen Nutzung kann es vorkommen, dass diese benutzerbasiert gedrosselt werden. Es wird empfohlen, umfangreiche Aktionen (wie. z.B. das Abrufen / Hochladen von grossen Datenmengen) auf Randzeiten zu legen.
Deep Linking
Um Inhalte direkt auf buildagil zu öffnen oder darauf zu verweisen, kann die Eigenschaft "link" in der jeweiligen Antwort verwendet werden.
Nutzungsbedingungen
Die API wird für die oben beschriebenen Zwecke nach dem Fair-Use-Prinzip zur Verfügung gestellt. Einzelne Funktionen, Datenstrukturen, Endpunkte sowie technische oder nutzungsbezogene Einschränkungen können im Rahmen der Weiterentwicklung angepasst oder geändert werden. Geplante und durchgeführte Änderungen werden in den Neuigkeiten & Updates veröffentlicht.
Anwenderinnen und Anwender der API sind für die sichere Aufbewahrung der Zugangsdaten und Tokens sowie für die ordnungsgemässe Verwendung der API verantwortlich. Sicherheitsmechanismen, Zugriffsbeschränkungen und Rate Limits dürfen nicht umgangen werden. Die Anwenderinnen und Anwender sind ferner dafür verantwortlich, die über die API erhaltenen Daten angemessen zu prüfen. Sie sind zudem für sämtliche über die API ausgelösten Aktionen verantwortlich, unabhängig davon, ob diese direkt, automatisiert oder durch Drittanwendungen, einschliesslich KI-Agenten, ausgelöst werden.
Im Übrigen gelten die Allgemeinen Nutzungsbedingungen für buildagil.
openCDE, OpenAPI, API, BCF API, OAuth 2.0, Authorization Code Flow, Microsoft Identity Platform, Benutzerbasierte Anmeldung, Client ID, Client Secret, Produktivumgebung, Testumgebung, API Authentifizierung
Aktualisiert am: 22/10/2026