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~599)にステータスコードを設定します。

  • 応答のhttpヘッダーを設定するObject関数を使って必要なヘッダーを表すオブジェクトを作成します。たとえば、ヘッダーオブジェクトが{ "Content-Type": "application/xml" }であれば、応答のヘッダー文字列は"Content-Type: application/xml"となります。Okta Workflowsは、これらのヘッダーとAPIサービスが生成するヘッダーをマージします。

入力

フィールド 定義 タイプ Required (必須)

statusCode

呼び出し元に返されるステータスコード。

有効な値は200または400599の任意のHTTPレスポンスコードです。

数値

headers

応答のヘッダーを表すオブジェクト。

ヘッダーの各キーは、"key: value"エントリとしてヘッダー文字列内に解析されます(例:"Content-Type: text/plain")。

オブジェクト

body

HTTP応答の本文。

文字列

出力

このカードには出力フィールドがありません。

この関数カードは、If/ElseIfまたはIf/Errorブロックに配置すると異なる動作をします。

これらのブロックは、匿名のヘルパーフローを表すものと考えてください。ヘルパーフローを呼び出す場合と同様に、この関数カードは親に返します。この関数カードをこれらのブロックの1つに配置すると、コンテナの直後のステップに送られます。

通常の条件でフローを停止するには、If/ElseIfブロックの後でContinue If関数を使用します。Return Errorカードまたは代わりにReturn Error Ifカードを使用できますが、その場合はフローが停止するとエラーが生じます。

関連項目

関数

Workflows要素