保留の適用
post
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/applyHold
このメソッドでは、指定した保留期限までの契約明細に保留を適用できます。
リクエスト
パス・パラメータ
- LineId(required): integer(int64)
契約明細の一意の識別子。
- contractsUniqID(required): string
これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/vnd.oracle.adf.action+json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
holdReasonCode: string
契約明細を保留にする事由コード。
-
holdUntilDate: string (date)
契約明細が保留になる日付。
応答
サポートされるメディア・タイプ
- application/json
- application/vnd.oracle.adf.actionresult+json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
例:
次の例では、cURLを使用してRESTリソースに対する事後リクエストを発行して、契約明細を保持する方法を示します。
cURLコマンド
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com//fscmRestApi/resources/11.13.18.05/contracts/300100543663792/child/ContractLine/100100095837776/action/applyHold \ -H 'Content-Type: application/vnd.oracle.adf.action+json' | json_pp
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{
"holdUntilDate":"2025-02-10",
"holdReasonCode":"HOLD_QUALITY"
}
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"result": "Success"
}
ノート:
ドラフト・ステータスの契約は保留できません。