Workflow of a Form Document Application

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, v3, and so on.

1. Users submit form documents. Approvers approve or deny the documents.

2. The SAP Ariba application records information about the form documents, such as the name of the submitter and the approval status.

3. The client application uses Form Documents API to get form document data associated with a particular form design. The API requires a form design ID, which the client application can get using Forms API. The following example request URL gets information about form documents associated with form design bdff6e94-0f0e-4462-91fb-78a8e9198cd0. The filter narrows the results by approval status, date range, and form design version.

   {{runtime_url}}/documents
   Request body:{
   "formId":"bdff6e94-0f0e-4462-91fb-78a8e9198cd0",
   "formVersion":"3"
   "filter":"(status eq 'approved' or status eq 'denied') and createDate ge 2016-07-25T11:00:00.000-07:00 and 
   createDate lt 2016-11-30T13:00:00.000-07:00 and )&$limit=10&$offset=0"
   				

   In the preceding example:

   • The query filters the list to include approved and denied form documents that correspond to version 3 of the specified form ID and that were submitted within the following date range: on or after July 25, 2016, 11:00AM (PST) and before November 30, 2016, 01:00PM (PST)

   • $limit is set to 10, which limits the maximum number of results to 10.

   • $offset is set to 0, which says to start returning results from the beginning of the result set.

4. The API call returns the requested information. For sample response, see Response Example.