Custom API Action(カスタムAPIアクション)
Tableau Cloud APIに対して認証リクエストを送信します。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request Type(リクエストタイプ) |
カスタムAPI呼び出しでサポートされるHTTPリクエストメソッド、つまりHTTP動詞は次のとおりです(「HTTPリクエストメソッド」を参照)。
|
ドロップダウン |
TRUE |
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request(リクエスト) |
|||
Relative URL(相対URL) |
呼び出すWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。 「?」を使用して相対URL内にクエリパラメーターを指定したり、[Query(クエリ)]入力内のキーと値のペアとしてクエリパラメーターを指定したりすることができます。 たとえば、リクエストURLがhttps://10ax.online.tableau.com/api/api-version/sites/site-id/groupsの場合、相対URLは/groupsとなります。site-idは、認可された接続に関連付けられているため必要ありません。 「Tableau APIリファレンス」を参照してください。 |
テキスト |
TRUE |
API Version(APIバージョン) |
このフィールドが指定されていない場合、クエリはデフォルトのAPIバージョンに3.22を使用します。 「REST APIとリソースのバージョン」を参照してください。 |
テキスト |
FALSE |
Scopes(スコープ) |
Tableau APIのJWT認証に必要なスコープ。 このJWT認証は、接続されたアプリで使用可能なREST APIメソッドのスコープで構成する必要があります。 「アクセススコープ」を参照してください。 |
テキストのリスト |
TRUE |
Query(クエリ) |
キー/値のペアとして含める必要がある追加のクエリパラメーターを指定します。 例:{"name":"something-urgent"}。 |
オブジェクト |
FALSE |
Headers(ヘッダー) |
承認またはコンテンツタイプ(これらのヘッダーにはすでにコネクターが対応しています)以外に必要な任意のヘッダーを指定します。 |
オブジェクト |
FALSE |
Body(本文) |
リクエストボディーをJSON形式で指定します。 この入力は、POST、PUT、PATCHリクエストでのみ使用できます。 |
オブジェクト |
FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) |
||
Status Code(ステータスコード) |
操作の結果。コネクターは、カードによって実行されたアクションの成否を示すHTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
Headers(ヘッダー) |
出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは、選択したHTTPリクエストオプションによって決定します。すべてのヘッダーがレスポンスヘッダーというわけではありません。これは、{"Content-type":"application/json"}のようになります。 |
オブジェクト |
Body(本文) |
選択したHTTPリクエストから返されたデータ。 たとえば、GETリクエストからのデータ。 |
オブジェクト |
関連項目
Tableau Cloudコネクター
フロー内のカード