Retrieves the info field definition with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The info field id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the info field definition, or 404 Not Found if it doesn't exist.
db_info_field| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier | |
| db_info_id |
Foreign key of the chapter this field belongs to. |
globally unique identifier | |
| db_input_type_id |
Foreign key of the constant defining this field's input type (e.g. textarea, datetime), controlling how it is rendered and validated. |
globally unique identifier | |
| sequence |
Order field, need to order by sequence asc |
integer | |
| title |
The label of the field |
string |
Max length: 100 |
| default_value |
Contains the value that should be used when no value exists |
string |
Max length: 255 |
| is_readonly |
Avoid user to edit the value using the UI |
boolean | |
| is_mandatory |
Indicates a value must be filled in for this field before the form can be saved. |
boolean | |
| reference_db_info_field_id |
Foreign key of another info field this field references (e.g. for computed/derived fields). |
globally unique identifier | |
| visible_on_app |
Indicates whether this field is shown to technicians in the mobile app. |
boolean | |
| udf_name |
When set, the name of the udf_ column (on the parent entity) this field's value is stored in, instead of a row in . |
string |
Max length: 20 |
| archived |
Indicates whether this field has been archived (no longer shown). |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "392b2b2c-b6ea-4884-8fba-4680bbbfb1d2",
"db_info_id": "f7d78ef6-7cce-439c-a174-60cf7aa44148",
"db_input_type_id": "418b780c-129d-4863-a712-7eeae2500255",
"sequence": 4,
"title": "sample string 5",
"default_value": "sample string 6",
"is_readonly": true,
"is_mandatory": true,
"reference_db_info_field_id": "592fbda7-887f-41ef-8039-f7e825867ab4",
"visible_on_app": true,
"udf_name": "sample string 11",
"archived": true,
"modified_dateutc": "2026-11-12T14:28:50.33843+00:00"
}
application/xml, text/xml
<db_info_field xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <archived>true</archived> <db_info_id>f7d78ef6-7cce-439c-a174-60cf7aa44148</db_info_id> <db_input_type_id>418b780c-129d-4863-a712-7eeae2500255</db_input_type_id> <default_value>sample string 6</default_value> <id>392b2b2c-b6ea-4884-8fba-4680bbbfb1d2</id> <is_mandatory>true</is_mandatory> <is_readonly>true</is_readonly> <modified_dateutc>2026-11-12T14:28:50.338Z</modified_dateutc> <reference_db_info_field_id>592fbda7-887f-41ef-8039-f7e825867ab4</reference_db_info_field_id> <sequence>4</sequence> <title>sample string 5</title> <udf_name>sample string 11</udf_name> <visible_on_app>true</visible_on_app> </db_info_field>