Overview of the Guided Buying Functional Documents API

This API makes it possible to use client applications to update externally managed forms in guided buying.

This API includes the following endpoints:

PATCH /externalDocuments/{documentId}: Updates the status of externally managed form in guided buying
GET /externalDocuments/{documentId}: (Optional) gets the details of an externally managed form from guided buying

This API supports the following document type:

Externally managed form

Prerequisites

You must create an outbound API to send form data from guided buying to your client application. For more information, see Creating and Publishing an Outbound API.
To create an application and request access to use this API, 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.
To get complete form field values, your client application must call the Custom Forms API after receiving an outbound API call. Custom field values are available only through the Custom Forms API. For more information, see Custom Forms API.
Guided buying must be configured to support externally managed forms. For more information, see Guided Buying Administration.

Restrictions

Your client application must call the outbound API before calling the Guided Buying Functional Documents API; the outbound API provides data required by the inbound API.