Return Raw
この関数カードは呼び出し元にデータを返します。これはReturn関数カードの高度なバージョンですが、HTTP応答を完全に制御できます。
この関数カードを使用すると、次のことが実行できます。
|
XML返すAPIを作成する |
|
|
JSONリストを返すAPIを作成する |
|
|
動的キーを持つオブジェクトを返すAPIを作成する |
Return関数カードでは、設計時に応答のキーを定義する必要があります。代わりに、Return Raw関数カードを使用すると、Object関数カードを使用して応答オブジェクトを構築できます。次に例を示します。
|
| 応答のHTTPステータスコードを設定する |
Return関数カードは常に200HTTP応答コードを返します。 Return Rawカードを使っていずれかの有効値（200、または400～599）にHTTPステータスコードを設定します。 |
| 応答のHTTPヘッダーを設定する |
Object関数カードを使って必要なHTTPヘッダーを表すオブジェクトを作成します。 たとえば、ヘッダーオブジェクトが{ "Content-Type": "application/xml" }なら、応答のヘッダー文字列は"Content-Type: application/xml"になります。 Okta Workflowsは、これらのヘッダーとAPIサービスが生成するヘッダーをマージします。 |
入力
| フィールド | 定義 | タイプ | Required (必須) |
|---|---|---|---|
|
statusCode |
呼び出し元に返されるステータスコード。 有効な値は200または400～599の任意のHTTP応答コードです。 |
数値 |
誤 |
|
headers |
応答のヘッダーを表すオブジェクト。 ヘッダーの各キーは、"key: value"エントリとしてヘッダー文字列内に解析されます（例："Content-Type: text/plain"）。 |
オブジェクト |
誤 |
|
body |
HTTP応答の本文。 |
テキスト |
FALSE |
出力
このカードには出力フィールドがありません。
この関数カードは、If/ElseIfまたはIf/Errorブロックに配置すると異なる動作をします。
これらのブロックは、匿名のヘルパーフローを表すものと考えてください。ヘルパーフローを呼び出す場合と同様に、この関数カードは親に返します。この関数カードをこれらのブロックの1つに配置すると、コンテナの直後のステップに送られます。
通常の条件でフローを停止するには、If/ElseIfブロックの後でContinue If関数を使用します。Return Errorカードまたは代わりにReturn Error Ifカードを使用できますが、その場合はフローが停止するとエラーが生じます。