Appearance
FormMessageFields
Introduction
FormMessageFields
represent the input values for FormFields that are sent when a User submits a Form.
Every submitted Form will have a set of FormMessageFields
as value representations according to the defined FormFields when saved.
The values of FormMessageFields
result in a FormMessage after processing, which is then sent via E-Mail.
Model & Relations
Namespace
Modules\Forms\Entities\FormMessageField
Relations
Relation | Key | Type | Relation Field(s) |
---|---|---|---|
FormField | formField | Belongs to | form_field_id |
FormMessage | formMessage | Belongs to | form_message_id |
List
Get a list of all FormMessageFields
.
Definition
GET /api/forms/messages/fields
Example Request
php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/forms/messages/fields', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
json
[
{
"id": 8,
"form_message_id": 4,
"form_field_id": 2,
"value": "https://intratool.de",
"request_value": "https://intratool.de",
"created_at": "2019-01-25 14:18:05",
"updated_at": "2019-01-25 14:18:05"
},
{
"id": 9,
"form_message_id": 4,
"form_field_id": 3,
"value": "accusam et",
"request_value": "accusam-et",
"created_at": "2019-01-25 14:18:05",
"updated_at": "2019-01-25 14:18:05"
},
{
"id": 10,
"form_message_id": 4,
"form_field_id": 1,
"value": "--",
"request_value": null,
"created_at": "2019-01-25 14:18:05",
"updated_at": "2019-01-25 14:18:05"
},
{
"id": 11,
"form_message_id": 5,
"form_field_id": 2,
"value": "https://intratool.de",
"request_value": "https://intratool.de",
"created_at": "2019-01-25 14:19:25",
"updated_at": "2019-01-25 14:19:25"
},
{
"id": 12,
"form_message_id": 5,
"form_field_id": 3,
"value": "congue nihil",
"request_value": "congue-nihil",
"created_at": "2019-01-25 14:19:25",
"updated_at": "2019-01-25 14:19:25"
}
]
List by Message
Get a list of FormMessageFields
by FormMessage.
Definition
GET /api/forms/messages/{id}/fields
Example Request
php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/forms/messages/5/fields', [
'headers' => ['Authorization' => "Bearer {accessToken}"]
]);
Example Response
json
[
{
"id": 11,
"form_message_id": 5,
"form_field_id": 2,
"value": "https://intratool.de",
"request_value": "https://intratool.de",
"created_at": "2019-01-25 14:19:25",
"updated_at": "2019-01-25 14:19:25",
"form_field": {
"id": 2,
"form_id": 1,
"form_type": "form",
"form_field_type_id": "text",
"name": "Field-1",
"key": "field-1",
"default_value": "",
"placeholder": null,
"description": null,
"config": {},
"sort_number": 1,
"created_at": "2019-01-22 10:44:30",
"updated_at": "2019-01-24 14:43:41",
"field_validation_string": "url",
"field_validations": [
{
"id": 3,
"form_field_id": 2,
"form_field_validation_type_id": "url",
"config": {},
"created_at": "2019-01-25 13:35:35",
"updated_at": "2019-01-25 13:35:35",
"validation_string": "url",
"form_field_validation_type": {
"id": "url",
"default_config": {},
"sort_number": 3,
"created_at": "2019-01-21 00:00:00",
"updated_at": "2019-01-21 00:00:00"
}
}
]
}
}
]
Get
Get a single FormMessageField
by the related FormMessage and id
.
Definition
GET /api/forms/messages/{formMessageId}/fields/{id}
Example Request
php
$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
Example Response
json