Forms
  • 24 May 2023
  • 4 Minutes to read
  • Contributors
  • Dark
    Light

Forms

  • Dark
    Light

Article summary


 GET   /Forms/{id}


Returns a form instance by form ID.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
acquirelockString-----
rollbacklockString-----
masteridGuid-----
Response Codes
CodeDescription
200OK


 POST   /Forms/{id}


Updates a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
pageIdGuidID of the page.
Body Parameters
ParameterTypeDescription
fields{FormControlListExample}List of form controls to update and their values.
Response Codes
CodeDescription
200OK
400Bad Request


 POST   /Forms


Creates a new form data instance.

Body Parameters
ParameterTypeDescription
masterIdstringThe master ID.
rrControlIdstringRRC ID.
data{FieldList}The form control data.
fillinMapping{FillinMapping}The fillin mapping data.
Response Codes
CodeDescription
200OK


 POST   /Forms/{id}/NewInstance


Creates a new form data instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form template id.
Body Parameters
ParameterTypeDescription
fields{FormControlListExample}List of form controls to update and their values.
Response Codes
CodeDescription
201Created


 PUT   /Forms/{id}


Saves an existing form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Body Parameters
ParameterTypeDescription
masterIdStringThe master form ID.
rrControlIdStringRRC ID.
dataIdStringThe data ID.
data{FieldList}The form data.
fillinMapping{FillinMapping}The fillin mapping data.
Response Codes
CodeDescription
200OK


 DELETE   /Forms/{id}


Deletes a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
masteridGuid-----
rrcontrolidStringRepeating Row Control ID.


 PUT   /Forms/FillinRelateInfo


Updates fill-in and relate information.

Body Parameters
ParameterTypeDescription
fillinRelateKeyStringUnique key.
formValuesStringList of form values to fill-in.
dhDocId*GuidId of the related form.
formIdGuidThe form ID if this call originates from an Upload Button form control.


 GET   /Forms/FillinRelateInfo


Retrieves fill-in and relate information.

Query Parameters
ParameterTypeDescription
lookupKeyGuid-----
lookupMappingsGuid-----
referFieldIdGuid-----


 GET   /Forms/{id}/RepeatingRowControlData


Retrieve data for a Repeating Row Control.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
rrcIdGuidRepeating Row Control ID.
formTemplateIdGuidForm template ID.
masterTemplateIdGuidMaster template ID. Allows retrieval of specific RRC revisions.
checkNeedsUpgradeBoolDo we need to upgrade the form template?


 POST   /Forms/RepeatingRowControlData


Get all Repeating Row Control data.

Body Parameters
ParameterTypeDescription
formInstanceIdGuidThe form instance ID.
rrcIdGuidThe repeating row control ID.
formTemplateIdGuidThe form template ID.
masterTemplateIdGuidThe master template ID.
checkNeedsUpgradeBoolCheck if the form template needs to upgrade.


 GET   /Forms/{id}/DocumentCount


Returns the number of documents associated with the form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
formControlIdGuidId of the form control requesting the index fields if called from a form.
folderPathStringFolder path tied to the control.
byFolderBoolGet upload counts by folder instead of overall?


 GET   /Forms/{id}/Documents


Get the document count of a specific control or the form instance if no control provided.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
folderIdGuidID of the folder to check.
formControlIdGuidId of the form control requesting the index fields if called from a form.
qStringA VisualVault REST API Data Query.


 POST   /Forms/{id}/documents


Relate a new form document.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Body Parameters
ParameterTypeDescription
documentName*StringName of the document.
description*StringDocument description.
fileName*StringThe name of the file.
revision*StringDocument revision number.
docState*StringState of the document.
  • Unreleased (0)
  • Released (1)
  • Pending (2)
fileData*StringFile data as a base64 string.
folderIdGuidThe folder ID.
formControlIdGuidID of the upload button.
indexFields*{IndexField}Index field names and values as a JSON array or object string.
Response Codes
CodeDescription
500Internal Server Error


 DELETE   /Forms/{id}/documents


