Login
    Contents x
    FormTemplates
    • 15 Jun 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    FormTemplates

    • Updated on 15 Jun 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary


     GET   /FormTemplates

    Get a list of form templates.

    Query Parameters
    ParameterTypeDescription
    form_statusStringForm release status.
    • unreleased
    • released
    • both
    statusStringForm release status.
    • unreleased
    • released
    • both
    sortStringThe name of a data column to sort by.
    sortDirStringSort direction.
    • asc: Ascending order
    • desc: Descending order
    qStringA VisualVault REST API Data Query.


     GET   /FormTemplates/{id}

    Returns a form template by ID.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.
    Query Parameters
    ParameterTypeDescription
    formstatusStringForm release status.
    • unreleased
    • released
    • both
    qStringA VisualVault REST API Data Query.


     GET   /FormTemplates/{id}/forms/{childId}

    Get the child form of a template.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.
    childId*GuidThe child form template id.
    Query Parameters
    ParameterTypeDescription
    fieldsStringList of fields to include.
    fStringList of requested form fields.
    getFieldPropertiesBoolGet properties of the fields.
    expandBoolSet to true to get all the form's fields.
    offsetStringSets an offset to the start of the search.
    limitIntSets a limit to the number of values returned.


     GET   /FormTemplates/{id}/forms/{childId}/PDF

    Retrieve a child form in PDF format.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.
    childId*GuidThe child form template id.


     GET   /FormTemplates/{id}/fields

    Get the form fields of a template.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.


     GET   /FormTemplates/{id}/forms

    Get the form instances of a form template.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.
    Query Parameters
    ParameterTypeDescription
    fieldsStringList of fields to include.
    getFieldPropertiesBoolGet properties of the fields.
    expandBoolSet to true to get all the form's fields.
    sortStringThe name of a data column to sort by.
    sortDirStringSort direction.
    • asc: Ascending order
    • desc: Descending order
    offsetStringSets an offset to the start of the search.
    limitIntSets a limit to the number of values returned.
    qStringA VisualVault REST API Data Query.


     GET   /FormTemplates/{id}/docInfo

    Retrieve the next sequential document ID for the template.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.


     POST   /FormTemplates/{id}/forms

    Create a new form instance from the template.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.
    Body Parameters
    ParameterTypeDescription
    formFields{FieldList}A list of field values to be saved.
    Response Codes
    CodeDescription
    201Created


     POST   /FormTemplates/{id}/forms/{childId}

    Create a new revision of an existing form instance.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe form template id.
    childId*GuidThe form instance id.
    Body Parameters
    ParameterTypeDescription
    formFields{FieldList}A list of field values to be saved.
    Response Codes
    CodeDescription
    201Created


     GET   /formtemplates/scripts/globalscripts

    Get the global scripts for a form template.

    Query Parameters
    ParameterTypeDescription
    hashonlyBoolReturn only a hash code.


     GET   /formtemplates/scripts/templatescripts/{id}

    Get the template scripts for a form template.

    Route Parameters
    ParameterTypeDescription
    id*GuidThe template script id.
    Query Parameters
    ParameterTypeDescription
    hashonlyBoolReturn only a hash code.
    Was this article helpful?
    What's Next
    VisualVault is a cloud-native content platform upon which you can quickly build line-of-business solutions with low-code and no-code apps and existing templates. Or, together, we can create the transformative enterprise solutions you seek as you build a digital-first workplace.

    Login to Document360 view all articles and content.
    Why VisualVault?
    Company
    Platform
    Solutions
    Existing Users
    Connect With Us
    Sales and Support
    Copyright © VisualVault LLC. All Rights Reserved
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    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.
    Logout
    ESC

    Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses