AttributeFields

Introduction

AttributeFields define the input structure of an AttributeSet.

They use form_type + form_id to reference their container set and support field-specific configuration through config.

Model Definition

Alias

formField

Relations

Relation	Key	Type	Relation Field(s)
AttributeSets	form	Belongs to	form_id, form_type
AttributeFieldTypes	fieldType	Belongs to	form_field_type_id
AttributeFieldValidations	fieldValidations	Has many	form_field_validations.form_field_id

User routes (/api/additional-attributes/...)

List all fields

Definition

GET /api/additional-attributes/fields

Request Keys

No additional request keys.

Example Request

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

Example Response

[
  {
    "id": 27,
    "form_type": "attributeSet",
    "form_id": 11,
    "form_field_type_id": "text",
    "name": "Employee Number",
    "config": {}
  }
]

List fields by set

Definition

GET /api/additional-attributes/sets/{formEntity}/fields

{formEntity} is an AttributeSet ID.

Request Keys

Key	Type	Default	Description
formEntity	integer	-	AttributeSet ID.

Example Request

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

Example Response

[
  {
    "id": 27,
    "form_type": "attributeSet",
    "form_id": 11,
    "form_field_type_id": "text",
    "name": "Employee Number",
    "config": {}
  }
]

Show field

Definition

GET /api/additional-attributes/fields/{formField}

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.

Example Request

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

Example Response

{
  "id": 27,
  "form_type": "attributeSet",
  "form_id": 11,
  "form_field_type_id": "text",
  "name": "Employee Number",
  "config": {}
}

Entity-select helpers

List preselected entities

Definition

POST /api/additional-attributes/fields/{formField}/preselected-entities

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.

No additional JSON body keys are required.

Example Request

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

Example Response

[]

List selectable entities

Definition

POST /api/additional-attributes/fields/{formField}/selectable-entities

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.

No additional JSON body keys are required.

Example Request

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

Example Response

[
  {
    "id": 5,
    "title": "Sales"
  }
]

List selectable-entity filters

Definition

POST /api/additional-attributes/fields/{formField}/selectable-entities/filters

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.

No additional JSON body keys are required.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/additional-attributes/fields/27/selectable-entities/filters', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => []
]);

Example Response

[
  {
    "key": "department",
    "title": "Department"
  }
]

List selectable-entity filter options

Definition

POST /api/additional-attributes/fields/{formField}/selectable-entities/{filterKey}/options

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.
filterKey	string	-	Filter key.

No additional JSON body keys are required.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/additional-attributes/fields/27/selectable-entities/department/options', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => []
]);

Example Response

[
  {
    "key": 5,
    "title": "Sales"
  }
]

[Adm.] routes (/api/administration/additional-attributes/...)

[Adm.] List all fields

Definition

GET /api/administration/additional-attributes/fields

Request Keys

No additional request keys.

Example Request

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

Example Response

[
  {
    "id": 27,
    "form_type": "attributeSet",
    "form_id": 11,
    "form_field_type_id": "text",
    "name": "Employee Number",
    "config": {}
  }
]

[Adm.] List fields by set

Definition

GET /api/administration/additional-attributes/sets/{formEntity}/fields

Request Keys

Key	Type	Default	Description
formEntity	integer	-	AttributeSet ID.

Example Request

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

Example Response

[
  {
    "id": 27,
    "form_type": "attributeSet",
    "form_id": 11,
    "form_field_type_id": "text",
    "name": "Employee Number",
    "config": {}
  }
]

[Adm.] Show field

Definition

GET /api/administration/additional-attributes/fields/{formField}

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.

Example Request

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

Example Response

{
  "id": 27,
  "form_type": "attributeSet",
  "form_id": 11,
  "form_field_type_id": "text",
  "name": "Employee Number",
  "config": {}
}

[Adm.] Create field

Definition

POST /api/administration/additional-attributes/fields

Request Keys

Key	Type	Default	Description
form_type*	string	-	Morph alias of container entity. For attribute fields use attributeSet.
form_id*	integer	-	ID of the related AttributeSet.
form_field_type_id*	string	-	Field type key from AttributeFieldTypes.
lang_id	string	system language	Language key for translated values.
name*	string	-	Field label shown to users.
slug	string	derived from name	Technical slug. Sanitized automatically.
default_value	mixed	null	Static default value.
placeholder	string	null	Placeholder text.
description	string	null	Field description/help text.
hidden	boolean	false	Hide field in UI.
disabled	boolean	false	Disable field input.
config	object	type defaults	Type-specific configuration object.

Keys with * are required.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/additional-attributes/fields', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'form_type' => 'attributeSet',
        'form_id' => 11,
        'form_field_type_id' => 'text',
        'name' => 'Employee Number'
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 27,
    "form_type": "attributeSet",
    "form_id": 11,
    "form_field_type_id": "text",
    "name": "Employee Number",
    "config": {},
    "hidden": false,
    "disabled": false
  }
}

[Adm.] Update field

Definition

PUT /api/administration/additional-attributes/fields/{formField}

Request Keys

Key	Type	Description
formField	integer	Route parameter. ID of the field to update.
form_field_type_id	string	New field type key.
lang_id	string	New language key.
name	string	New field label.
slug	string	New technical slug.
default_value	mixed	New static default value.
placeholder	string	New placeholder text.
description	string	New help text.
hidden	boolean	Update hidden state.
disabled	boolean	Update disabled state.
config	object	Updated type-specific configuration.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/additional-attributes/fields/27', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'name' => 'Employee Number (updated)'
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 27,
    "form_type": "attributeSet",
    "form_id": 11,
    "form_field_type_id": "text",
    "name": "Employee Number (updated)",
    "config": {}
  }
}

[Adm.] Delete field

Definition

DELETE /api/administration/additional-attributes/fields/{formField}

Request Keys

Key	Type	Default	Description
formField	integer	-	Field ID.

Example Request

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

Example Response

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

[Adm.] field-side resources

• AttributeFieldDefaultValueSources

• AttributeFieldValidations

• AttributeFieldDisplayConditions