REST API・ESS チートシート

URL とメタデータ

用途	URL（ホストは `https://<your-pod>.fa.<region>.oraclecloud.com`）
ERP・SCM のリソース	`/fscmRestApi/resources/11.13.18.05/<リソース>`
HCM のリソース	`/hcmRestApi/resources/11.13.18.05/<リソース>`（例：`workers`）
CX のリソース	`/crmRestApi/resources/11.13.18.05/<リソース>`（例：`accounts`）
子リソース	`/<リソース>/{キー}/child/<子リソース>`
1 リソースのメタデータ	`/<リソース>/describe`
全リソースの URL 一覧	`/fscmRestApi/resources/11.13.18.05/describe?metadataMode=list`
カスタム・アクション	`/<リソース>/{キー}/action/<アクション名>`（POST）
バッチ要求	`/fscmRestApi/resources/11.13.18.05`（POST）

練習用モック API は $BASE=https://<このサイトのURL>/api/mock/fscmRestApi/resources/11.13.18.05、認証は -u learner:welcome1 です（プレイグラウンド）。

クエリパラメータ早見表

パラメータ	書き方の例	既定値・注意
`q`	`q=InvoiceAmount >= 100000 and PaidStatus = 'Unpaid'`（Version 2 以降）	`queryable` な属性のみ。Version 1 は `;` 区切り
`finder`	`finder=PrimaryKey;InvoiceId=300100001`	`名前;変数=値,変数=値`
`fields`	`fields=InvoiceId,InvoiceNumber;invoiceLines:LineNumber,LineAmount`	子は `;子:属性`
`expand`	`expand=invoiceLines`、`expand=all`	既定は子を返さない
`onlyData`	`onlyData=true`	既定 `false`（links あり）
`limit`	`limit=500`	既定 25。1 回に返るのは最大 500 件
`offset`	`offset=500`	既定 0
`totalResults`	`totalResults=true`	既定 `false`
`orderBy`	`orderBy=InvoiceDate:desc,InvoiceId`	既定は昇順。一意な属性で並べる
`metadataMode`	`describe?metadataMode=minimal`	全リソースの describe でのみ使う

q の演算子（Version 2 以降）

種類	書き方
比較	`=`、`<>`、`!=`、`<`、`<=`、`>`、`>=`
範囲・集合	`BETWEEN a AND b`、`NOT BETWEEN`、`IN ('a','b')`、`NOT IN`
文字列	`LIKE 'AB%'`、`UPPER(属性) LIKE '%AB%'`
NULL	`IS NULL`、`IS NOT NULL`
論理	`and`、`or`、括弧
子での絞り込み	`invoiceLines.LineType = 'Freight'`

ヘッダーとメディアタイプ

ヘッダー	値の例	用途
`Authorization`	`Basic <Base64>`／`Bearer <トークン>`	認証
`Content-Type`	`application/vnd.oracle.adf.resourceitem+json`	POST・PATCH の本文
`Content-Type`	`application/vnd.oracle.adf.batch+json`	バッチ要求
`Content-Type`	`application/vnd.oracle.adf.action+json`	カスタム・アクション（応答は `...actionresult+json`）
`Accept`	`application/vnd.oracle.openapi3+json`	describe を OpenAPI 形式で取得
`REST-Framework-Version`	`4` など（1〜9）	省略時は 1。連携では必ず固定
`Upsert-Mode`	`true`	POST で「あれば更新・なければ作成」
`If-None-Match`／`If-Match`	`"<ETag>"`	変更確認（304）／楽観ロック（412）
`Metadata-Context`	`sandbox="<サンドボックス名>"`	サンドボックスの定義で呼び出す
`Accept-Language`	`ja` など	describe のラベルの言語

応答の Content-Type は、コレクションが application/vnd.oracle.adf.resourcecollection+json、単一項目が application/vnd.oracle.adf.resourceitem+json です。

REST Framework Version の要点

