AttributeFieldDefaultValueSources

Introduction

AttributeFieldDefaultValueSources define how an AttributeField gets a prefilled value.

[Adm.] Create

Create a default value source for an attribute field.

Definition

POST /api/administration/additional-attributes/fields/default-value-sources

Request Keys

Key	Type	Default	Description
source_type*	string	-	Source type. Allowed values: formFieldValue, systemVariable.
form_field_id*	integer	-	Target AttributeField ID.
config	object	type default	Source-specific configuration.
source_entity_type	string | null	null	Morph alias for source entity (for field value sources typically formField).
source_entity_id	integer | null	null	Source entity ID (required with source_entity_type).
sort_number	integer	auto	Evaluation order inside one form_field_id.

Keys with * are required.

config by source_type

• formFieldValue

  • no required config keys

• systemVariable

  • variable_key (required)

  • variable_filter (optional, formatter key)

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/additional-attributes/fields/default-value-sources', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'form_field_id' => 27,
        'source_type' => 'systemVariable',
        'config' => [
            'variable_key' => 'system.user',
            'variable_filter' => 'format_user_name'
        ]
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 41,
    "form_field_id": 27,
    "source_type": "systemVariable",
    "config": {
      "variable_key": "system.user",
      "variable_filter": "format_user_name"
    },
    "source_entity_type": null,
    "source_entity_id": null,
    "sort_number": 1
  }
}

[Adm.] Update

Update an existing default value source.

Definition

PUT /api/administration/additional-attributes/fields/default-value-sources/{defaultValueSource}

Request Keys

Key	Type	Description
source_type	string	New source type (formFieldValue, systemVariable).
form_field_id	integer	New target field ID.
config	object	Source-specific configuration.
source_entity_type	string | null	New source entity type.
source_entity_id	integer | null	New source entity ID.
sort_number	integer	New evaluation order.

Example Request

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/additional-attributes/fields/default-value-sources/41', [
    'headers' => ['Authorization' => "Bearer {accessToken}"],
    'json' => [
        'source_type' => 'formFieldValue',
        'source_entity_type' => 'formField',
        'source_entity_id' => 27
    ]
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 41,
    "form_field_id": 27,
    "source_type": "formFieldValue",
    "config": {},
    "source_entity_type": "formField",
    "source_entity_id": 27,
    "sort_number": 1
  }
}

[Adm.] Delete

Delete an existing default value source.

Definition

DELETE /api/administration/additional-attributes/fields/default-value-sources/{defaultValueSource}

Request Keys

No additional request keys.

Example Request

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

Example Response

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