Use of the Custom Forms API
For most use cases that involve synchronous data retrieval, you use the custom forms APIs in the following order:
-
Use the Forms API (forms-service-api) to get IDs and other information about form designs.
-
Once you have form design ID information from step 1, use the Form Documents API (form-documents-service-api) to get data from the submitted form documents associated with a specific form design.
To get form document data asynchronously, you use the Forms Asynchronous Reporting API.
After SAP Ariba maps your application to your SAP Ariba site, you can use the custom forms API as follows:
When multiple versions of the API are available on the developer portal, use the runtime URL specific to that version. Different versions distinguish their runtime URLs by modifying the version number, for example, v1, v2, and so on.
Request type: GET
URL: {{runtime_url}}/forms
Headers:
-
Authorization:Bearer{your access token}
-
apikey{your application key}
-
X-System{GuidedBuying, GuidedBuying_FuncDoc_EM, or Buyer}
-
X-Tenant{name of your SAP Ariba site}
-
X-AnId