Remove a related form document if user is Owner.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
deleteId*Guid-----
formDocId*GuidName of the form to delete.


 GET   /Forms/Menu/{id}/MenuTabs


Get the menu tabs of a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.


 GET   /Forms/Menu/{id}/ChangeLog


Get the change log data for a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.


 GET   /Forms/Menu/{id}/Workflow


Get the form workflow data of a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.


 GET   /Forms/Menu/{id}/Documents


Get the documents associated with a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.


 GET   /Forms/Menu/DocumentContextMenu


Get the context menu properties for a form instance.

Query Parameters
ParameterTypeDescription
dhIdGuidID of the form.
documentIdGuidThe document ID.


 GET   /SearchCriteria


Retrive the form related data search criteria.

Query Parameters
ParameterTypeDescription
fieldListStringList of form fields.
relatedFormNameStringName of the related form.
listTypeStringType of dropdown list query.
  • UserQuery
  • GroupQuery
  • CustomQuery
defaultValueStringDefault value.
enumeratedItemBool-----


 GET   /Forms/Menu/{id}/Forms


Get the related forms of a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.
formTemplateNameStringName of the form template.


 GET   /Forms/Menu/{id}/Revisions


Get the revision information for a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form instance id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.


 GET   /Forms/Menu/{id}/History


Retrieve the history data of a form template.

Route Parameters
ParameterTypeDescription
id*GuidThe form template id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.


 GET   /Forms/Menu/{id}/DashboardByFormId


Get form data dashboard information by form ID.

Route Parameters
ParameterTypeDescription
id*GuidThe form template id.


 GET   /Forms/Menu/{dashboardId}/DashboardById


Get form data dashboard information by dashboard ID.

Route Parameters
ParameterTypeDescription
dashboardId*GuidThe dashboard id.
Query Parameters
ParameterTypeDescription
joinTableStringName of the table to join.
joinLeftColumnIdGuidLeft column ID.
joinOperatorStringOperator comparison type.
  • Equals
  • NotEqual
joinRightColumnNameStringRight column name.
joinTypeStringJoin type.
  • Inner
  • Full
  • Left
  • Right
includeDataBoolInclude the query data?
includeJoinTableListBoolInclude the list of tables and views?


 GET   /Forms/Menu/Dashboards


Get the names and IDs of all form dashboards.

No Parameters.


 PUT   /Forms/Menu/{dashboardId}/DashboardById


Get form data dashboard information by dashboard ID.

Route Parameters
ParameterTypeDescription
dashboardId*GuidThe dashboard id.
Body Parameters
ParameterTypeDescription
joinDefinitionListStringList of join definitions.
queryFieldsStringA list of query fields.
queryFilterStringA query filter.
orderByStringThe column to order by.
pageSizeIntThe number of results per page.
startPageIntThe page number to start from.
endPageIntThe page number to finish with.


 GET   /FormDashboard/{dashboardId}/QueryData


Get the form dashboard query data.

Route Parameters
ParameterTypeDescription
dashboardId*GuidThe dashboard id.
Query Parameters
ParameterTypeDescription
fieldsStringList of fields to include.
qStringA VisualVault REST API Data Query.
orderbyStringColumn to order by.
pageSize*StringNumber of entries for each dashboard page. Default = 15.
startPage*StringPage to start the search.
endPage*StringPage to end the search.


 POST   /FormDashboard/QueryData


Get all form dashboard query data.

Body Parameters
ParameterTypeDescription
controlIdGuidThe control ID.
dashboardIdGuidThe form dashboard ID.
fieldsStringThe field names to retrieve.
qStringThe query.
orderByStringColumn to order by.
pageSizeIntSize of the page results.
startPageIntPage to start.
endPageIntPage to end.


 GET   /FormDashboard/{templateName}/fields


Get the field information for a form dashboard.

Route Parameters
ParameterTypeDescription
templateName*stringThe form template name.


 POST   /FormDashboard/{formTemplateId}/NewDashboard


