Die Minitab Connect OData-API

Basis-URL

Die Basis-URL ist unabhängig von der spezifischen API-Anforderung, die Sie stellen, identisch. Um zu bestimmen, wie die Basis-URL lauten soll, kopieren Sie die URL, mit der Sie sich bei Minitab Connect anmelden, und fügen Sie /api/odata_v4/hinzu. Wenn Sie z. B. https://connect.minitab.com für den Zugriff auf Minitab Connect verwenden, lautet die Basis-URL für alle Ihre OData-API-Anforderungen: https://connect.minitab.com/api/odata_v4/.

Authentifizierungsmethoden

Informiert das System, dass die Anforderung mit den gleichen Berechtigungen wie der angegebene Benutzer verarbeitet werden soll. Die Authentifizierung wird durch einen API-Schlüssel dargestellt. Ein API-Schlüssel ist eine eindeutige Zeichenfolge, die den Zugriff auf eine Funktion im Tool ermöglicht. Um einen API-Schlüssel zu erstellen, öffnen Sie Benutzer das Menü oben rechts und wählen Sie Kontoeinstellungenaus. Weitere Informationen finden Sie unter Generieren eines API-Tokens.

Es gibt drei verschiedene Authentifizierungsmethoden.

API-Schlüssel für Abfragezeichenfolge

Ein GET- oder POST-Parameter mit dem Namen "apikey", der ein Token enthält, das auf der Seite "Kontoeinstellungen verbinden" generiert wird. Beispiel: https://connect.minitab.com/api/odata_v4/?apikey=[apikey],bei dem Sie 'apikey' durch den tatsächlichen API-Schlüssel ersetzen.

Header-API-Schlüssel

Ein HTTP-Header mit dem Namen "X-Api-Key", der ein Token enthält, das auf der Seite "Kontoeinstellungen verbinden" generiert wird.

Grundlegende Webauthentifizierung

Ihr Benutzername ist Ihr Connect-Benutzername oder Ihre E-Mail-Adresse. Das Kennwort ist ein Token, das auf der Seite "Kontoeinstellungen verbinden" generiert wird.

Endpunkte

Basisendpunkt – https://connect.minitab.com/api/odata_v4/

Gibt eine Liste von Entitätsmengen zurück, bei denen es sich um die Tabellen und Sichten handelt, auf die der Benutzer Zugriff hat.

Hinweis

Verbinden entfernt alle Zeichen, die nicht A-Z, a-z, 0-9, acc-(Bindestrich) und _(Unterstrich) sind, von Entitäten (Datensätzen), Entitätsmengen (Tabellen und Ansichten) und Eigenschaften. Connect fügt "_t" für Tabellen und "_v" für Ansichten sowie eine ID an Entitäts- und Einheitensatznamen an, um einen eindeutigen Namen zu gewährleisten. Beispiele:

• TableName_t38
• ViewName_v2

Metadaten-Endpunkt - https://connect.minitab.com/api/odata_v4/$metadata

Gibt die XML-Datendefinition aller Entitäten, Entitätsmengen und Eigenschaften zurück.

Endpunkt "Entitätssatz " – https://connect.minitab.com/api/odata_v4/[EntitySet]

Gibt Datensätze aus der Entitätsmenge (Tabelle oder Sicht) zurück. Standardmäßig stimmt die Reihenfolge mit der Reihenfolge in Basis oder der Reihenfolge in der Ansicht überein. Ersetzen Sie 'EntitySet' durch den entsprechenden Namen der Minitab Connect-Tabelle oder -Ansicht. Sie können die Namen aller Tabellen und Sichten vom Basisendpunkt zurückgeben.

Der Endpunkt der Entitätsmenge unterstützt derzeit nur drei Funktionen:

$count - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$count

Gibt die Anzahl der Datensätze zurück

$top - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$top=[Anzahl]

Gibt 'number'-Datensätze aus der Entitätsmenge zurück. Sowohl der Standardwert als auch der Höchstwert sind 5.000 Datensätze. Sie können mit $skip kombinieren, um durch alle Datensätze zu blättern.

$skip - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$skip=[Anzahl]

Überspringt 'Nummern'-Datensätze. Sie können mit $top kombinieren, um durch alle Datensätze zu blättern.

Hinweis

Der Entitätsmengenendpunkt unterstützt derzeit nicht die Funktionen $filter, $select, $orderby oder $expand. Sie können den gleichen Effekt von $filter, $select und $orderby erzielen, indem Sie das Vorbereiten Werkzeug in Minitab Connect einer gespeicherten Ansicht Ihrer Tabelle verwenden und erstellen.

Endpunkt der Entität - https://connect.minitab.com/api/odata_v4/[EntitySet]([sys_id])/

Gibt eine Entität (einen Datensatz) zurück, die durch 'sys_id' identifiziert wird, aus dem angegebenen 'EntitySet'.