Workflow for the Contract Workspace Management APIs

This topic describes the workflow of the different APIs within the Contract Workspace Management APIs.

Workflow for Contract Workspace Modification API

  1. A contract administrator (such as the customer support administrator or super user) ensures that all the parameters related to procurement contract workspace creation are enabled.

  2. The contract administrator verifies whether a procurement contract workspace template exists.
  3. Depending on whether the contract workspace template exists, the client application either creates a contract workspace with a system template ID or updates an existing contract workspace, as follows:
    • To create a contract workspace with a system template ID, the client application uses the POST /contractworkspaces endpoint, providing the system template ID. The template may contain all the details related to tasks, documents, teams, and references to integrated systems.

    • To update an existing contract workspace:
      1. If the contract workspace is in published state, the client application changes the state of the contract workspace to amend by using the POST /contractworkspace/contractId/state endpoint. The client application provides the contract workspace ID as contractID.

      2. The client application uses the PATCH /contractworkspaces endpoint to update the contract workspace. The client application provides the contract workspace ID and the updated contract workspace fields for updating the contract, such as OOTB (out of the box) header fields and custom header fields, as applicable to the specified amendment type, in the body of the API request.

      3. If the updated contract workspace was in published state and the state was changed to amend to enable the updates:
        • If the type of amendment is Administrative or PriceUpdate, the client application changes the state of the contract workspace to amend complete by using the POST /contractworkspace/contractId/state endpoint. The client application provides the contract workspace ID as contractID.

        • If the type of amendment is Amendment, Renewal, or Termination, users manually republish the contract.

Workflow for the Contract Terms Management API

  1. Buyer user or the client application creates a contract workspace in SAP Ariba Contracts or SAP Ariba strategic sourcing solutions. Sourcing users can either create the contract workspace from the UI or configure the client application to create the workspace by using the Contract Workspace Modification API.

  2. The client application creates a contract terms document in the contract workspace and a contract request in SAP Ariba Procurement solutions.

  3. Buyer user completes the approval workflow for the contract request in SAP Ariba Procurement solutions to generate the contract ID. You can complete the approval from the SAP Ariba Procurement solutions UI.

  4. (Optional) The client application retrieves information about the contract terms document and the compliance contract.

  5. Buyer users can synchronize 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.

Workflow for the Contract Workspace Retrieval API

  1. The sourcing user or the client application creates a contract workspace containing the Main Agreement and supporting contract documents for a contract with a supplier.

  2. You can search for a single contract workspace details or search for procurement contract workspaces meeting certain criteria.

    • Use the GET /contractworkspaces$contractId endpoint to request the contract workspace matching the provided contract workspace ID.

    • Use the GET /contractworkspaces endpoint to retrieve a list of contract workspaces matching the search criteria. You can further filter the workspaces based on their attributes.

Workflow for the Contract Line Items Document Retrieval API

The client application gets the properties and metadata of a Contract Line Items Document (CLID) in a procurement contract workspace using the GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId} endpoint. The contract workspace ID is specified in contractId and the ID of the CLID is specified in documentId.

Workflow for the Contract Line Items Document Download API

The client application downloads the Contract Line Items Document (CLID) using the GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files endpoint. The contract workspace ID is specified in contractId and the ID of the CLID is specified in documentId.

Workflow for the Contract Line Items Document Management API

  1. To create a Contract Line Items Document (CLID) in a contract workspace in SAP Ariba Contracts, the client application uses the POST /contractWorkspaces/{contractId}/contractLineItemDocuments endpoint. The contract workspace ID is specified in contractId.

  2. To modify a Contract Line Items Document (CLID) in a contract workspace in SAP Ariba Contracts, the client application uses the PATCH /contractWorkspaces/{contractId}/contractLineItemDocuments/{id} endpoint. The contract workspace ID is specified in contractId and the ID of the CLID is specified in id.

Workflow for the Contract Line Items Document Publish API

The client application publishes the contract line items document (CLID) associated with a contract workspace (procurement) in SAP Ariba Contracts using the POST /contractWorkspaces/{contractId}/contractLineItemDocuments/{id}/state endpoint. The contract workspace ID is specified in contractID and the ID of the CLID is specified in id.

Workflow for the Contract Line Items Document Import API

The client application uses the POST /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files endpoint to perform the following tasks.:
  • Import the line item data to the CLID of a contract workspace in SAP Ariba Contracts.

  • Delete or Deactivate Line Items in a Contract Line Items Document of a contract workspace.

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

The contract workspace ID is specified in contractId and the ID of the CLID is specified in documentId.

Workflow for the Contract Workspace Delete API

The client application deletes a contract workspace in SAP Ariba Contracts using the DELETE /contractWorkspaces/{contractId} endpoint. The contract workspace ID is specified in the contractId.