Endpoints Included in the Contract Workspace Management APIs

This topic describes the different endpoints supported by each API within the Contract Workspace Management APIs.

Endpoints Included in the Contract Workspace Modification API

The Contract Workspace Modification API consists of the following endpoints:

Endpoint

Description

POST /contractworkspaces

Creates a contract workspace using the ContractWorkspace Model Object that contains Contract Header fields metadata.

For more information, refer to Creating Contract Workspaces Using the Contract Workspace Modification API.

POST /contractWorkspaces/{contractId}/state

Updates the status of a published procurement contract workspace to DraftAmendment (action = amend) so that you can modify the contract workspace. You can use the same endpoint with the action parameter set to complete amendment to trigger publishing for Administrative or PriceUpdate amendments.

For more information, refer to Changing the State of Procurement Contract Workspace Using the Contract Workspace Modification API.

PATCH /contractworkspaces

Updates an existing contract workspace by using the provided contract workspace fields for updating the contract.

For more information, refer to Updating Contract Workspaces Using the Contract Workspace Modification API.

Endpoints Included in the Contract Terms Management API

The Contract Terms Management APIs consists of the following endpoints:

Endpoint

Description

POST /contractWorkspaces​/{contractId}​/contractTerms

Creates a contract term in the specified contract workspace and a contract request for compliance contracts in the specified buyer realm.

For additional information, refer to Creating and Reviewing Contract Terms by Using the Contract Term Management API.

GET /contractWorkspaces​/{contractId}​/contractTerms

Retrieves details including contract term ID, contract request ID, and contract ID for the specified contract workspace ID.

For additional information, refer to Creating and Reviewing Contract Terms by Using the Contract Term Management API.

POST /contractWorkspaces/{contractId}/contractTerms/{contractTermId}/state

Synchronizes the contract line item information of a contract workspace with the linked compliance contract by specifying the IDs of the contract workspace and the contract terms document. If the request is successful, the API initiates an asynchronous job and returns the job ID for reference.

For additional information, refer to Synchronizing Contract Line Item Data of a Contract Workspace With Linked Compliance Contract Using Contract Terms Management API.

Endpoints Included in the Contract Workspace Retrieval API

The Contract Workspace Retrieval API consists of the following endpoints:

Endpoint

Description

GET /contractWorkspaces

Gets contract workspaces matching the provided criteria.

For more information, refer to Searching for Contract Workspaces Using the Contract Workspace Retrieval API.

GET /contractWorkspaces/$contractId

Returns the single contract workspace matching the provided contract workspace ID.

For more information, refer to Getting Contract Workspaces Matching the Provided ID Using the Contract Workspace Retrieval API.

Endpoints Included in the Contract Line Items Document Retrieval API

The Contract Line Items Document Retrieval API consists of the following endpoints:

Endpoint

Description

GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}

Retrieves the document and the metadata associated with the specified document ID and the contract ID. The metadata includes all the standard fields, custom fields, task IDs, task names, line item types (including hierarchical line items and line items with pricing conditions), and translations of line items in the CLID. The API also retrieves all the versions of the CLID excluding the version that is in the Not Created status.

For more information, refer to Getting the Metadata of a Contract Line Items Document Using the Contract Line Items Document Retrieval API.

Endpoints Included in the Contract Line Items Document Download API

The Contract Line Items Document Download API consists of the following endpoints:

Endpoint

Description

GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files

Downloads the CLID corresponding to the specified document ID and contract workspace ID.

For more information, refer to Downloading a Contract Line Items Document Using the Contract Line Items Document Download API.

Endpoints Included in the Contract Line Items Document Management API

The Contract Line Items Document Management API consists of the following endpoints:

Endpoint

Description

POST /contractWorkspaces/{contractId}/contractLineItemDocuments

Creates a CLID in the specified contract workspace.

For more information, refer to Creating a Contract Line Items Document in a Contract Workspace using the Contract Line Items Document Management API.

PATCH /contractWorkspaces/{contractId}/contractLineItemDocuments/{id}

Modifies the attributes of an existing CLID in the specified contract workspace.

For more information, refer to Updating a Contract Line Items Document Using the Contract Line Items Document Management API.

Endpoints Included in the Contract Line Items Document Publish API

The Contract Line Items Document Publish API consists of the following endpoints:

Endpoint

Description

POST /contractWorkspaces/{contractId}/contractLineItemDocuments/{id}/state

Publishes the contract line items document (CLID) associated with a procurement contract workspace.

For more information, refer to Publishing Contract Line Items Document by Using the Contract Line Items Document Publish API.

Endpoints Included in the Contract Line Items Document Import API

The Contract Line Items Document Import API consists of the following endpoints:

Endpoint

Description

POST /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files

Imports the line item data to the CLID of a contract workspace.

For more information, refer to Importing Line Items to a Contract Line Items Document Using the Contract Line Items Import API.

Deletes or Deactivates Line Items in a Contract Line Items Document of a contract workspace.

For more information, refer to Deleting or Deactivating Line Items in a Contract Line Items Document Using the Contract Line Items Import API.

Imports Deactivated Line Items From an Integrated ERP System to a contract workspace.

For more information, refer to Importing Deactivated Line Items From an Integrated ERP System to a Contract Workspace Using Contract Line Items Import API.

Endpoints Included in the Contract Workspace Delete API

The Contract Workspace Delete API consists of the following endpoints:

Endpoint

Description

DELETE /contractWorkspaces/{contractId}

Deletes a contract workspace in SAP Ariba Contracts.

For more information, refer to Deleting a Contract Workspace Using the Contract Workspace Delete API.