ApiSchema

ApiSchema
ApiSchema

Reusable schema definition for complex data structures (objects or arrays) referenced across multiple API endpoints for payload validation.

JSON Example 
{
    "_last_modified": "string",
    "additional_object_key_action": "string",
    "additional_properties_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"
    },
    "allow_additional_properties": false,
    "array_item_type": {
        "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"
    },
    "composite_types": [
        {
            "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"
        }
    ],
    "description": "string",
    "discriminator": {
        "mapping": [
            {
                "discriminator_key": "string",
                "schema_ref": "string"
            }
        ],
        "property_name": "string"
    },
    "max_items": 0,
    "min_items": 0,
    "name": "string",
    "object_properties": [
        {
            "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"
            }
        }
    ],
    "source": "string",
    "tenant_ref": "string",
    "type": "string",
    "unique_items": false,
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Read-Only  

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
additional_object_key_action
Optional
Constraints: default: API_ACTION_INHERIT_FROM_API_POLICY

Action to take on unspecified keys in an object. Enum options - API_ACTION_INHERIT_FROM_API_POLICY, API_ACTION_PASS, API_ACTION_FLAG, API_ACTION_REJECT. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

ApiSimpleSchemaDescription
additional_properties_schema
Optional

Schema specification for scalar types, arrays, or schema references, defining data types and validation constraints for non-object properties.

boolean
allow_additional_properties
Optional

When true, object keys not defined in object_properties are permitted. Corresponds to OpenAPI additionalProperties true. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

ApiSimpleSchemaDescription
array_item_type
Optional

Schema specification for scalar types, arrays, or schema references, defining data types and validation constraints for non-object properties.

array of ApiSimpleSchemaDescription
composite_types
Optional

Sub-schemas for this composite type (oneOf, anyOf, or allOf). Each entry must be a SCHEMA_TYPE_REFERENCE pointing to an ApiSchema. Field introduced in 32.1.4. Maximum of 64 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

Description of this API schema. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

DiscriminatorDescription
discriminator
Optional

Discriminator configuration used within composite schemas (oneOf/anyOf) to select the matching sub-schema based on payload property values.

integer As uint32 As uint32
max_items
Optional

Maximum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
min_items
Optional

Minimum number of items allowed in an array. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required  

Name of this object, unique per Tenant. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of ApiObjectProperties
object_properties
Optional

List of properties for this object schema. Field introduced in 32.1.4. Maximum of 512 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
source
Read-Only  
Constraints: default: SOURCE_USER_DEFINED

Indicates whether this schema was user-defined or imported from an OpenAPI specification file. Enum options - SOURCE_USER_DEFINED, SOURCE_API_SPEC, SOURCE_DISCOVERED. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
type
Required  

The data type of this schema. Can be object, array, or a composite type (oneOf, anyOf, allOf). Enum options - SCHEMA_TYPE_UNDEFINED, SCHEMA_TYPE_STRING, SCHEMA_TYPE_INTEGER, SCHEMA_TYPE_NUMBER, SCHEMA_TYPE_BOOLEAN, SCHEMA_TYPE_NULL, SCHEMA_TYPE_ARRAY, SCHEMA_TYPE_OBJECT, SCHEMA_TYPE_REFERENCE, SCHEMA_TYPE_ONE_OF, SCHEMA_TYPE_ALL_OF, SCHEMA_TYPE_ANY_OF. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
unique_items
Optional

If true, all items in the array must be unique. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Read-Only  

url

string
uuid
Optional

The object UUID. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of
Parameter To
Returned By