module:api/FormManagementApi

module:api/FormManagementApi

new module:api/FormManagementApi(apiClient)

Source:

Constructs a new FormManagementApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

getForm(accountId, formId, optsOrCallback, callback)

Source:

Get Form
Retrieves form information filter by form id and state. The state parameter is optional and can accept value from draft, active.

Parameters:
Name Type Description
accountId String

Account identifier in which the web form resides
formId String

Unique identifier for a web form that is consistent for it's lifetime
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
state module:model/String

The state of the web form configuration (default to draft)
callback module:api/FormManagementApi~getFormCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/WebForm

listForms(accountId, optsOrCallback, callback)

Source:

List Forms
List all the forms for the active user that can be in an active or draft state

Parameters:
Name Type Description
accountId String

Account identifier in which the webform resides
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
userFilter module:model/String

Filter which forms are returned (default to all)
isStandalone Boolean

Is the form a standalone form
isPublished Boolean

Has the form been published
sortBy String

Sort result set in mentioned sort property:order. Default is lastModifiedDateTime:desc. Default sort is descending if not mentioned.
search String

Search through form names
startPosition String

Starting position for desired page of results.
count String

Number of results to return per page.
callback module:api/FormManagementApi~listFormsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/WebFormSummaryList

Type Definitions

getFormCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getForm operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/WebForm

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listFormsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listForms operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/WebFormSummaryList

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.