Apply hold
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/applyHold
Request
-
LineId(required): integer(int64)
The unique identifier of the contract line.
-
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
- application/vnd.oracle.adf.action+json
object
-
holdReasonCode: string
The reason code with which the contract line is being placed on hold.
-
holdUntilDate: string
(date)
The date till which contract line is being placed on hold.
Response
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
Examples
The following example shows how to hold a contract line by submitting a post request on the REST resource using cURL.
cURL Command
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
Example of Request Body
The following shows an example of the request body in JSON format.
{ "holdUntilDate":"2025-02-10", "holdReasonCode":"HOLD_QUALITY" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "result": "Success" }
Note:
You can't hold a contract on draft status.