GET api/forms?f_node={f_node}&start={start}&count={count}&includeAccessLevel={includeAccessLevel}&orderBy={orderBy}&filterText={filterText}&filterBy={filterBy}&filterExact={filterExact}&filterStatus={filterStatus}&viewID={viewID}&customFields={customFields}&includeSubs={includeSubs}&metaFilters={metaFilters}

Returns a list of Forms

Request Information

URI Parameters

NameDescriptionTypeAdditional information
f_node

the unique id of the location to look for forms

integer

None.

start

The start index for the result set, used if are returning forms in pages etc. to limit result set

integer

None.

count

How many projects to return, note that this counts the parent forms so the total number including sub projects may be much higher.

integer

None.

includeAccessLevel

Return the level of access the current user has to this form

boolean

None.

orderBy

Order to return projects in, options are "item" (which is default and ordes by project name), "createdTime", "startDate" or "endDate"

string

None.

filterText

Limits forms to those which contain this text in the form name

string

None.

filterBy

The filterText will search this field when returning forms, name is default but a form field GUID can be supplied

string

None.

filterExact

If true, perform an exact search for filterText. If false, perform an 'includes' search.

boolean

None.

filterStatus

Limits projects to those with this status

string

None.

viewID

A view is setup in the Database and specifies the relevant columns to return, passing the view id will return the relevent columns to populate this view

integer

None.

customFields

List of custom fields to include in the result set, this will be added to the fields included in the view if a view was specified. This should be supplied in a specific JSON format

string

None.

includeSubs

Include forms that aren't at the top level when searching for a match

boolean

None.

metaFilters

Apply one or more filters against meta data. This should be supplied in a specific JSON format

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Dictionary of Object [key] and Object [value]

Response Formats

application/json, text/json

Sample:

Sample not available.