AttributeFieldValidations

Introduction

AttributeFieldValidations are attached to AttributeFields and define how values are validated.

Admin: Create

Create a validation for an attribute field.

Definition

POST /api/administration/additional-attributes/fields/validations

Request Keys

Key	Type	Default	Description
form_field_id*	integer	-	Target AttributeField ID.
form_field_validation_type_id*	string	-	Validation type ID from AttributeFieldValidationTypes.
config	object	type default	Type-specific validation config.

Keys with * are required.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/additional-attributes/fields/validations', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'form_field_id' => 27,
        'form_field_validation_type_id' => 'items-count',
        'config' => [
            'min' => 1,
            'max' => 3
        ]
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 65,
    "form_field_id": 27,
    "form_field_validation_type_id": "items-count",
    "config": {
      "min": 1,
      "max": 3
    }
  }
}

Admin: Update

Update an existing validation.

Definition

PUT /api/administration/additional-attributes/fields/validations/{formFieldValidation}

Route Parameters

Parameter	Type	Description
formFieldValidation	integer	Validation ID.

Request Keys

Key	Type	Description
form_field_id	integer	New target field ID.
form_field_validation_type_id	string	New validation type ID.
config	object	Updated type-specific configuration.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/additional-attributes/fields/validations/65', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'config' => [
            'min' => 2,
            'max' => 5
        ]
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 65,
    "form_field_id": 27,
    "form_field_validation_type_id": "items-count",
    "config": {
      "min": 2,
      "max": 5
    }
  }
}

Admin: Delete

Delete an existing validation.

Definition

DELETE /api/administration/additional-attributes/fields/validations/{formFieldValidation}

Route Parameters

Parameter	Type	Description
formFieldValidation	integer	Validation ID.

Example Request

PHP

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

Example Response

{
  "status": "success",
  "data": {
    "count": 1
  }
}