Jump to

• Request
• Response
• Examples

Remove hold

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/action/removeHold

This method lets you remove the hold on a contract line on a specified date.

Request

Path Parameters

• 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.

Header Parameters

• 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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• removeHoldDate: string (date)
  The date on which the hold is removed for a contract line.

{
    "type":"object",
    "properties":{
        "removeHoldDate":{
            "type":"string",
            "description":"The date on which the hold is removed for a contract line.",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  204 Response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"204 Response."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following example shows how to remove hold on 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/removeHold \ -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.

None

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "result": "Success"
}
  

Back to Top