ApiObjectProperties
Definition of an object schema property, including property name, schema constraints, requirement status, access mode, nullability, and deprecation status.
{
"access_mode": "string",
"deprecated": false,
"name": "string",
"nullable": false,
"required": false,
"schema": {
"max_value": "number",
"min_value": "number",
"schema_ref": "string",
"string_enum_values": [
"string"
],
"string_format": "string",
"string_max_length": 0,
"string_min_length": 0,
"string_pattern": "string",
"type": "string"
}
}Access mode for this property. Determines whether the property is read-write, read-only, or write-only. Enum options - API_PROPERTY_ACCESS_READ_WRITE, API_PROPERTY_ACCESS_READ_ONLY, API_PROPERTY_ACCESS_WRITE_ONLY. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Marks this property as deprecated. Requests containing this property are treated as a schema violation. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Property name. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
When true, this property accepts a null value in addition to its declared type. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Marks this property as required within its parent object schema. A request body object missing this property is treated as a violation. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.
Schema specification for scalar types, arrays, or schema references, defining data types and validation constraints for non-object properties.