フロールーティング定義の編集

ここでは、作成済みのフロールーティング定義を後から編集する方法について説明します。

エラー発生時のレスポンスについて

REST APIを実行中に問題が発生すると、通常の「200 OK」ではなく、エラーを示すステータスコードが返ってきます。通常は、以下のようなJSON形式で返されます。

{
  "error": true,
  "errorMessage": "message"
}

表示されたステータスコードを確認し、エラーの原因に応じてフロールーティング定義を修正します。

ステータスコード	状況	説明
`400` Bad Request	入力データの形式が不正	リクエストで送信したデータが想定形式でない場合
`401` Unauthorized	未認証でアクセス	ログインしていない状態で認証が必要なAPIにアクセスした場合
`403` Forbidden	権限不足やトークン不正	認証済みでも権限が足りない場合、またはセキュアトークンが無効な場合
`404` Not Found	対象のURLが存在しない	指定したフロールーティングが存在しない場合
`500` Internal Server Error	フロー実行中の内部エラー	フロー処理中にエラー終了に到達した場合や、想定外のエラーが発生した場合

参考

フロールーティング定義の編集方法について説明します。ルーティング（URL）とメソッドは一度設定すると変更できません。変更が必要な場合は、新しくルーティング定義を作り直してください。

注意

ルーティング定義は、画面からの呼び出し口（URI）を固定化するためのものです。対象フローやバージョンを変更すると、同じURIを呼び出しても実行される処理が変わるため、画面動作に影響が出る可能性があります。
新しいバージョンで入力変数や出力データの構造が変わっている場合、呼び出し元が期待するデータ形式と一致せずエラーになることがあります。データ形式の互換性に注意してください。

参考

対象フローやバージョン番号を変更したい場合は、「フロールーティング設定（APIのURL）> 対象フロー定義情報の設定」を参照してください。

注意

認証方法を変更すると、セッションや認可設定との連携が効かなくなる可能性があります。アプリケーションの動作不良につながる恐れがあるため、必ず認証方法の特性を理解した上で変更してください。
認可URIを変更すると、今までアクセスできていたユーザが利用できなくなったり、逆に不要なユーザにアクセス権が広がったりする恐れがあります。変更の際は、必ずアクセス権の範囲を確認してください。
認証方式を「IMAuthentication」に変更する場合は、「セキュアトークンを利用する」にチェックを入れてください。

参考

認証・認可方式とセキュリティ設定を変更したい場合は、「フロールーティング設定（APIのURL）> 認証・認可方式とセキュリティ設定」を参照してください。

注意

レスポンス種別を変更すると、クライアント側の処理が正しく動作しなくなる可能性があります。クライアント側との互換性を十分に確認してください。
レスポンスヘッダを変更すると、ブラウザやAPIゲートウェイの挙動に影響します。特にキャッシュ設定を誤ると、古いレスポンスが返され続けるなどの不具合につながるため注意が必要です。

参考

レスポンス設定を変更したい場合は、「フロールーティング設定（APIのURL）> レスポンス設定」を参照してください。

REST APIのURLに対して、フローを実行する側のユーザを変更したい場合は、フロールーティング定義の認可設定を変更します。

注意

認可設定を変更すると、今までアクセス可能だったユーザが利用できなくなったり、逆に不要なユーザにアクセス権が広がったりする恐れがあります。変更の際は、必ずアクセス権の範囲を確認してください。

コラム

認可の対象となるユーザには、複数の種類があります。

表示される種類は、利用環境によって異なります。詳細は、「認可仕様書」を参照してください。