getSubmittedForms Procedure

Use the getSubmittedForms procedure to query submitted forms from the current business day, filtered by activity, inventory, resource, or label, and open specific submissions using open_form_submit mode. This allows plugins to reference completed forms for reasons such as, review or reporting, closing the loop on workflows like validations. It filters to the recent submissions for performance. The purpose is to provide visibility into mobile worker actions, enabling plugins to display summaries or trigger follow-ups without server queries.

The procedure filters submitted forms based on any combination of the following optional fields: activityId, inventoryId, resourceInternalId, and formLabel.

Input parameters (procedureData.params):

Name	Type	Description
resourceInternalId	String	Specifies the Resource for the form page
activityId	String	Specifies the Activity for the form page
inventoryId	String	Specifies the Inventory for the form page
formLabel	String	Specifies the Form label

Response:

Returns a list of submitted forms, filtered according to the provided parameters. Each item has the following structure:

Name	Type	Description
formSubmitId	String	Unique identifier of the form submission
submittedAt	String	Date and time when the form was submitted (in user's locale)
formLabel	String	Short textual label of the form
formTitle	String	Full title of the form (in user's language) as displayed to the user
userName	String	Name of the user who submitted the form
resourceInternalId	String	Resource for the form page
activityId	String | null	Activity for the form page
inventoryId	String | null	Inventory for the form page

Example:

{
 "apiVersion": 1,
 "method": "callProcedure",
 "callId": "%%uniqueId%%",
 "procedure": "getSubmittedForms",
 "params": {
 "formLabel": "",
 "resourceInternalId": "",
 "activityId": "",
 "inventoryId": ""
 }
}

Response:

{
 "apiVersion": 1,
 "method": "callProcedureResult",
 "callId": "HRW9sTJ1dmHkBvmaRWP8Eg",
 "procedure": "getSubmittedForms",
 "resultData": [
 {
 "formSubmitId": "135",
 "submittedAt": "09/04/25 11:03",
 "formLabel": "Asset_validation",
 "formTitle": "Asset validation",
 "userName": "BRC.ROOT",
 "resourceInternalId": "18370",
 "activityId": "8769614",
 "inventoryId": "26030119"
 },
 {
 "formSubmitId": "136",
 "submittedAt": "09/04/25 11:03",
 "formLabel": "Asset_inspection",
 "formTitle": "Asset inspection",
 "userName": "BRC.ROOT",
 "resourceInternalId": "18370",
 "activityId": "8769614",
 "inventoryId": "26030118"
 }
 ]
}

Open a Specific Submitted Form

The open_form_submit mode allows a plugin to immediately display a previously saved form submission. Instead of opening a blank form or a default view, the plugin can use this mode to pull up the exact data set you need to review or continue editing.

Name	Type	Description
backFormSubmitId	String	Unique identifier of the form submission

Example:

{

"apiVersion": 1,

"method": "close",

"backScreen": "open_form",

"backFormLabel": "Asset_inspection",

"backActivityId": "8769614",

"backInventoryId": "26030118"

}