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

Append to the Base URL: https://fieldconnect.field2base.com/v2/api
  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. ]