Downloading a Contract Line Items Document Using the Contract Line Items Document Download API

Use this procedure to download a contract line items document. The Contract Line Items Document Download API can be implemented in a client application to download the Contract Line Items Document (CLID) in a procurement contracts workspace in SAP Ariba Contracts.

Prerequisites

To download a CLID from a procurement contract workspace, you must have the IDs of the contract workspace and the corresponding CLID.

Context

The Contract Line Items Document Download API enables you to download a CLID associated with a procurement contract workspace by using the GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files endpoint. The CLID is downloaded in the standard Excel format.

For a list of response codes for the API calls, see Error Messages Returned by the Contract Workspace Management APIs.

Procedure

Invoke the GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files endpoint to download the CLID from a procurement contract workspace.
GET {{runtime_url}}/contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}/files
documentId

The CLID identifier.

contractId

The procurement contract workspace identifier.