How to Use Form Identifiers in an App‑to‑App Call

Different identifiers apply at different stages in a workflow. When you build an App‑to‑App request, you must use valid combinations of identifier and location (Forms, Inbox, Drafts, or Search).

Available on all tiers:

Essentials
Advanced
Enterprise

As a form progresses through a workflow, it moves from one location (“list” or “tab”) on the TrueContext Mobile App to another. For example, a user can open a form from the Forms list, add information, and then save it to Drafts.

The following table describes the location-identifier combinations at various stages in a form’s workflow.

Form stage Location on the TrueContext Mobile App Identifiers to use in an App‑to‑App request Description
Saved and deployed by a form designer Forms formID

Identifies the form. In an App‑to‑App request, this is the most recently deployed version of the form.
formIterationID

Identifies the form and version of the form.
Dispatched Inbox dataRecordID

Identifies the form based on the ID assigned by the TrueContext server.
Dispatched, opened, and saved
Sent for edit
Sent for edit, opened, and saved
Opened for edit from the Sent box, and saved
Opened from the Forms box and saved as a draft Drafts clientDataRecordID

Identifies the saved form by the ID assigned by the TrueContext Mobile App.

Tip:The only way to get the clientDataRecordID is to send an App‑to‑App request that includes an x-success callback parameter (supported on the Advanced and Enterprise tiers).
Sent (complete) Search N/A

The search action searches the text of the form submission name only.

Note:“Incomplete” applies only to teams on the Enterprise tier with TrueContext TeamworkClosed TrueContext Teamwork is an Enterprise tier feature that enables mobile users to transfer incomplete forms for other users to complete as part of a multi-user workflow. This can be useful for jobs that require someone else's expertise or that span multiple shifts.-enabled forms.
Sent (incomplete)