Retrieves the item with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

db_info_field
NameDescriptionTypeAdditional information
id

Primary key

globally unique identifier
db_info_id

Foreign key to db_info (chapters)

globally unique identifier

Optionally required : db_info_id,db_info_code or node db_info must be provided

db_info_code

Embedded entity "db_info" using ERP PK when adding/updating db_info_field

string

Optionally required : db_info_id ,db_info_code or node db_info must be provided

db_info

Embedded entity "db_info" (chapter) when adding/updating db_info_field

db_info

Optionally required : db_info_id,db_info_code or node db_info must be provided

db_input_type_id

Type of the fied (like Textbox,TextArea)

globally unique identifier

Optionally required : db_input_type_id or db_input_type_code must be provided

db_input_type_code

Use of the possible type : TextBox,TextArea,SelectBox,RadioButton,DateTime,NumericField,Checkbox,ComboBox,Email,Url,DatePicker,MonthCalendar,TimePiker,Number

string

Optionally required : db_input_type_id or db_input_type_code must be provided

name

Name/Code of the info field.Field used for Embedded entity (store there your ERP PK)

string

Required

Max length: 50

title

Title that will be shown on the UI of the info field

string

Required

Max length: 50

sequence

Sorting field (0 first), to order them inside the chapter

integer
description

Description of the field

string

Max length: 255

is_mandatory

Force user to fill it before saving

boolean
is_readonly

Avoid user to edit the value using the UI

boolean
hide_in_view_if_empty

Hide this field in view mode if no value

boolean
udf_name

Name of udf column that links to info field (read-only)

string
visible_on_app

Visible this field on app

boolean

Response Formats

application/json, text/json

Sample:
{
  "id": "a1aa6356-5e3c-4330-ab43-0b9ee44f4ffa",
  "db_info_id": "b8ceccc1-265f-447f-9b48-666d145f9b84",
  "db_info_code": "sample string 3",
  "db_info": {
    "id": "e7d99f93-1fa3-44d2-95d7-bb6ad798b5f9",
    "name": "sample string 2",
    "code": "sample string 3",
    "sequence": 4,
    "db_info_category_id": "928d0d6a-cfa2-43c4-94fb-4d46b6c547dc",
    "db_info_category_code": "sample string 6",
    "parent_id": "52c19180-5c0c-4a44-a681-0d77fda6c65f",
    "parent_db_info_code": "sample string 8",
    "modified_dateutc": "2024-09-29T01:23:46.2461779+00:00"
  },
  "db_input_type_id": "b751a3ac-4c66-417e-b9f0-ca9e7450a728",
  "db_input_type_code": "sample string 5",
  "name": "sample string 6",
  "title": "sample string 7",
  "sequence": 8,
  "description": "sample string 9",
  "is_mandatory": true,
  "is_readonly": true,
  "hide_in_view_if_empty": true,
  "udf_name": "sample string 13",
  "visible_on_app": true
}