Duplicate a contract
post
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/action/duplicate
This method lets you duplicate an existing contract while selecting which portions of the contract are duplicated.
Request
Path Parameters
-
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
Root Schema : schema
Type:
Show Source
object
-
associatedProjectAndTasks: boolean
Option to indicate if associated projects and tasks are duplicated.
-
billingControls: boolean
Option to indicate if the billing controls are duplicated.
-
billPlanAndRevenuePlan: boolean
Option to indicate if bill plan and revenue plans are duplicated.
-
contractNumber: string
The alternate unique identifier of the contract.
-
contractTerms: boolean
Option to indicate if the contract terms are duplicated.
-
currency: string
The currency of the target contract.
-
endDate: string
(date)
The end date of the target contract. This is required if the retain date is set to false.
-
lines: boolean
Option to indicate if the contract lines are duplicated.
-
notes: boolean
Option to indicate if notes is duplicated.
-
otherParties: boolean
Option to indicate if the other parties are duplicated.
-
partyId: number
The unique identifier of the party associated with the contract.
-
retainDates: boolean
Option to indicate if the source contract dates are retained.
-
startDate: string
(date)
The start date of the target contract. This is required if the retain date is set to false.
-
userVariableValues: boolean
Option to indicate if the user variable values are duplicated.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Examples
The following example shows how to duplicate a contract 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/300100207119967/action/duplicate
\ -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.
{ "contractNumber":"ank_blooms_dup", "partyId":1004, "retainDates":false, "startDate":"2020-02-10", "endDate":"2021-10-01", "currency":"USD", "otherParties":true, "notes":true, "billPlanAndRevenuePlan":true, "associatedProjectAndTasks":true, "contractTerms":true, "userVariableValues":true, "lines":true, "billingControls":true }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "result": " Contract Number:ank_blooms_dup, Contract Id :300100207831469" }