FormMessageFields

Introduction

FormMessageFields store the submitted value of each FormField in a FormMessage.

For a related FormField type that stores rich text, the applicable value and request_value fields use the shared Rich Text HTML format.

Model Definition

Alias

formMessageField

Capabilities

• Translations - Localizes value and request_value; examples use en-US.

Relations

Key	Relation	Type	Relation Field(s)
formMessage	FormMessage	Belongs to	form_message_id
formField	FormField	Belongs to	form_field_id

List by Message

List FormMessageFields for one FormMessage.

Definition

GET /api/forms/messages/{formMessage}/fields

Route Parameters

Parameter	Type	Description
formMessage	integer	Form message ID.

Request Keys

Key	Type	Default	Description
selects	string	All fields	Comma-separated fields to return.
relations	string	Default relations	Pipe-separated relations to include.
limit	integer	No limit	Maximum number of fields.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/forms/messages/140/fields', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

[
  {
    "id": 501,
    "form_message_id": 140,
    "form_field_id": 301,
    "lang_id": "en-US",
    "value": "Ada Lovelace",
    "request_value": "Ada Lovelace"
  },
  {
    "id": 502,
    "form_message_id": 140,
    "form_field_id": 302,
    "lang_id": "en-US",
    "value": "Ada Lovelace",
    "request_value": "7"
  }
]

Show by Message and Field

Show one FormMessageField by message and field.

Definition

GET /api/forms/messages/{formMessage}/fields/{formField}

Route Parameters

Parameter	Type	Description
formMessage	integer	Form message ID.
formField	integer	Form field ID.

Request Keys

Key	Type	Default	Description
selects	string	All fields	Comma-separated fields to return.
relations	string	Default relations	Pipe-separated relations to include.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/forms/messages/140/fields/302', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

{
  "id": 502,
  "form_message_id": 140,
  "form_field_id": 302,
  "lang_id": "en-US",
  "value": "Ada Lovelace",
  "request_value": "7"
}