Für Entwicklung und Unternehmens-IT
Die Schnittstelle – was sie kann, wie man sie anspricht.
TAOM stellt Prozesse, Angaben und Funktionen über eine Schnittstelle bereit. Diese Seite beschreibt, wofür sie gedacht ist und wie ein Zugang aussieht. Sie ersetzt keine vollständige Referenz – die bekommen Kunden mit ihrem Zugang.
Grundlagen
Vier Dinge vorab
Versioniert
Die Schnittstelle liegt unter einem versionierten Namensraum. Eine neue Fassung ersetzt die alte nicht stillschweigend; bestehende Anbindungen laufen weiter.
Benannte Zugänge
Je anbindender Anwendung ein eigener Zugang mit Umfang, Mandant und Ablaufdatum. Einzeln sperrbar, Benutzung wird vermerkt.
Umfang statt Vollzugriff
Nur lesen, lesen und schreiben, oder voller Zugriff. Löschen verlangt die höchste Stufe. Der Umfang wird bei jedem Aufruf geprüft.
Mandantengebunden
Trägt ein Zugang einen Mandanten, erreicht er nur dessen Arbeitsbereiche – unabhängig davon, welche Kennung mitgeschickt wird.
Anmeldung
Ein Kopfzeilenfeld, mehr braucht es nicht
GET https://ihre-umgebung/wp-json/taom/v1/… Authorization: Bearer <Ihr Zugangsschlüssel>
Der Schlüssel wird beim Anlegen des Zugangs einmal angezeigt und danach nur als Prüfsumme aufbewahrt. Er gehört auf den Server, nie in eine Anwendung im Browser.
Bereiche
Was sich ansprechen lässt
Arbeitsbereiche und Modelle
Anlegen, lesen, ändern, Fassungen abrufen. Dazu Phasen, Metadaten, Gruppen mehrerer Diagramme und das Herkunftssiegel – jede erzeugte Modelldatei trägt es, und es lässt sich ohne Zugang zu TAOM prüfen.
Anreicherung
Einen Lauf starten, den Stand abfragen, das Ergebnis holen – für ein einzelnes Element oder das ganze Modell.
Ereignisse aus Jira und Confluence
Statusänderungen in Jira und geänderte Textabschnitte in Confluence melden sich über die eigene Atlassian-App am Modell zurück. Welche Angabe dabei welche Seite führt, ist je Feld festgelegt. Hinweg, Rückweg und Feldhoheit →
Anhänge
Dokumente hochladen, auflisten, abrufen, entfernen – gebunden an das Element, zu dem sie gehören.
Agenten
Verzeichnis, Stilprofil, Bibliothek sowie Anfrage und Ergebnis eines Laufs.
Benutzer und Lizenz
Anmeldung, Konto, Lizenzstand – Grundlage dafür, dass eine fremde Anwendung im Namen eines berechtigten Benutzers handelt.
Anwesenheit
Wer gerade an einem Modell arbeitet. Damit lässt sich gemeinsames Arbeiten auch ausserhalb der Oberfläche abbilden.
Zwei Muster
Wie eine Anbindung üblicherweise aussieht
Abholen
Die fremde Anwendung fragt an, TAOM antwortet. Geeignet für Auswertungen, Übersichten und alles, was den Stand lesen will.
Auftrag und Rückruf
Ein Lauf wird angestossen, TAOM antwortet sofort mit einer Bestätigung und meldet das Ergebnis später an eine hinterlegte Adresse. Nötig, weil ein Agentenlauf länger dauert als eine Anfrage warten darf.
Seit Kurzem möglich
Über alle Arbeitsbereiche fragen
Die Abfrage über den gesamten Bestand läuft: nach Merkmalen, mit Freitext oder über dreizehn vorgefertigte Fragen – etwa „prüfpflichtig, aber ohne Testfall». Die Antwort nennt Modell, Phase und Rolle je Treffer.
Noch nicht vorhanden
Was wir ehrlicherweise dazusagen
Vorschläge beim Modellieren
Die Bibliothek aus dem Learning Model steht. Sie beim Tippen als Vorschlag anzubieten, ist erst an einer Stelle umgesetzt.
Aufrufgrenzen
Obergrenzen je Zugang sind vorgesehen, aber noch nicht gesetzt.