Getting Contract Workspaces Matching the Provided ID Using the Contract Workspace Retrieval API

Use this procedure to get contract workspaces matching the provided ID using the Contract Workspace Retrieval API.

Prerequisites

You must have a contract workspace containing a main agreement and supporting contract documents for a contract with a supplier, and you must have the associated contract workspace ID. For information about contract workspace IDs and how to obtain them, see SOAP ContractId and WorkspaceId elements for contract workspaces in SOAP web service API integration guide.

Context

If you created a contract workspace associated to store the contract Main Agreement and supporting contract documents for a contract with a supplier, you can use the contract workspace ID to search for the contract workspace matching the provided ID.

Procedure

  1. Obtain the contract workspace ID of the contract workspace for which you require information. For information about contract workspace IDs and how to obtain them, see SOAP ContractId and WorkspaceId elements for contract workspaces in SOAP web service API integration guide.
  2. Invoke the GET /contractworkspaces$contractId endpoint to request the contract workspace matching the provided contract workspace ID.

    Request type: GET

    URL: {{runtime_url}}/contractworkspaces/$id