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