[Index]

Model: data/DomainModel

The DomainModel data model allows users to create their own domain models. Domain models aggregate
data across multiple models, and may encapsulate business logic.

Model Details: data/DomainModel

Title Description Details
Name *
  • Field Name: name
  • Type: String
Documentation * Used for generating reference documentation for the model.
  • Field Name: doc
  • Type: String
Meta
  • Field Name: Meta
  • Type: Object
Visible at Lower Hierarchy When enabled, model instances defined at higher levels in the hierarchy will be visible at lower hierarchy levels.
  • Field Name: Meta.visible_at_lower_hierarchy
  • Type: Boolean
Title Format
  • Field Name: Meta.title_format
  • Type: String
Summary Attributes
  • Field Name: summary_attrs.[n]
  • Type: Array
References To Resources
  • Field Name: refs.[n]
  • Type: Array
  • Cardinality: [1..n]
Reference Name * e.g. cucm_user.
  • Field Name: Meta.refs.[n].name
  • Type: String
Friendly Name For example, Call Manager User.
  • Field Name: Meta.refs.[n].title
  • Type: String
Resource Type For example, "device/cucm/User".
  • Field Name: Meta.refs.[n].resource
  • Type: String
  • Format: uri
How Many? *
  • Field Name: Meta.refs.[n].cardinality
  • Type: String
  • Choices: ["Always One", "Zero or One", "Zero or More", "One or More"]
Default Workflow
  • Field Name: default_workflow.[n]
  • Type: Array
  • Cardinality: [0..2]
Operation For example, add or mod.
  • Field Name: Meta.refs.[n].default_workflow.[n].operation
  • Type: String
  • Choices: ["Add", "Update"]
Default Configuration Template Any existing default configuration template for this reference.
  • Field Name: Meta.refs.[n].default_workflow.[n].config_template
  • Type: String
  • Target: data/ConfigurationTemplate
  • Target attr: name
  • Format: uri
Mapped Attributes
  • Field Name: attr_map.[n]
  • Type: Array
Domain Model Attribute The name of the referenced attribute in the Domain Model. Note that this Domain Model Attribute name cannot be the same as a Reference Name of a resource.
  • Field Name: Meta.attr_map.[n].name
  • Type: String
Friendly Name The displayed name of the Domain Model Attribute.
  • Field Name: Meta.attr_map.[n].title
  • Type: String
Group If added, the Group name to which the Domain Model Attribute belongs. Attributes that have the same Group name are displayed together.
  • Field Name: Meta.attr_map.[n].group
  • Type: String
Referenced Attributes
  • Field Name: refattrs.[n]
  • Type: Array
Reference Name For example, cucm_user
  • Field Name: Meta.attr_map.[n].refattrs.[n].refname
  • Type: String
  • Choices: [""]
Resource Attribute For example, "userid".
  • Field Name: Meta.attr_map.[n].refattrs.[n].attr
  • Type: String
  • Choices: [""]
Workflows
  • Field Name: workflows.[n]
  • Type: Array
Workflow Operation For example, "add", "modify", "delete".
  • Field Name: Meta.workflows.[n].operation
  • Type: String
  • Choices: ["Add", "Modify", "Delete"]
Provisioning Workflow
  • Field Name: Meta.workflows.[n].workflow
  • Type: String
  • Target: data/ProvisioningWorkflow
  • Target attr: name
  • Format: uri
Operations
  • Field Name: operations.[n]
  • Type: Array
  • Cardinality: [0..15]
  • Default: ['add', 'bulk_update_form', 'clone', 'configuration_template', 'export', 'export_bulkload_template', 'field_display_policy', 'get', 'help', 'list', 'migration', 'remove', 'update']
Constraints
  • Field Name: constraints.[n]
  • Type: Array
Unique
  • Field Name: unique.[n]
  • Type: Array
Hierarchy
  • Field Name: Meta.constraints.[n].hierarchy
  • Type: Boolean
Business Key
  • Field Name: Meta.constraints.[n].business_key
  • Type: Boolean