Server APIツール
Server APIツールを使用して、複雑なワークフローを記述することなく、Server API (v1、v2、v3)を操作できます。Server APIのアクセス、認証、エンドポイント、パラメーター、バージョンについては、Server APIの概要ページを参照してください。
ヒント
このツールは、Alteryx Designerでは自動的にインストールされません。このツールを使用するには、Alteryxマーケットプレイス からダウンロードします。
Server APIツールはDesignerとServerのバージョン2021.4以降に対応します。このツールの一部の機能は、Serverのバージョンにより制限される場合があります。
Alteryxマルチスレッド処理(AMP)と従来のEngineのどちらにも対応します。
Server APIツールは現在、データ接続マネージャーの[DCMのみ]モードではサポートされていません。
Server APIツールを使用するには、お使いのマシンに以下のパッケージがインストールされている必要があります。
oauthlibrequests_oauthlib
これらのパッケージがインストールされていない場合:
ワークフローキャンバスにServer APIツールを追加して、そのワークフローを実行します。ツールがエラーを生成して、不足しているパッケージがあることが警告されます。
そのワークフローの[結果]ウィンドウに移動して、[すべて]タブを選択します(または[ファイル]タブで項目のリストを絞り込みます)。
「Run this linked workflow as Admin to install missing packages.」というメッセージを見つけて選択します。これにより、必要なパッケージをインストールするように事前設定されたPythonツールで新しいワークフローが開きます。このワークフローを実行してインストールを実行します。このインストールワークフローは管理者として実行する必要があります。
上記の手順を複製して、Pythonツールでパッケージをインストールすることもできます。パッケージのインストール方法については、追加のパッケージインストールを参照してください。
Server APIツールには、6つのアンカーがあります。
入力アンカー(どちらもオプション):
A(認証)入力アンカー: ツール設定フィールドの値を使用することを選択した場合、このアンカーを使用して認証情報を指定します。APIベースURLが含まれるフィールドと、認証情報が含まれるフィールド(通常は、上流のServer APIツールのA出力の[認証]フィールド)を選択します。この認証情報は、最初の認証時にoAuth2.0で生成されたBearer接頭辞とaccess_tokenの組み合わせです。詳細については、Server APIの設定と認証を参照してください。
D(データ)入力アンカー: ツール設定フィールドの値を使用することを選択した場合、このアンカーを使用してエンドポイントのパラメーターを指定します。一部のエンドポイントには必須パラメーターがあります。
出力アンカー:
A(authToken)出力アンカー: このアンカーは認証情報を出力することで、複数の呼び出しを行う場合にすぐに利用できるようにします。この出力アンカーを別のServer APIツールのA入力アンカーに接続して、別の下流API呼び出しをシームレスに再認証します。
S(成功)出力アンカー: このアンカーは、レスポンスコード200でAPI呼び出しを出力します。1レベル下*のAPIレスポンスが解析されて、ここにそのフィールドを出力します。レスポンスを解析できない場合は、[Extracted]の出力フィールドにその理由とともにメッセージが表示され、[DownloadData]と[BinaryData]の出力フィールドに生データが提供されます。
F(失敗)出力アンカー: このアンカーは、レスポンスコード200が返されないAPI呼び出しを出力します。
L(ログ)出力アンカー: このアンカーは、API呼び出しの結果のログ情報を出力します。
以下のレスポンスは例示用に単純化されています。生のJSONの例は一般的なJSONレスポンスを示しており、その後にServer APIツールを使用した同じレスポンスの例を示します。
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
Server APIツールを使用すると同じレスポンスが以下のようにフォーマットされます。Server APIツールのレスポンスでは、バージョンの項目が1つの列/フィールドに統合されています。
ID | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
ツール設定ウィンドウを使用して、API呼び出しを実行するために必要なフィールドを設定します。
[認証]セクションを使用して、必要な認証情報を指定します。詳細についてはAPIキーとAPIアクセス、サーバーAPIの設定と認証を参照してください。
フィールドの値を使用: 既定ではオフになっています。ベースURLと認証トークン(APIアクセスキーとAPIアクセスシークレット)情報を保存する入力フィールドを指定するには、このトグルをオンにします。[ベースURLフィールドを選択]と[認証フィールドを選択]のドロップダウンで、フィールドを選択します。このオプションを選択すると、ベースURLと認証トークンとして指定された最初のレコードだけが使用されます。
認証情報は、このツールの設定ウィンドウから直接提供することもできます。上記の[フィールドの値を使用]トグルをオンにすると、これらのフィールドは非表示になります。
ベースURL: Server APIのベースURLを指定します。これは、Server UI設定で設定できます。
APIキー: APIキーを入力します。
APIシークレット: APIシークレットを入力します。
API設定セクションを使用して、メソッドを選択し、エンドポイントを選択して、API呼び出しのパラメーターを指定します。
メソッドを選択: このドロップダウンを使用してAPIメソッドを選択します。以下の中から選択します。
GET: GETメソッドは、リソースを読み取ったり表示したりできます。たとえば、usersエンドポイントでGETメソッドを使用すると、ユーザーのリストを読み取ったり表示したりできます。
POST: POSTメソッドはリソースを作成できます。たとえば、usersエンドポイントでPOSTメソッドを使用すると、新しいユーザーを作成でます。
PUT: PUTメソッドは、リソースを更新できます。具体的には、PUTメソッドは既存のリソースを置き換えます。たとえば、usersエンドポイントでPUTメソッドを使用すると、既存のユーザー詳細を指定したユーザー情報に置き換えることで更新できます。
DELETE: DELETEメソッドを使用すると、リソースを削除できます。たとえば、usersエンドポイントでDELETEメソッドを使用すると、既存のユーザーを削除できます。DELETEメソッドを選択すると、[DELETEメソッドを確定]のスイッチが表示されます。削除を正常に実行するには、このスイッチを有効にする必要があります。
エンドポイント: このドロップダウンを使用してエンドポイントを選択します。オプションは、選択したメソッドによって異なります。Server APIのエンドポイントとパラメーターの詳細については、APIエンドポイントとパラメーター、Server API V3へのアクセス、Server V3 APIオブジェクトを参照してください。
パラメーターに入力フィールドを使用*: 既定ではオフになっています。パラメーターとして使用する入力フィールドを指定するには、このトグルをオンにします。次に、使用可能なドロップダウンで、パラメーター情報が含まれるフィールドを指定します。
パラメーター値を入力*: パラメーターに入力フィールドを使用しない場合は、提供されたフィールドから直接パラメーターを入力できます。
エンドポイントパラメーター
使用可能なパラメーターはエンドポイントにより異なります。また、必須パラメーターのあるエンドポイントと、そうでないエンドポイントがあります。Server APIのエンドポイントとパラメーターの詳細については、APIエンドポイントとパラメーター、Server API V3へのアクセス、Server V3 APIオブジェクトを参照してください。
ペイロード: ペイロードを手動で入力することを選択した場合は、ここに直接JSON形式で入力できます。または、上記の[パラメーターに入力フィールドを使用]トグルを使用して、ペイロードが含まれる入力フィールドを指定します。
スキーマの例: 該当する場合、スキーマの例にはAPIペイロードの適切な構造が入力されます。[ペイロードでスキーマを使用]ボタンを選択し、汎用テキストをペイロードタブにコピーして修正できます。