カスタムAPIアクション

Advanced Server Access APIに対してカスタムの認証済みHTTP呼び出しを行います。

アクションカードを使用することで、Advanced Server Access APIに対する任意のAPI呼び出しを行えます。このカードは主に、どの作成済みアクションカードにも対応できないユースケースのフローの構築に使用してください。ネイティブWorkflows APIコネクターは、他のアクションカードで使用されるASAv2接続オブジェクトを使用するため、代わりにこのコネクターを使用します。

カスタムAPIアクションカードは、提供される資格情報を使ってAdvanced Server Access APIへのURLを自動的に作成します。[Relative URL(相対URL)]フィールドには、リクエストの送信先エンドポイント/リソースへのパスのみを含める必要があります。相対URLの値の前に/は必要ありません。

カスタムAPIアクションは、操作の論理的検証を行いません(たとえば、DELETEリクエストにHTTPの本文が含まれることを防止しません)。APIを確実に正しく呼び出せるように、必ずAdvanced Server Access APIのドキュメントを参照してください。

オプション

フィールド 定義 タイプ 必須
リクエストタイプ カスタムAPI呼び出しでサポートされているHTTPリクエストメソッド、つまりHTTP動詞を以下に示します(「HTTPリクエストメソッド」を参照)。
  • GET:パラメーターに基づいてWebサーバーからデータを取得します。このメソッドは指定されたリソースの表現を要求します。リクエストが成功した場合、要求したコンテンツとともに200 (OK)レスポンスメッセージが返されます。
  • POST:パラメーターに基づいてWebサーバーにデータを送信します(ファイルのアップロードなど)。複数のPOSTリクエストは、単一のPOSTとは異なる結果になる場合があります。意図せず複数のPOSTリクエストを送信することを避けるために注意する必要があります。リクエストが成功した場合、200 (OK)レスポンスメッセージが返されます。
  • PUT:パラメーターに基づいて、Webサーバーの特定の場所に格納するデータを送信します (ファイルのアップロードなど)。POSTリクエストとは異なり、PUTリクエストは冪等です。リクエストが成功なら、同じPUTリクエストを何回実行しても、1回実行したときと同じ結果になります。リクエストが成功した場合、200 (OK)201 (Created)、または204 (No Content)レスポンスメッセージを受信します。
  • DELETE:パラメーターに基づいてWebサーバーから特定のリソース(存在する場合)を削除します。DELETEが成功した場合、200 (OK)レスポンスメッセージが返されます。
ドロップダウン TRUE

入力

フィールド 定義 タイプ 必須
Request(リクエスト)
Relative URL(相対URL)

対話を試みるWebサーバーのURLアドレス。/{insert_remaining_URL}のように相対URLを指定します。「?」を使用して相対URL内にクエリパラメーターを指定したり、クエリ入力内のオブジェクトキーペアとしてクエリパラメーターを指定したりすることができます。

このフィールドは、完全URL(https://app.scaleft.com/v1/:teams/:teamname)に相対します。

文字列 TRUE
Query(クエリ) オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。 オブジェクト FALSE
ヘッダー 認可またはコンテンツタイプ (これらはすでにこのコネクタで処理されている) に加えて必要な任意のヘッダーを指定します。 オブジェクト FALSE
本文 リクエストボディーをJSON形式で指定します。POSTおよびPUTリクエストでのみ使用できます。 オブジェクト FALSE

出力

フィールド 定義 タイプ
Response (レスポンス)
Status Code(ステータスコード) 操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
  • 201 Createdステータスコードは、アクションが成功し、新しいリソースが作成されたことを示します。
  • 403 Forbiddenエラーは、必要な権限が不足していたためにHTTPリクエストが処理されなかったことを示します。

発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。

数値
Headers(ヘッダー) 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは選択されたHTTPリクエストオプションに依存します。 オブジェクト
本文

選択したHTTPリクエストから返されたデータ。

たとえば、GETリクエストからのデータ。

オブジェクト

関連項目

Advanced Server Accessコネクター

Workflows要素

Advanced Server Access APIのドキュメント