Workflow of a Form Design API 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, and so on.

1. Form designers publish versions of form designs. They can also delete published versions of form designs.

2. The SAP Ariba application records information about the form designs, for example, form design IDs and titles.

3. The client application uses forms-service-api to request a list of form designs that have been published. The following example request URL gets information about published and deleted form designs that have the name that starts with "Charity" and were published by user SPisa:

   {{runtime_url}}/forms?
   rsqlfilter=(status=in=(published,deleted) and name==Charity* and publishedBy==SPisa)&limit=10&offset=0
   				

   In the preceding example:

   • rsqlfilter filters the list to include form design versions that are published or deleted, that have a form title starting with "Charity," and that were published by user SPisa. The filter doesn't include obsolete versions.

   • 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.

5. The client application, using some of the information returned, uses form-documents-api to get form document data associated with a particular form design.