Workflow REST API

Workflow REST API

Overview

The Workflow REST API allows Customers the ability to manage Forms currently in Workflow in the Field2Base system.

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

Header (required)
Authorization: Basic {CompanyID}:{Username}:{Password}:{API Sync Key}
Content-Type: application/json
Note: Authorization Header is the standard for all F2B REST API calls.

F2B API Prerequisites

To use the Workflow REST API, you need the following:
  1. An API Sync Key  for the Company
  2. A User Account with the ability to submit to the API (Mobile Forms Administrator role)

Supported Operations

The following operations are supported by the REST web service.
Append to the Base URL (https://fieldconnect.field2base.com/v2/api) 

Endpoint
Method
Description
workflows/{reference number}
GET
Get following details for a Form in Workflow

workflows/email/{reference number}
POST
E-Mail a PDF of the Form in Workflow using the Sent Form's REF# and the Recipient List / E-Mail Subject Name
workflows/reassign/{reference number}/{username}
POST
Re-Assign a Form in Workflow using the Sent Form's REF# and assign to the provided Username
workflows/reassigntogroup/{reference number}/{group name}
POST
Re-Assign a Form in Workflow using the Sent Form's REF# and assign to the provided Group Name
workflows/restart/{reference number}
POST
Restart a Form in Workflow using the Sent Form's REF# 
workflows/resume/{reference number}
POST
Resume a Form in Workflow using the Sent Form's REF#
workflows/cancel/{reference number}
DEL


Note: Be sure to add "/" at the end of the call if there is a period in the Username or Group Name.

API Samples

Get Form Details

Request: GET
  1. https://fieldconnect.field2base.com/v2/api/workflows/{reference number}

Response: 200 OK
  1. {
  2.     "Status": "Under Review",
  3.     "User": null,
  4.     "Group": "Invoice Numbering Group",
  5.     "FormTemplateName": "Sample Expense Report",
  6.     "FormTitleSubject": "Sample Expense Report - Mary 2/21/2021 - 2/28/2021",
  7.     "Folder": "Form Library",
  8.     "LastModifiedDate": "2021-02-24T10:55:28.7114097",
  9.     "LastModifiedBy": "mary.morvan@field2base.com",
  10.     "StartedDate": "2021-02-24T10:55:28.6284035"
  11. }


E-Mail a PDF of a Form in Workflow

Request: POST
  1. https://fieldconnect.field2base.com/v2/api/workflows/email/{reference number}
Body
  1. {
  2. "RecipientEmails" : ["joe.shmo@domain.com"],
  3. "CustomSubject" : "Custom Subject Test"
  4. } 


Re-Assign a Form to a new User in Workflow

Request: POST
  1. https://fieldconnect.field2base.com/v2/api/workflows/reassign/{reference number}/{username}/


Re-Assign a Form to a new Group in Workflow

Request: POST
  1. https://fieldconnect.field2base.com/v2/api/workflows/reassigntogroup/{reference number}/{group name}/


Restart a Form in Workflow

Request: POST
  1. https://fieldconnect.field2base.com/v2/api/workflows/restart/{reference number}

Resume a Form in Workflow

Request: POST
  1. https://fieldconnect.field2base.com/v2/api/workflows/resume/{reference number}


Cancel a Form in Workflow

Request: DEL
  1. https://fieldconnect.field2base.com/v2/api/workflows/cancel/{reference number}

    • Popular Articles

    • Forms Designer Quick Start Guide

      Overview Field2Base Forms Designer is the proprietary software application that allows your existing Forms to be quickly converted to an active, online, smart Form available to your end users via our Mobile Device and Web-based Applications. This ...

    • 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 ...

    • Mobile Forms iOS Enterprise App Upgrade to the Mobile Forms iOS App Store

      Overview This guide will review how to switch between two versions of the Mobile Forms app, uninstalling the Enterprise build and installing the App Store Build. The primary benefits of switching over are that updates to the App Store build are ...

    • How to Check the Version of Integration Products Running on a Windows 10 Machine

      Right-click on the Start menu button. Click on Apps & Features. In the Apps & Features search bar type in the Integration Product you are looking for, eg. F2B Data Integration Module, F2B Data Upload, or F2B Enterprise Dispatch Module. Click to ...