The Minitab Connect OData API

Open Data Protocol(OData)は、RESTful APIの構築と利用に関するベストプラクティスのセットを定義しています。Minitab Connect OData バージョン4のAPIにより、外部からの接続がこれまで以上に容易になりました。現在、データは読み取り専用です。このAPIを通じてデータの更新はできません。

1人のユーザーはAPIリクエストを1秒間に20回、1分間に1,000回以上行うことはできません。Connectのサブスクリプションに加入しているすべてのユーザーは、1秒あたり200件、1分間あたり10,000件を超えるリクエストを行ってはなりません。

ベースURL

基本的なURLは、どのAPIリクエストを出しても同じです。基本URLを決めるには、Minitab ConnectにログインするURLをコピーし、 /api/odata_v4/を追加してください。例えば、https://connect.minitab.com を使ってMinitab Connectにアクセスする場合、すべてのOData APIリクエストのベースURLは https://connect.minitab.com/api/odata_v4/です。

認証方法

指定されたユーザーと同じ権限でリクエストを処理するようシステムに通知します。認証はAPIキーで表現されます。APIキーは、ツールの機能にアクセスするための一意の文字列です。APIキーを作成するには、右上のメニュー ユーザー 開いて「 アカウント設定」を選択してください。詳細については、APIトークンを生成する を参照してください。

認証方法は3種類あります。

クエリ文字列APIキー
「apikey」という名前のGETまたはPOSTパラメータで、Connect Account Settings ページで生成されるトークンを含んでいます。例えば、 https://connect.minitab.com/api/odata_v4/?apikey=[apikey]では、「apikey」を実際のAPIキーに置き換えます。
ヘッダーAPIキー
Connect Account Settings ページで生成されるトークンを含む「X-Api-Key」というHTTPヘッダーです。
基本的なウェブ認証
あなたのユーザー名はConnectのユーザー名またはメールアドレスです。パスワードはConnect Account Settingsページで生成されるトークンです。

エンドポイント

ベースエンドポイント - https://connect.minitab.com/api/odata_v4/
ユーザーがアクセスできるテーブルやビューを含むエンティティセットのリストを返します。

エンティティ(レコード)、エンティティセット(テーブルやビュー)、プロパティから、A-Z、a-z、0-9、acc-(ハイフン)、_(アンダースコア)以外のすべての文字をリモートで接続します。Connectはテーブルには「_t」、ビューには「_v」を付け加え、エンティティ名やエンティティセット名にはIDを付けて一意名を保証します。たとえば次のようになります。

  • TableName_t38
  • ViewName_v2

メタデータエンドポイント - https://connect.minitab.com/api/odata_v4/$metadata
すべてのエンティティ、エンティティセット、プロパティのXMLデータ定義を返します。
Entity Set endpoint - https://connect.minitab.com/api/odata_v4/[EntitySet]
エンティティセット(テーブルまたはビュー)からのレコードを返します。デフォルトでは、順序はBaseやViewの順序と一致します。「EntitySet」を対応するMinitab Connectテーブルまたはビュー名に置き換えます。Base Endpointからすべてのテーブル名やビュー名を返すことができます。
エンティティセットエンドポイントは現在、3つの関数のみをサポートしています:
$count - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$count
レコード数を返します
$top - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$top=[番号]
エンティティセットから「番号」レコードを返します。デフォルトと最大の両方が5,000レコードです。$skipと組み合わせて、すべての記録をページングできます。
$skip - https://connect.minitab.com/api/odata_v4/[EntitySet]/?$skip=[number]
「番号」レコードを飛ばします。$topと組み合わせて、すべての記録をページングできます。

エンティティセットエンドポイントは現在、$filter、$select、$orderby、$expand機能をサポートしていません。$filter、$select、$orderbyの効果を 準備 ツールで作成できます。 Minitab Connect でテーブルの保存ビューを作成してください。

エンティティエンドポイント - https://connect.minitab.com/api/odata_v4/[EntitySet]([sys_id])/

指定された「EntitySet」からエンティティ(1つのレコード)を返します。「sys_id」で識別されます。