Create Contract Workspaces by Copying Existing Contracts Using the Contract Workspace Modification API

Implement the Contract Workspace Modification API to create a contract workspace by copying contents from an existing contract workspace.

Prerequisites

When using the Contract Workspace Modification API to create a contract workspace having a hierarchical relationship with another contract, ensure that the parent agreement already exists and has a valid hierarchical type. The parent agreement of a subagreement can be either a master agreement or a subagreement.

Context

The Contract Workspace Modification API enables you to create a contract workspace by copying contents from an existing contract workspace in SAP Ariba Contracts using the POST /contractworkspaces endpoint.
To create a contract workspace by copying contents from an existing contract workspace, you must include the following details in the request body:
  • Contract title (title)

  • Contract description (description)

  • Effective date (effectiveDate)

  • ID of the source contract workspace you wish to copy (copyFromContractID)

You can include other contract-related information such as commodities, regions, departments, suppliers, and so on, in the request body. If you do, those details will replace the corresponding information copied the source contract workspace.

Procedure

Invoke the POST /contractworkspaces endpoint to create a contract workspace.

Request type: POST

URL: {{runtime_url}}/contractworkspaces

The following example creates a contract workspace (procurement) with the specified details:
copyFromContractID
Use the copyFromContractID object to specify the ID of the contract you wish to copy.

Results

If the request is successful, the API creates a contract workspace with the specified details in SAP Ariba Contracts. For a list of response codes, refer to Error Messages Returned by the Contract Workspace Management APIs.

Next Steps

Open the contract in SAP Ariba Contracts and verify the details.