module:api/FormInstanceManagementApi

new module:api/FormInstanceManagementApi(apiClient)

Source:

api/FormInstanceManagementApi.js, line 41

Constructs a new FormInstanceManagementApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

createInstance(accountId, formId, createInstanceBody, callback)

Source:

api/FormInstanceManagementApi.js, line 71

Creates an instance of the web form
Creates an instance of the web form.

Parameters:

Name	Type	Description
`accountId`	String	Account identifier in which the web form resides
`formId`	String	Unique identifier for a web form entity that is consistent for it's lifetime
`createInstanceBody`	module:model/CreateInstanceRequestBody	Request body containing properties that will be used to create instance.
`callback`	module:api/FormInstanceManagementApi~createInstanceCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/WebFormInstance`

getInstance(accountId, formId, instanceId, callback)

Source:

api/FormInstanceManagementApi.js, line 136

Get form instance
Retrieves instance information filter by instance id

Parameters:

Name	Type	Description
`accountId`	String	Account identifier in which the web form resides
`formId`	String	Unique identifier for a web form entity that is consistent for it's lifetime
`instanceId`	String	Unique identifier for a Web Form Instance that is consistent until its expiration
`callback`	module:api/FormInstanceManagementApi~getInstanceCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/WebFormInstance`

listInstances(accountId, formId, optsOrCallback, callback)

Source:

api/FormInstanceManagementApi.js, line 203

List instances
List all the instances of a web form in an account. When filtered by clientUserId, it will return instances having same clientUserId

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
`clientUserId`	String	A unique identifier for a user that should originate from client's system. This value can be anything your backend system would use to track individual form instances. Examples include employee IDs, email addresses, surrogate key values, etc.

callback

module:api/FormInstanceManagementApi~listInstancesCallback

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

refreshToken(accountId, formId, instanceId, callback)

Source:

api/FormInstanceManagementApi.js, line 271

Refreshes the instance token
Generates new instance token for the existing Web Form Instance.

Parameters:

Name	Type	Description
`accountId`	String	Account identifier in which the web form resides
`formId`	String	Unique identifier for a web form entity that is consistent for it's lifetime
`instanceId`	String	Unique identifier for a Web Form Instance that is consistent until its expiration
`callback`	module:api/FormInstanceManagementApi~refreshTokenCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/WebFormInstance`

Type Definitions

createInstanceCallback(error, data, If)

Source:

api/FormInstanceManagementApi.js, line 54

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/WebFormInstance	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.

getInstanceCallback(error, data, If)

Source:

api/FormInstanceManagementApi.js, line 119

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/WebFormInstance	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.

listInstancesCallback(error, data, If)

Source:

api/FormInstanceManagementApi.js, line 185

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/WebFormInstanceList	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.

refreshTokenCallback(error, data, If)

Source:

api/FormInstanceManagementApi.js, line 254

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

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/WebFormInstance	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.