Form Publishing REST API

Form Publishing REST API

Overview

The Forms and Regions REST API services allows you to get information on the Form Templates for your company.

Base URL 
https://fieldconnect.field2base.com/v2/api

Header (Required)
Authorization: Basic {CompanyID}:{Username}:{Password}
Content-Type: multipart/form-data

Info
Note: Authorization Header above is DIFFERENT than most other Mobile Forms REST API calls due to the Content-Type not being application/json. 
Info
Note: The Authorization Header supports including the API Sync Key (Basic {CompanyID}:{Username}:{Password}:{API Sync Key}) in all Mobile Forms REST API calls. 
InfoNote: API Developers can use OAuth 2.0 Authentication instead of the Basic Authentication. The OAuth 2.0 Authentication uses the Client Credentials Grant Type and requires the Company have a Client ID and a Client Secret generated in the Mobile Forms Portal to make web service calls to the REST API Endpoints. You can contact the Professional Services team at f2bps@field2base.com to implement OAuth 2.0 Authentication.

Supported Operations

  1. POST forms/
    1. Publish a Form Template
    2. Optional parameters are available

API Samples

Publish Form

Method: POST
  1. https://fieldconnect.field2base.com/v2/api/forms/

Body
  1. {
  2.     "file": "Timesheet.eform",
  3.     "projKey": "ea2d6b46-5273-4df4-9cb3-45fb2404bac9" // Optional - leave blank or do not include the key to publish Companywide Form Templates
  4. }
Response: 200 OK
  1. [   
  2.     {
  3.         "TemplateId": "d65fab25-9a8c-4314-aad6-457c311de469",
  4.         "Name": "Timesheet",
  5.         "ProjKey": "ea2d6b46-5273-4df4-9cb3-45fb2404bac9",
  6.         "ProjName": "Timesheets",
  7.         "Version": 2,
  8.         "Description": "",
  9.         "RevisionNumber": 1
  10.     }
  11. ]


    • Popular Articles

    • Mobile Forms iOS Install Via the Apple App Store

      Tutorial Video A tutorial video is also available and covers most of this material if you prefer to watch an overview of how to install the app. Accessing the Apple App Store There should be an icon for the Apple App Store on the home screen of your ...

    • Forms Designer Quick Start Guide

      Overview Field2Base Forms Designer is the proprietary software application that allows your existing paper forms to be quickly converted to a smart E-form available to your end users via our mobile and web-based Mobile Forms applications. This ...

    • Portal 11.28.2023 Release Notes

      Overview Our release notes offer brief descriptions of product enhancements and bug fixes. We include links to the current articles for any affected features. Those articles will be updated shortly after the Portal release to include new ...

    • Integration Service Configuration Guide

      How To Configure Integration Services To Allow Read/Write Access on a Network Path All of our Integration Products, including the DIM, DUU, and EDM have respective Windows Services responsible for communicating with our server. Occassionally, ...

    • Data Integration Module (DIM) Migration Guide

      Overview This article provides the information necessary to migrate the Field2Base Data Integration Module (DIM) over from one server to another. Please refer to the DIM Install Guide for the initial installation of the Field2Base DIM. Once that's ...