Forms API

The Forms API enables your application to get information about published form designs created using the forms builder.

The primary use case for this API is to get form design IDs. You then use the IDs with the Form Documents API (form-documents-api) to get the submitted form documents associated with a specific form design, based on the form design ID.

You can get information for all form design versions that were ever published on your SAP Ariba site, or you can use the rsqlfilter parameter to narrow the result set.

No changes can be made to form designs with this API.

Filtering the result set

If you don't filter the result set, the API returns all versions of all form designs that have ever been published on your site.

The rsqlfilter parameter lets you filter the result set using the following attributes: status, name, and publishedBy. These attributes are described in the following sections.

Separator to use when specifying multiple attributes: and

Filter Attribute

Description

status

Includes only versions of form designs that have the specified status. Valid status values are:

  • published: Form design versions that are published, have not been replaced by a later version, and have not been deleted.

  • obsolete: Form design versions that have been replaced by a later version and have not been deleted.

  • deleted: Form design versions that have been deleted.

Operator to use with the status attribute: =in=

Examples:

  • status=in=obsolete

  • status=in=published,obsolete

  • status=in=obsolete,deleted

  • status=in=published,obsolete,deleted

name

Includes versions of form designs that have the specified form title.

You can't specify more than one name, but you can use the * wildcard.

Operator to use with the name attribute: ==

Examples:

  • name==Charity Form

  • name==*rity*

  • name==Charity*

  • name==*Form

publishedBy

Includes version of form designs published by the user with the specified user name.

You can't specify more than one user name. Also, values are case sensitive.

Operator to use with the publishedBy attribute: ==

Example:

  • publishedBy==SPisa