The Minitab Connect API

Minitab Connect バージョン3のAPIにより、外部からの接続がこれまで以上に容易になりました。API呼び出しの作成に簡略化され、よりシンプルなアプローチにより、 Minitab Connect はすべてのスキルレベルに利用可能になります。

APIリクエストの概要

各エンドポイントには、共有された値もユニークな値を含む特定の属性リストがあり、APIバージョン3の検索要求で検索できます。エンドポイントの属性リストを受け取るには、簡単なAPIバージョン3リクエストを書きます。APIバージョン3のエンドポイント属性要求には、基本情報の3つ、すなわちベースURL、エンドポイント、APIキーのみが必要です。

注

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

ベースURL

ベースURLは、特定のAPIリクエストに関わらず同じです。基本URLを決めるには、 Minitab ConnectにログインするURLをコピーするだけです。例えば、 https://connect.minitab.com を使って Minitab Connectにアクセスする場合、すべてのAPIリクエストのベースURLは「 https://connect.minitab.com/api/3/」となります。

終着点

リクエストがやり取りしようとするオブジェクトまたはオブジェクトの集合を表します。上記の例では、「Example API Request」のエンドポイントは「Source」です。これにより、APIリクエストの処理は「ソース」データオブジェクトを操作するために特別に設計されたアクションに限定されます。

例えば 、httpsの端点: connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{"name":"Campaigns"}] は「ソース」です。これにより、APIリクエストの処理は「ソース」データオブジェクトを操作するために特別に設計されたアクションに限定されます。

エンドポイントGUID

エンドポイントGUIDは、 Minitab Connect内の特定のデータオブジェクトを表す一意の識別子です。GUIDは一意の文字列で構成されており、時に「キー」と呼ばれることもあります。 Minitab ConnectでGUIDを見つけるには、目的のオブジェクトの編集モーダルを開きます。エンドポイントのGUIDはすべてのAPIリクエストに必須ではありません。例えば、検索アクションを実行するAPIリクエストはエンドポイントGUIDを省略します。

APIキー

このAPIリクエストの部分は、指定されたユーザーと同じ権限でリクエストを処理するべきだとシステムに通知します。これは常にGUIDで表現されます。APIキーは、 Minitab Connectの特定のユーザーに関連付けられた一意の文字列です。GUIDを見つけるには、まずシステムにログインしてください。次に、ユーザーボタンを開いてください

右上にいてアカウント設定を選択します。利用可能なAPIキーのリストが掲載されており、新しいキーを生成する機能も含まれています。(この例では、セキュリティ目的でダミーAPIキーを使用します)

認証

指定されたユーザーと同じ権限でリクエストを処理するようシステムに通知します。認証はAPIキーで表現されます。APIキーとは、ツール内の機能にアクセスするために作成された一意の文字列です。APIキーを作成するには、ユーザーボタンを開きます

右上にいてアカウント設定を選択します。詳細については、APIトークンを生成するを参照してください。

操作

指定されたエンドポイントに対して取るべきアクションを指定します。アクションは通常、以下のように分類されます。

