カスタムAPIアクション
Advanced Server Access APIに対してカスタムの認証済みHTTP呼び出しを行います。
アクションカードを使用することで、Advanced Server Access APIに対する任意のAPI呼び出しを行えます。このカードは主に、どの作成済みアクションカードにも対応できないユースケースのフローの構築に使用してください。ネイティブWorkflows APIコネクターは、他のアクションカードで使用されるASAv2接続オブジェクトを使用するため、代わりにこのコネクターを使用します。
Custom API Actionカードは、提供される資格情報を使ってAdvanced Server Access APIへのURLを自動的に作成します。[Relative URL(相対URL)]フィールドには、リクエストの送信先エンドポイント/リソースへのパスのみを含める必要があります。相対URLの値の前に/は必要ありません。
カスタムAPIアクションは、操作の論理的検証を行いません(たとえば、DELETEリクエストにHTTPの本文が含まれることを防止しません)。APIを確実に正しく呼び出せるように、必ずAdvanced Server Access APIのドキュメントを参照してください。
オプション
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
リクエストタイプ |
カスタムAPI呼び出しでサポートされているHTTPリクエストメソッド、つまりHTTP動詞を以下に示します(「HTTPリクエストメソッド」を参照)。
|
ドロップダウン | TRUE |
入力
フィールド | 定義 | タイプ | 必須 |
---|---|---|---|
Request(リクエスト) | |||
Relative URL(相対URL) |
対話を試みるWebサーバーのURLアドレス。 このフィールドは、完全URL(https://app.scaleft.com/v1/:teams/:teamname)に相対します。 |
文字列 | TRUE |
Query(クエリ) | オブジェクト形式 (キーと値のペア) で含める必要がある追加のクエリーパラメーターを指定します。 | オブジェクト | FALSE |
ヘッダー | 承認またはコンテンツタイプ (これらはすでにこのコネクタで処理されている) に加えて必要な任意のヘッダーを指定します。 | オブジェクト | FALSE |
本文 | リクエストボディーをJSON形式で指定します。POST およびPUT リクエストでのみ使用できます。 |
オブジェクト | FALSE |
出力
フィールド | 定義 | タイプ |
---|---|---|
Response (レスポンス) | ||
Status Code(ステータスコード) | 操作の結果。コネクターは、カードによって実行されたアクションが成功したか失敗したかを示す、HTTPステータスコードを返します。例:
発生する可能性があるステータスコードの完全なリストについては、「HTTPステータスコード」を参照してください。 |
数値 |
Headers(ヘッダー) | 出力ボディーとは関係のない、ステータスコードの詳細なコンテキスト。レスポンスヘッダーは選択されたHTTPリクエストオプションに依存します。 | オブジェクト |
本文 |
選択したHTTPリクエストから返されたデータ。 たとえば、 |
オブジェクト |