Skip to main content

PropertyValueSuggestion

The definition of an automatic value.

NameDescriptionType
property_definition_idThe property definition ID.number
valueThe typed value.TypedValue
display_valueDisplay value for the suggestion. Can be empty.string
confidenceThe projected quality of the suggestion.number
is_factTrue if the suggestion is a fact (i.e. known to be valid for sure).boolean
is_new_value_list_itemTrue if the suggestion depicts a new value for value lists.boolean
new_value_list_item_property_suggestionsSuggestions that should be used when new object is created with this suggestion.PropertyValueSuggestion[]
reasonRationale explaining why the suggestion is being made. Can be empty.string

Example

{
"property_definition_id": 0,
"value": {
"is_null_value": false,
"type": 15 /* Enum: Datatype */,
"data": {
"acl": {
"checked_out_to_user": 0,
"is_fully_authoritative": false,
"custom_component": {
"named_acl_id": 0,
"has_named_acl": false,
"current_user_id": 0,
"has_current_user": false,
"permissions": [] /* Array of AccessControlEntry */,
"overridability_permissions": [] /* Array of AccessControlEntry */,
"status": {
"all": false,
"deleted": false,
"source_item_linked_via_pseudo_users": false
}
},
"restrictive_components": [] /* Array of AccessControlListComponentMapEntry */,
"secondary_access_control_list": {} /* AccessControlList */,
"additive_components": [] /* Array of AccessControlListComponentMapEntry */
}
}
},
"display_value": "<display value>",
"confidence": 0,
"is_fact": false,
"is_new_value_list_item": false,
"new_value_list_item_property_suggestions": [] /* Array of PropertyValueSuggestion */,
"reason": "<reason>"
}