ゲッター: ゲッターアクションはシステムからデータを抽出するために用いられます。各エンドポイントには固有のゲッターセットがあります。ゲッターを使うには、正しい形式は action= で、を目的のゲッター名に置き換えます。
セッター: セッターアクションは、システムへのデータインポートやデータオブジェクトのプロパティの設定・変更に使用されます。各端点には固有のセッターが存在します。セッターを使う場合、正しいフォーマットは action=&arg= で、は希望するセッターの名前に置き換えられ、は設定すべき値です。
行動: アクションは、ゲッターの特徴を満たさないデータオブジェクトのプロセス、特徴、コマンドに対して使われます。アクションの一例として、テーブルにフィールドを追加することがあります。各行動には異なる条件があります。例えば、いくつかのアクションは引数を必要としず、ゲッターと同じ形式で書かれています。他のアクションでは、引数をセッターのようにフォーマットする必要があります。
検索: 検索は、特定のパラメータセットを満たすエンドポイントからデータを取得するために用いられます。検索は無限に多くの検索語を持ち、配列形式でフォーマットされます。例えば: action=search&args=[{"fname":"John","lname":"Smith"}] は、[ "fname" (ファーストネーム)が "John" であり、「 lname' (姓)が "Smith"であるレコードのみを返します。キーワードは、キー:値構造に合い、コンマで区切られている限り、いくつでも使えます。
注
API検索リクエストに値を追加する際、テキスト文字列は引用符の内側に置く必要があります。

複数のアクションを含むAPIリクエストを出すことができます。そのためには、各行動をアンパサンド('&')で区切る。例えば、IDが15のユーザーの名前、ミドルネーム、姓を変更する必要があります。リクエストは以下の通りです:

https://connect.minitab.com/api/3/User/15?apikey=45a3d34982e&action0=setFName&arg0=John&action1=setMName&arg1=D&action2=setLName&arg2=Smith

このリクエストは、IDが 15のユーザー名を「 John」、ミドルネームを 「D」 、ラストネームを 「Smith」 に設定します。

注

単一のAPIリクエストで複数のアクションを使用する場合、アクションはインクリメントしなければなりません。最初の行動と引数には0または1を付け加えることができます。追加のアクショングループは1倍ずつ増加しなければなりません。

エンドポイントのすべてのアクションを返すAPIリクエスト

いつでもAPIリクエストを送ることができ、特定のエンドポイントで利用可能なすべてのアクションのリストを返すことができます。要請は以下の通りです:

https://connect.minitab.com/api/3/[endpoint]/?apikey=[apikey]

エンドポイント を特定のエンドポイントに置き換え、 apikey を実際のAPIキーに置き換えます。エンドポイントのすべてのアクションとすべての属性を含むJSONオブジェクトが返されます。

現在の終点と特徴

いつでもAPIリクエストを出し、すべてのエンドポイントのリストを返すことができます。要請は以下の通りです:

https://connect.minitab.com/api/3/?apikey=[apikey]

apikey を実際のAPIキーに置き換えてください。利用可能なすべてのエンドポイントのリストを含むJSONオブジェクトが返されます。現時点で利用可能なエンドポイントは以下の通りです:

AutoImportConf: 自動インポート設定( Minitab Connect内の自動インポートウィザードとして定義)を作成、読み取り、操作します。
ブロブ: Minitab Connect内の「ファイル」フィールド形式として保存・取得するファイル。
ビジネスルール: ビジネスルールを作成、閲覧、操作しましょう。
ビジネスルールグループ: ビジネスルールグループを作成、閲覧、操作できます。
ビジネスルールトリガー: APIリクエストで新しいビジネスルールトリガーを作成したり、既存のビジネスルールトリガーを読み取ったり、編集・削除したり実行したりできます。
接続: APIリクエストが新しい接続を作成したり、既存の接続を読み取ったり、変更したり削除したりできます。
顧客: APIリクエストで新規顧客を作成したり、既存顧客を読み取ったり、削除したりできます。
ダッシュボード: APIリクエストで新しいダッシュボードを作成したり、既存のダッシュボードを読み取ったり、修正したり削除したりできます。
DashboardElement: APIリクエストで新しいダッシュボード要素を作成することができます。また、既存のダッシュボード要素の読み取り、変更、削除も可能です。
エラーログ: エラーログを読んでください。
フィールドフォーマット: APIリクエストがシステム定義のフィールドフォーマットとやり取りできるようにします。例えば、テキストフィールドはURL形式で設定できます。
フィールドタイプ: APIリクエストで新しいカスタムフィールドを作成したり、既存のカスタムフィールドを読み取ったり、変更したり削除したりできます。
フィールドタイプトリガー: APIリクエストが新しいフィールドタイプトリガーを作成したり、既存のフィールドタイプトリガーを読み取ったり、修正したり削除したり実行したりできるようにします。
FileImporterLocations: 新しいファイルを作成したり、ファイルインポートスケジューラが使う場所を読み取ったり操作したりします。
フロー: フローとのインタラクションを可能にします。フローの作成、修正、削除が可能です。バージョン3のAPIを使ってフローデータを取得し、手動で実行できます。
形式: 新しいフォームを作成したり、既存のフォームを修正または削除したりできます。APIを通じてフォームデータを取得することができます。
フォームエレメント: APIリクエストで新しいフォーム要素を作成できます。また、既存のフォーム要素の読み取り、変更、削除も許可しています。
ジョブ: 新しい雇用を創出しましょう。
KVSトーレ: キーバリュー保存のために。エンドポイントはキーと値のペアの作成、変更、読み取り、削除を可能にします。
マッシュアップ: 内部システム使用のために。
パフォーマンスログ: パフォーマンスログを読んでください。
プラグイン: APIリクエストで既存のプラグインを修正したり、プラグインデータを読み取ったり(利用可能なプラグインのリストも含む)ことができます。
プロフィールログ: プロファイラーの歴史を読んでみてください。
SavedAPI: コントロールはエクスポートを保存します。
要因: ソース(表)とやり取りしましょう。新しいテーブルを作成できます。既存のテーブルは編集、読み取り、削除が可能です。
ソースチャート: チャートの作成、閲覧、修正、削除。
ソース条件付き: テーブルの条件付き書式を作成、修正、削除してください。
出典接続: テーブルに紐づくソース接続を読み取ったり、修正したりします。
SourceExportOption: 保存されているエクスポートコネクタ設定を作成、読み取り、操作してください。
SourceField(ソースフィールド): テーブルフィールドの作成、変更、削除。
Sourceインターフェース: テーブルデータとやり取りしましょう。データの行を挿入、更新、削除、エクスポート、読み込み。
SourceJoin: ジョインを使って作業しましょう。これは、マッシュアップテーブルを作成・編集する際の「Add join」ダイアログに対応しています。そこで作成された各アイテムは、それぞれ固有のIDを持つ単一の「ジョイン」があります。
出典注記: テーブルノートを作成、閲覧、修正、削除できます。
出典プロフィール: プロファイラーが作成したプロフィールを作成、閲覧、または操作してください。
SourceStatsLog: 表の歴史的統計(サイズ、記録など)を読みましょう。
ソーステンプレート: テーブルテンプレートを作成、閲覧、または修正できます。
ソースタイプ: フォルダとやり取りしましょう。新しいフォルダを作成できます。既存のフォルダは編集、読み取り、削除が可能です。
ソースビュー: ビューと交流しましょう。新しいビューを作成することも可能です。既存のビューは変更、読み取り、削除が可能です。
統計: 顧客統計を作成、閲覧、編集、削除できます。
テーマ: テーマを作成、読む、修正、削除。(フォーム、ダッシュボード、UI)。
ツリーインフォ: ツリーインポーターが内部で使っています。システム使用のみ。
ユーザー: ユーザーと交流しましょう。APIリクエストでユーザーの作成、読み取り、変更、削除が可能です。
ユーザータイプ: システムガバナンスのためにユーザーグループを作成、読み取り、修正、削除できます。
バージョンコントロール: テーブルのHBaseバージョン管理設定を作成または修正。このエンドポイントには、HBaseへのデータプッシュやデータ取得の手法も含まれています。
ワークスペース: コレクション(以前はワークスペースと呼ばれていました)とやり取りしましょう。APIリクエストでコレクションの作成、読み取り、変更、削除が可能です。
WorkspaceElement: コレクション内で、テーブル、フォーム、ダッシュボードなどの要素を作成、読み取り、修正、削除できます。