FormFieldDisplayConditions

Introduction

FormFieldDisplayConditions attach conditional visibility rules to FormFields.

Model Definition

Alias

formFieldDisplayCondition

Admin: Create

Create a new FormFieldDisplayCondition.

Definition

POST /api/administration/forms/fields/display-conditions

Request Keys

Key	Type	Default	Description
attachable_type*	string	-	Supported morph alias. Use formField for a form field.
attachable_id*	integer	-	ID of the entity receiving the condition.

Keys with * are required.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/forms/fields/display-conditions', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'attachable_type' => 'formField',
        'attachable_id' => 33
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 77,
    "attachable_type": "formField",
    "attachable_id": "33",
    "condition_groups": [],
    "single_conditions": []
  }
}

Admin: Update

Update an existing FormFieldDisplayCondition.

Definition

PUT /api/administration/forms/fields/display-conditions/{formFieldDisplayCondition}

Route Parameters

Parameter	Type	Description
formFieldDisplayCondition	integer	Display condition ID.

Request Keys

Key	Type	Default	Description
attachable_type	string	Current value	New supported morph alias.
attachable_id	integer	Current value	New attachable entity ID.

Behavior

When changing the attachment, provide both values so the morph type can be resolved against the new entity.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/forms/fields/display-conditions/77', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'attachable_type' => 'formField',
        'attachable_id' => 34
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 77,
    "attachable_type": "formField",
    "attachable_id": "34",
    "condition_groups": [],
    "single_conditions": []
  }
}

Admin: Delete

Delete an existing FormFieldDisplayCondition.

Definition

DELETE /api/administration/forms/fields/display-conditions/{formFieldDisplayCondition}

Route Parameters

Parameter	Type	Description
formFieldDisplayCondition	integer	Display condition ID.

Example Request

PHP

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

Example Response

{
  "status": "success",
  "data": null
}