Getting the Metadata of a Contract Line Items Document Using the Contract Line Items Document Retrieval API
The Contract Line Items Document Retrieval API can be implemented in a client application to use this procedure to get the metadata of the Contract Line Items Document (CLID) in a procurement contract workspace in SAP Ariba Contracts.
Prerequisites
To get the metadata of a CLID from a contract workspace, you must have the IDs of the procurement contract workspace and the corresponding CLID.
Context
The Contract Line Items Document Retrieval API enables you to get the properties and metadata of a Contract Line Items Document (CLID) in a contract workspace using the GET /contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId} endpoint. The response contains the metadata that includes all the standard and custom fields, task IDs and 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 a list of response codes for the API calls, see Error Messages Returned by the Contract Workspace Management APIs.
Procedure
GET {{runtime_url}}/contractWorkspaces/{contractId}/contractLineItemDocuments/{documentId}
- documentId
-
The CLID identifier.
- contractId
-
The procurement contract workspace identifier.