Return Raw

この関数カードは呼び出し元にデータを返します。この関数は、Returnの高度なバージョンです。HTTP応答を完全にコントロールできます。

この関数を使用して、次の動作を行えます。

  • XMLを返すAPIを作成する:XML Build関数を使用して、応答を含むXML文字列を作成してから、Return Rawカードのbody入力に出力をドラッグします。

  • JSONリストを返すAPIを作成する:JSON Stringify関数を使用して、リスト応答の文字列化表現を作成してから、Return Rawカードのbody入力に出力をドラッグします。

  • 動的キーを持つオブジェクトを返すAPIを作成する:Return関数カードでは、設計時に応答のキーを定義する必要があります。Return Raw関数カードを使用すると、Object関数を使用して応答オブジェクトを構築してから、JSON Stringifyカードを使用してオブジェクトの文字列化バージョンを作成し、Return Rawカードのbody入力に出力をドラッグできます。

  • 応答のステータスコードを設定する:Return関数カードは常に200を返します。Return Rawカードを使用すると、有効な値のどれにでもステータスコードを設定できます(200、または400~600)。

  • 応答のhttpヘッダーを設定する:Objectg関数を使用して、目的のヘッダーを表すオブジェクトを作成します。たとえば、ヘッダーオブジェクトが{ "Content-Type": "application/xml" }なら、応答のヘッダー文字列は"Content-Type: application/xml"になります。Workflowはこれらのヘッダーを、APIサービスで生成されたヘッダーと結合できます。

入力

フィールド 定義 タイプ 必須
statusCode 呼び出し元に返されるステータスコード。有効な値は、200および400~600です。 数値 FALSE
headers 応答のヘッダーを表すオブジェクト。ヘッダーの各キーは、"key: value"のヘッダー文字列として、"Content-Type: text/plain"のように解析されます。 オブジェクト FALSE
本文 HTTP応答本文。 文字列 FALSE

出力

このアクションカードには出力フィールドがありません。

関連項目

Workflowsの関数

Workflows要素