Project Document Management API

This guide is for developers who use the Project Document Management API to develop client applications to search for project documents, view the properties of a project document, download specific project documents, and create folders or project documents of type Standard Document, Main Agreement, and Contract Addendum. The API can also update folders and project documents of type Standard Document, Main Agreement, and Contract Addendum in a Contract Workspace (Procurement).

The Project Document Management API collection contains various endpoints that enable you to:

Create folders and project documents of type Standard Document, Main Agreement, and Contract Addendum
Update folders and project documents of type Standard Document, Main Agreement, and Contract Addendum in a Contract Workspace (Procurement)
Change the state of documents such as standard documents, Main Agreement, and contract addendum in a Contract Workspace (Procurement)
Perform certain actions on various documents. For more information, see Document and Project Types Supported by the Project Document Management API.

For a list of project types supported by the Project Document Management API, see Document and Project Types Supported by the Project Document Management API.

This guide applies to:

SAP Ariba APIs
SAP Ariba Developer Portal
SAP Ariba Contracts
SAP Ariba Strategic Sourcing Suite

Prerequisites

To create an application and request access to use the SAP Ariba APIs relevant to this feature, you must have access to the SAP Ariba Developer Portal. For details refer to Steps to Start Using the SAP Ariba APIs in Help for the SAP Ariba Developer Portal.
All queries made to this API must be authenticated using OAuth authentication. For details refer to SAP Ariba Developer Portal Authentication in Help for the SAP Ariba Developer Portal.
User whose credentials are passed in the API call must be a project owner or a team member, or should have view permissions.

Restrictions

You can use the Project Document Management Creation API to create Standard Document, Contract Addendum, Main Agreement, and folder only.
You can use the Project Document Management Creation API to create project documents in a Contract Workspace (Procurement), but you cannot create project documents in any other workspace.
Translations are not supported for the name and description fields. The base language of the project is set as the base language of the project document.
You cannot create multiple folders or documents by making a single API call using the Project Document Management Creation API.
When multiple users simultaneously try to create project documents (Standard Document, Main Agreement, and Contract Addendum) with the same name using the Project Document Management Creation API, multiple documents with the same name might get created for a project.
The Project Document Management API does not support visibility, editability, and validity of fields at the document level.
You can use the Project Document Management Modification API to upload a zip file as a Standard Document, but you cannot extract a zip file to a Contract Workspace (Procurement).
You can use the Project Document Management Modification API to update project documents in a Contract Workspace (Procurement only), but you cannot update project documents in any other workspace.
You cannot update multiple folders or documents by making a single API call using the Project Document Management Modification API.
You cannot use the Project Document Management State Change API to modify the state of documents in contract workspaces that are in Published, On Hold, Closed, or Expired state.
When multiple users simultaneously try to update project documents (Standard Document, Main Agreement, and Contract Addendum) with the same name, multiple documents with the same name might get updated for a project.
In the Project Document Management Creation and Modification APIs, the file size limit for standard documents is 20 MB. When the Application.ACM.IcertisIntegration parameter is set to false, the file size limit for Main Agreements and Contract Addendums is 50 KB. When the Application.ACM.IcertisIntegration parameter is set to true, the file size limit for Main Agreements and Contract Addendums is 20 MB. For more information about the parameter, see Enable SAP Ariba Contracts integration and contract data sharing with Icertis.
If you are using SAP Ariba Contracts integrated with Icertis Contracts Intelligence for SAP Ariba Solutions (that is the Application.ACM.IcertisIntegration parameter is set to true), the Main Agreement and Contract Addendum documents in Contract workspaces are processed in ICI and not in SAP Ariba Contracts. Therefore, if you set the Application.ACM.IcertisIntegration parameter to false, the Main Agreement and Contract Addendum documents that were not processed by SAP Ariba Contracts will not be shown in the outline view. For more information about the parameter, see Enable SAP Ariba Contracts integration and contract data sharing with Icertis.
The filters specified in the GET /projectDocuments API endpoint act like search operations in SAP Ariba solutions with similar performance, which means there could be a slight delay before newly created or updated data appears. If the data is not available, run the API again after some time. The time it takes to run the API again is determined by the API rate limits that are configured for your application. For more information, see Tracking Your API Usage to Avoid Exceeding Rate Limits.

Related guides

Help for the SAP Ariba Developer Portal