Documentation Center

view_form

Returns a single Form as either XML, RSS or its read-only HTML instance.

Description

Queries xforms based on parameters provided.

Parameters

action
view_form
fid
ID of the XForm definition. To access a user's profile or preference forms, use "profile" and "preference" as the fid.
format
The output format for the results. Either "html", "rss" or "xml". Defaults to "html"
type
Form type. It can be system, floating or document.
docid
The document ID scope to use quering XForms. To access a user's profile or preference forms, use the user's login (such as "admin") as the docid.
name
User form name like profile, preference. To access a user's profile or preference forms, use "profile" and "preference" as the name of the form.

Example URL

http://<host>:<port>/<context>/web/xforms.xql?action=view_form&fid=<value>&format=<value>&type=<value>&docid=<value>&name=<value>

Successful Result

When successful, returns a single form rendered in the requested format, otherwise displays an error page.

Failed Result

If a user does not have 'Use Forms' permission, it will display 403 unauthorized page.