Create a new form data dashboard.

Route Parameters
ParameterTypeDescription
formTemplateId*GuidThe form template ID.
Body Parameters
ParameterTypeDescription
reportName*StringReport name.
reportOptions{reportOptionWrapper}Report options.
columnListArrayList of columns.
criteriaListArrayList of search criteria.


 PUT   /FormDashboard/{dashboardId}/UpdateDashboard


Update a form data dashboard.

Route Parameters
ParameterTypeDescription
dashboardId*GuidThe dashboard id.
Body Parameters
ParameterTypeDescription
reportNameStringThe name of the report.
reportOptions{reportOptionWrapper}The options for the report.
columnListArrayThe list of columns to update.
criteriaListArrayThe search criteria.


 GET   /Forms/Menu/{mtiId}/CustomDocumentsList


Returns a list of custom filtered documents.

Route Parameters
ParameterTypeDescription
mtiId*GuidThe menu tab item id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.
sortFieldStringField name to sort by.
sortDirStringSort direction.
  • asc: Ascending order
  • desc: Descending order
pageSize*StringNumber of entries for each dashboard page. Default = 15.
startPage*StringPage to start the search.
endPage*StringPage to end the search.


 GET   /Forms/Menu/{queryId}/QueryReportGrid


Get report data by ID.

Route Parameters
ParameterTypeDescription
queryId*GuidThe query id.
Query Parameters
ParameterTypeDescription
qStringA VisualVault REST API Data Query.


 GET   /FormEntity/{id}


Get form entity by ID.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.


 GET   /FormEntity/{id}/page/{pageId}/fieldlist


Get the form entity properties for a provided page.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.
pageId*GuidThe page id.
Query Parameters
ParameterTypeDescription
getlatestBoolGet data from the latest form revision?


 GET   /FormEntity/{id}/basefieldlist


Returns the base form field list.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.


 GET   /FormEntity/{id}/page/{pageId}/fieldlistproperties


Get the field list properties of a page.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.
pageId*GuidThe page id.


 GET   /FormEntity/{id}/getSignatureStamp/{fieldId}


Returns a user signature from a signing canvas.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.
fieldId*GuidThe signature canvas id.


 PUT   /FormEntity/{id}/signSignatureStamp


Signs a signature canvas.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.
Body Parameters
ParameterTypeDescription
dhDocIdStringThe form ID.
fieldIdStringThe ID of the signature stamp.
isCheckedBoolThe checked status of the stamp.
signatureImageDataStringThe image data of the signature.
userpwStringThe user password if required.


 PUT   /FormEntity/{id}/evaluateGroupsAndConditions


Triggers an evaluation of groups and conditions for a form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.
Body Parameters
ParameterTypeDescription
fieldsObjectThe fields to evaluate.
wizardStepObjectWizard Step information.
requestIdStringThe ID of the request.
useLatestTemplateBoolUse the latest revision of the form template?


 PUT   /FormEntity/{id}/setFieldImage


Set the image of a form field.

Route Parameters
ParameterTypeDescription
id*GuidThe form id.
Body Parameters
ParameterTypeDescription
fieldIdStringThe ID of the field to set.
imageIDStringThe ID of the image to apply.


 GET   /Comments/{conversationId}/Form


Get the comments of a Conversation control.

Route Parameters
ParameterTypeDescription
conversationId*GuidThe conversation form control id.


 PUT   /Comments/{conversationId}/Form


Add a comment to an existing Conversation control.

Route Parameters
ParameterTypeDescription
conversationId*GuidThe conversation form control id.
Body Parameters
ParameterTypeDescription
commentSubjectStringThe text to appear as the comment subject.
commentBodyStringThe text to appear inside the comment body.


 DELETE   /Comments/{parentId}/Form/{commentDetailID}


Delete a comment from a Conversation control.

Route Parameters
ParameterTypeDescription
parentId*GuidThe conversation form control id.
commentDetailID*GuidThe comment id.

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy, a generative AI, facilitating knowledge discovery through conversational intelligence