Version	変わること
1	既定。`q` は Query by Example 形式
2	`q` が式の形式（and・or・IN・BETWEEN・子での絞り込み）
3	`expand` した子がコレクション形式（`items`・`hasMore`）
4	エラー応答が詳細な JSON（エラーコード・パス）
5	カスタム・メソッドの戻り値が実際の型に。一部の LOV がルートへ
6	項目ごとに `@context`（キー・ヘッダー・リンク・警告）
7	行レベルの LOV を隠す
8	CLOB を文字列で、複数選択の値を配列で扱う
9	高精度の数値を文字列で返す。無効なアクセサー指定は 400。`LIKE` で `\` エスケープ

主要な REST リソース（執筆時に公式で確認できたもの）

リソース	パス	用途
`invoices`	`/fscmRestApi/resources/11.13.18.05/invoices`	AP 請求書
`invoiceLines`	`/invoices/{InvoiceId}/child/invoiceLines`	AP 請求書の明細（子）
`erpintegrations`	`/fscmRestApi/resources/11.13.18.05/erpintegrations`	FBDI 取込・ESS ジョブの実行と監視
`erpBusinessEvents`	`/fscmRestApi/resources/11.13.18.05/erpBusinessEvents`	ビジネスイベントの有効化
`currencyRates`	`/fscmRestApi/resources/11.13.18.05/currencyRates`	通貨レートの照会
`receivingReceiptRequests`	`/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests`	受入（公式の q の例で使用）
`workers`	`/hcmRestApi/resources/11.13.18.05/workers`	HCM の従業員
`accounts`	`/crmRestApi/resources/11.13.18.05/accounts`	CX の取引先

仕入先・AR 取引・購買オーダーなど、ほかのリソースの正確な名前は、各製品の REST API ガイドの All REST Endpoints で確認してください（このページ末尾の「公式ドキュメント」にガイドへのリンクがあります）。

erpintegrations のオペレーションと finder

POST（OperationName）

OperationName	主な入力	返るもの
`importBulkData`	`DocumentContent`（Base64 の ZIP）、`FileName`、`ContentType`（`zip`）、`DocumentAccount`、`JobName`、`ParameterList`	`ReqstId`
`uploadFileToUCM`	`DocumentContent`、`FileName`、`ContentType`、`DocumentAccount`	`DocumentId`
`submitESSJobRequest`	`JobPackageName`、`JobDefName`、`ESSParameters`	`ReqstId`
`exportBulkData`	`JobName`、`ParameterList`、`JobOptions`（例：`ExtractFileType=ALL`）	`ReqstId`

JobName は「ジョブ・パッケージ名,ジョブ定義名」をカンマでつなぎます。
ParameterList／ESSParameters はジョブのパラメータをカンマ区切りで並べます。渡さないパラメータは #NULL（または空欄）にして、位置をずらさないようにします。
NotificationCode は 2 桁です。1 桁目が方法（1＝メール、2＝ベル、3＝両方）、2 桁目が条件（0＝常に、1＝成功時、2＝失敗時）。
DocumentAccount の例：fin$/payables$/import$（AP の取込）。
CallbackURL に、完了時に状況を受け取る自前のサービスの URL を指定できます。

GET（finder）

finder	変数	取得できるもの
`ESSJobStatusRF`	`requestId`	ESS ジョブの状況（`RequestStatus`）
`ESSJobExecutionDetailsRF`	`requestId`、`fileType`	ログ・出力の ZIP（`DocumentContent`、Base64）
`ESSExecutionDetailsRF`	`requestId`、`jobOptions`	子ジョブを含む実行の詳細
`DocumentRF`	`docId`	UCM の文書の中身
`DocumentIdsByFilePrefixRF`	`filePrefix`、`docAccount`、`comment`	ファイル名の接頭辞に一致する文書 ID
`PrimaryKey`	`OperationName`	オペレーションの定義

API="$FA_HOST/fscmRestApi/resources/11.13.18.05"

# 状況の確認
curl -s -u "$FA_USER:$FA_PASS" "$API/erpintegrations?finder=ESSJobStatusRF;requestId=2101234"

# 出力とログの取得（fileType=LOG はログと出力、OUT は出力のみ）
curl -s -u "$FA_USER:$FA_PASS" \
  "$API/erpintegrations?finder=ESSJobExecutionDetailsRF;requestId=2101234,fileType=LOG"

モック API でも同じ finder を試せます（状況は時間の経過で WAIT → RUNNING → SUCCEEDED などに変わります）。

主要な ESS ジョブ（執筆時に公式で確認できたもの）

ジョブ（パッケージ,定義または表示名）	用途
`oracle/apps/ess/financials/payables/invoices/transactions,APXIIMPT`	AP 請求書のインポート（公式の `importBulkData` の例）
`oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader,InterfaceLoaderController`	FBDI ファイルをインターフェース表へロードする共通ジョブ
`oracle/apps/ess/financials/commonModules/shared/common/interfaceLoader,InterfaceLoaderPurge`	インターフェース表のパージ（Purge Interface Tables）
Upload Interface Error and Job Output File to Universal Content Management	エラーとジョブ出力を UCM にアップロード（exportBulkData の後続）
Import Attachments	添付ファイルの一括取込（FBDI と組み合わせて使う）
Import User and Role Application Security Data	ユーザー・ロールのセキュリティ・データの反映

ジョブのパラメータの並びはジョブ定義で決まります。各取込ジョブのパラメータは FBDI ガイド（File-Based Data Import for Oracle Fusion Cloud Financials など）で確認してください。ESS の運用は ESS の基本と運用を参照してください。

HTTP ステータス別の原因と対処

ステータス	意味	よくある原因	対処
200 OK	成功	－	－
201 Created	作成成功	－	`Location` ヘッダーに新しい URL
202 Accepted	受付済み（処理は未完了）	非同期処理	`Location` のジョブを照会する
204 No Content	成功（本文なし）	DELETE の成功など	－
304 Not Modified	変更なし	`If-None-Match` の ETag が一致	手元のデータを使う
400 Bad Request	要求の誤り	必須値の不足、検証エラー、`q` の文法、`queryable` でない属性、Version と構文の不一致	応答のメッセージを見てデータ・要求を直す。再試行しない
401 Unauthorized	認証失敗	資格情報の誤り、パスワード・トークンの期限切れ、ユーザーのロック	資格情報を確認し、トークンを取り直す
403 Forbidden	権限なし	ロール・権限の不足。許可されない場所からのアクセス（米国輸出規制）	統合ユーザーのロールとアクセス元を確認
404 Not Found	見つからない	URL・リソース名・バージョンの誤り、存在しないキー	URL とキーを確認。データセキュリティで見えない場合もある
405 Method Not Allowed	メソッド不可	そのリソースで使えないメソッド	ドキュメントで使える操作を確認
406 Not Acceptable	応答形式を返せない	`Accept` ヘッダーの指定	`Accept` を見直す
408 Request Timeout	要求のタイムアウト	要求の送信が遅い	ネットワーク・ペイロードを確認し再試行
412 Precondition Failed	前提条件の不一致	`If-Match` の ETag が古い（他で更新済み）	再取得してから更新し直す
415	本文の形式を受け付けない	`Content-Type` の誤り	`Content-Type` を直す
500 Internal Server Error	サーバー内部エラー	予期しないエラー	指数バックオフで再試行。続くならログを添えて SR
501 Not Implemented	未対応	サーバーが対応しないメソッド	要求を見直す
503 Service Unavailable	一時的に利用不可	過負荷、メンテナンス	指数バックオフで再試行。「Maintenance」なら長めに待つ
504 Gateway Timeout	ゲートウェイのタイムアウト	処理が重い	件数を絞る、`fields` で項目を減らす、再試行

公式ドキュメント

関連ページ

本サイトは学習目的で個人が作成した非公式の教材であり、Oracle Corporation およびその関連会社とは関係ありません。内容の正確性は保証しません。最新の仕様・試験範囲は必ず公式ドキュメントと Oracle University の情報で確認してください。

模擬テストの問題は公開されている出題範囲（Exam Topics）と公式ドキュメントをもとに独自に作成したもので、実際の試験問題ではありません。

Oracle、Java、MySQL は Oracle Corporation およびその子会社、関連会社の米国およびその他の国における登録商標です。その他の製品名・会社名は各社の商標です。

© 2026 Fusion ERP 実装ラボ