custom_submission.html

<article class="docs-article" id="Section">
    <section class="docs-section" id="custom_submission">
        <div>


            <h1>Form Adapter</h1>
            <br>
            <hr><br>
            <p>Formsflow.ai supports submission data to be stored and served using external system. This feature can be used for submission datastore to different database than MongoDB. 
                If this feature is enabled MongoDB will be used only for form definition data. 
                A Rest API is needed to support this where customer can add this Rest API to their choice of database and provide the required endpoints. 
                A reference implementation can be found <a href="https://github.com/AOT-Technologies/forms-flow-ai-submissions/tree/develop/forms-flow-submissions" target="_blank">here</a>
            </p>
            
            <p>This feature requires the following env variables set:</p>
            <pre>
                <code>
        #custom submission
        CUSTOM_SUBMISSION_ENABLED=false
        CUSTOM_SUBMISSION_URL=http://{your-ip-address}:{port}
                </code>
            </pre>
            <!-- <ul>
                <li>CUSTOM_SUBMISSION_ENABLED=true
                </li>
                <li>CUSTOM_SUBMISSION_URL=http://{your-ip-address}:{port}</li>
            </ul> -->
            <p>
                Form Adapter uses custom submission URLs to create, submit, get and edit submissions
                within a form to the preferred database. These URLs follow the same URL pattern as the
                formio submission URL.
            </p>
            <h3>Create Custom Form Submission</h3><br>
            <i>POST</i><br>
            <code>{{CUSTOM_SUBMISSION_URL}}/form/<formid>/submission</code><br><br>
            <p>Example of how to create a new form submission within a custom form.</p>

            <h5><b>HEADERS</b>
            </h5>
            <p><b>Authorization Bearer </b>{{token}}
            </p>
            <p><b>Content-Type </b>application/json
            </p>
            <h5><b>BODY</b></h5>
            <pre>
                    <code class="hljs"> <br>                     
                 {
                        "data": {
                            "name": "John",
                            "age": 21,
                            "applicationStatus": "",
                            "applicationId": ""
                        }
                 }
                    </code>
                </pre>
            <h5><b>Response</b></h5>
            <pre>
                    <code>
                        <br>
                        {
                            "created": "2022-08-03 09:32:59.448886",
                            "_id": "04016fac-8811-4762-859b-0c664c2490b5",
                            "form": "62da4ec3e44bcd4da0454ae1",
                            "data": {
                                 "name": "John",
                                 "age": 21,
                                    "applicationStatus": "",
                                    "applicationId": ""
                        
                            },
                            "modified": "2022-08-03 09:32:59.448893"
                        }
                        
                    </code>
                </pre><br>
            <h3>Get a Submission</h3><br>

            <i>GET</i>
            <code>{{CUSTOM_SUBMISSION_URL}}/form/&lt;formid&gt;/submission/&lt;submission_id&gt;&lt;/submission_id&gt;</code><br>
            <br>

            <p>Retrieve a single submission within a form.</p>

            <h5><b>Headers</b></h5>

            <p><b>Authorization Bearer</b> {{token}}</p>
            <p><b>Content-Type</b> application/json</p>

            <h5>Response</h5>
            <pre><code class="hljs"><br>
    {
        "created": "2022-08-03 09:32:59.448886",
        "_id": "04016fac-8811-4762-859b-0c664c2490b5",
        "form": "62da4ec3e44bcd4da0454ae1",
        "data": {
            "name": "John",
            "age": 21,
                "applicationStatus": "",
                "applicationId": ""

                },
            "modified": "2022-08-03 09:32:59.448893"
    }
</code></pre>


            <h3>Update a Submission</h3><br>

            <i>PUT </i>
            <code>{{CUSTOM_SUBMISSION_URL}}/form/&lt;formid&gt;/submission/&lt;submission_id&gt;</code><br><br>

            <p>Update the whole submission.</p>

            <h5><b>HEADERS</b></h5>

            <p><b>Authorization Bearer </b>{{token}}</p>
            <p><b>Content-Type</b> application/json</p>

            <h5><b>BODY</b></h5>
            <pre><code class="hljs"><br>
    {
      "data": {
            "name": "John Joe",
            "age": 22,
            "applicationStatus": "",
            "applicationId": ""
              }
    }
</code></pre>
            <h3>Partial Update a Submission</h3>

            <p><b>PATCH</b></p>
            <code>{{CUSTOM_SUBMISSION_URL}}/form/&lt;formid&gt;/submission/&lt;submission_id&gt;</code><br><br>


            <h5><b>HEADERS</b></h5>

            <p><b>Authorization Bearer</b> {{token}}</p>
            <p><b>Content-Type</b> application/json</p>

            <h5><b>BODY</b></h5>
            <pre><code class="hljs"><br>
    {
      "data": {
          "applicationStatus": "New",
          "applicationId": "1234"
              }
    }
</code></pre>
<p><strong>NOTE</strong>: In case of reviewer actions, if submission data need to be updated directly from the form, call customSubmissionUrl instead of formio. 
</p>
<img src="./assets/images/formadapter1.png" width="800"></img>
<br><br><br>
<img src="./assets/images/formadapter2.png" width="400" height="500"></img>

        </div>
    </section>
</article>
<script>hljs.initHighlighting();</script>