Item schemas mAPI reference
Complete reference documentation for the Item schemas resource.
Item schemas
#Item schemas define the managed properties for users, tenants, and objects in a given environment.
You can retrieve, update, and validate the schema for each item type, as well as list all item schemas in a given environment.
List item schemas
#Retrieve the configuration for all managed item schemas (user, tenant, and object) in a given environment. Branch-qualified reads return the schemas inherited from the parent environment.
Get an item schema
#Retrieve the configuration for an item schema (user, tenant, or object) in a given environment, including all of its configured properties.
Upsert item schema properties
#Applies changes for the item schema properties in the request. Omitted properties are left unchanged; hide a property with visible: false rather than removing it. The required permissions depend on what changes: changing a property's display settings (visible/description) requires item_schemas:manage; changing a property's type or example, or adding a property, requires item_schemas:edit. Adding a property that is already hidden or already has a description requires both.
Validate an item schema's configuration
#Checks an item schema configuration payload and reports which permissions it would require, without saving any changes.
ItemSchema
#A managed schema configuration for users, tenants, or objects.