Create Custom Property
DevelopingPOST/v1/custom_properties/Request
Body Params application/json
key
string
required
inheritance_key
string | null
optional
name
string
required
active
boolean
optional
default_value
string | null
optional
nullable
boolean
optional
model
enum<string>
required
Allowed values:
orgproduction_runorg_partstock_lotstock_locationorg_supplierpurchasepurchase_linepurchase_no_part_linepurchase_requestbom_linebomusershipmentshipment_line
visibility
array[string]
required
Allowed values:
new_record_dialogedit_record_dialogdatagrid_editdatagrid_read_onlyinfo_sectiondetail_sidebarwarehouse
data_type
enum<string>
required
Allowed values:
stringnumberdatedatetimeuserbooleansingle_choicemulit_choice
values
array [object {4}]
optional
id
string <uuid>
required
value
string
required
label
string
required
metadata
object | null
required
Example
{
"key": "string",
"inheritance_key": "string",
"name": "string",
"active": true,
"default_value": "string",
"nullable": true,
"model": "org",
"visibility": [
"new_record_dialog"
],
"data_type": "string",
"values": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"value": "string",
"label": "string",
"metadata": {}
}
]
}Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
array of:
id
string <uuid>
required
key
string
required
inheritance_key
string | null
required
name
string
required
active
boolean
required
default_value
string | null
required
nullable
boolean
required
model
enum<string>
required
Allowed values:
orgproduction_runorg_partstock_lotstock_locationorg_supplierpurchasepurchase_linepurchase_no_part_linepurchase_requestbom_linebomusershipmentshipment_line
visibility
array[string]
required
Allowed values:
new_record_dialogedit_record_dialogdatagrid_editdatagrid_read_onlyinfo_sectiondetail_sidebarwarehouse
data_type
enum<string>
required
Allowed values:
stringnumberdatedatetimeuserbooleansingle_choicemulit_choice
values
array [object {4}]
required
id
string <uuid>
required
value
string
required
label
string
required
metadata
object | null
required
Example
[
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"key": "string",
"inheritance_key": "string",
"name": "string",
"active": true,
"default_value": "string",
"nullable": true,
"model": "org",
"visibility": [
"new_record_dialog"
],
"data_type": "string",
"values": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"value": "string",
"label": "string",
"metadata": {}
}
]
}
]Last modified: 4 months ago