[Index]
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 ref.: data/DomainModel
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"doc": {
"required": true,
"type": "string",
"description": "Used for generating reference documentation for the model.",
"title": "Documentation"
},
"Meta": {
"required": true,
"type": "object",
"properties": {
"operations": {
"title": "Operations",
"minItems": 0,
"items": {
"type": "string",
"choices": [
{
"value": "add",
"title": "Add"
},
{
"value": "bulk_update_form",
"title": "Bulk Update"
},
{
"value": "clone",
"title": "Clone"
},
{
"value": "configuration_template",
"title": "Configuration Template"
},
{
"value": "field_display_policy",
"title": "Field Display Policy"
},
{
"value": "export",
"title": "Export"
},
{
"value": "export_bulkload_template",
"title": "Export Bulk Load Template"
},
{
"value": "get",
"title": "Get"
},
{
"value": "help",
"title": "Help"
},
{
"value": "list",
"title": "List"
},
{
"value": "migration",
"title": "Migration Template"
},
{
"value": "remove",
"title": "Remove"
},
{
"value": "tag",
"title": "Tag"
},
{
"value": "tag_version",
"title": "Tag Version"
},
{
"value": "update",
"title": "Update"
}
]
},
"required": true,
"default": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"remove",
"update"
],
"maxItems": 15,
"type": "array"
},
"attr_map": {
"minItems": 0,
"items": {
"type": "object",
"properties": {
"refattrs": {
"minItems": 0,
"items": {
"type": "object",
"properties": {
"refname": {
"title": "Reference Name",
"type": "string",
"description": "For example, cucm_user",
"choices": [
{
"value": "",
"title": ""
}
]
},
"attr": {
"title": "Resource Attribute",
"type": "string",
"description": "For example, \"userid\".",
"choices": [
{
"value": "",
"title": ""
}
]
}
}
},
"type": "array",
"title": "Referenced Attributes"
},
"group": {
"type": "string",
"description": "If added, the Group name to which the Domain Model Attribute belongs. Attributes that have the same Group name are displayed together.",
"title": "Group"
},
"name": {
"type": "string",
"description": "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.",
"title": "Domain Model Attribute"
},
"title": {
"type": "string",
"description": "The displayed name of the Domain Model Attribute.",
"title": "Friendly Name"
}
}
},
"required": true,
"type": "array",
"title": "Mapped Attributes"
},
"refs": {
"minItems": 1,
"items": {
"type": "object",
"properties": {
"default_workflow": {
"minItems": 0,
"items": {
"type": "object",
"properties": {
"operation": {
"title": "Operation",
"type": "string",
"description": "For example, add or mod.",
"choices": [
{
"value": "add",
"title": "Add"
},
{
"value": "update",
"title": "Update"
}
]
},
"config_template": {
"description": "Any existing default configuration template for this reference.",
"title": "Default Configuration Template",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/ConfigurationTemplate",
"type": "string",
"target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"type": "array",
"maxItems": 2,
"title": "Default Workflow"
},
"cardinality": {
"title": "How Many?",
"required": true,
"type": "string",
"choices": [
{
"value": "1",
"title": "Always One"
},
{
"value": "0-1",
"title": "Zero or One"
},
{
"value": "0-N",
"title": "Zero or More"
},
{
"value": "1-N",
"title": "One or More"
}
]
},
"resource": {
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Resource Type",
"format": "uri",
"choices": [],
"target_model_type": "",
"type": "string",
"description": "For example, \"device/cucm/User\"."
},
"name": {
"required": true,
"type": "string",
"description": "e.g. cucm_user.",
"title": "Reference Name"
},
"title": {
"type": "string",
"description": "For example, Call Manager User.",
"title": "Friendly Name"
}
}
},
"required": true,
"type": "array",
"title": "References To Resources"
},
"title_format": {
"required": false,
"type": "string",
"title": "Title Format"
},
"workflows": {
"items": {
"type": "object",
"properties": {
"operation": {
"title": "Workflow Operation",
"type": "string",
"description": "For example, \"add\", \"modify\", \"delete\".",
"choices": [
{
"value": "add",
"title": "Add"
},
{
"value": "modify",
"title": "Modify"
},
{
"value": "delete",
"title": "Delete"
}
]
},
"workflow": {
"target": "/api/data/ProvisioningWorkflow/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Provisioning Workflow",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/ProvisioningWorkflow",
"type": "string"
}
}
},
"required": false,
"type": "array",
"title": "Workflows"
},
"summary_attrs": {
"items": {
"type": "string"
},
"required": true,
"type": "array",
"title": "Summary Attributes"
},
"visible_at_lower_hierarchy": {
"type": "boolean",
"description": "When enabled, model instances defined at higher levels in the hierarchy will be visible at lower hierarchy levels.",
"title": "Visible at Lower Hierarchy"
},
"constraints": {
"items": {
"type": "object",
"properties": {
"hierarchy": {
"type": "boolean",
"title": "Hierarchy"
},
"unique": {
"items": {
"type": "string"
},
"required": true,
"type": "array",
"title": "Unique"
},
"business_key": {
"type": "boolean",
"title": "Business Key"
}
}
},
"required": false,
"type": "array",
"title": "Constraints"
}
},
"title": "Meta"
},
"name": {
"readonly": true,
"required": true,
"type": "string",
"title": "Name"
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DomainModel/add/ |
|
The GUI Add form of data/DomainModel as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/DomainModel | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/DomainModel/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DomainModel/[pkid1]", "/api/data/DomainModel/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DomainModel/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/DomainModel/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/DomainModel/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/DomainModel/[pkid1]", "/api/v0/data/DomainModel/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/DomainModel/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DomainModel; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DomainModel/export/ |
|
{ "hrefs":["/api/data/DomainModel/[pkid1]", "/api/data/DomainModel/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of data/DomainModel and the JSON format can be used to import instances of data/DomainModel.
GET http://[host-proxy]/api/data/DomainModel/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DomainModel | POST | /api/data/DomainModel/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/DomainModel/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DomainModel/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/DomainModel/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DomainModel/ |
|
The data/DomainModel schema and all instances as JSON. |
(The list will return 0 to 3 data/DomainModel instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/DomainModel/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 8
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "0.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/DomainModel/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DomainModel/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/DomainModel/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DomainModel/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/DomainModel/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/DomainModel/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/DomainModel/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/DomainModel/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/DomainModel/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DomainModel/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/data/DomainModel/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "data/DomainModel",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove",
"update"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5df35ceece894e0012b33880",
"meta": {
"tags": [
"feature_tag_add_cucm_countries",
"V4UC",
"ba_EndToEnd"
],
"cached": true,
"title": "AddPBXCountries",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df35ceece894e0012b33880",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DomainModel",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35ceece894e0012b33880"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "AddPBXCountries",
"pkid": "5df35ceece894e0012b33881",
"doc": "doc",
"Meta": {
"operations": [
"list",
"get",
"add",
"remove",
"export_bulkload_template",
"configuration_template",
"field_display_policy",
"export",
"migration",
"help"
],
"attr_map": [
{
"refattrs": [
{
"refname": "data",
"attr": "pbx"
}
],
"name": "PBX",
"title": "CUCM Host Name"
},
{
"refattrs": [
{
"refname": "data",
"attr": "Country"
}
],
"name": "Country"
},
{
"refattrs": [
{
"refname": "data",
"attr": "dialplan"
}
],
"name": "DialPlanName",
"title": "Dialplan"
}
],
"refs": [
{
"cardinality": "1",
"resource": "data/PBXCountries",
"name": "data"
}
],
"workflows": [
{
"operation": "add",
"workflow": "AddPBXCountries"
},
{
"operation": "delete",
"workflow": "DelPBXCountries"
}
],
"summary_attrs": [
"PBX",
"Country",
"DialPlanName"
],
"constraints": [
{
"hierarchy": true,
"unique": [
"PBX",
"Country",
"DialPlanName"
],
"business_key": true
}
]
},
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
},
{
"pkid": "5df35ceece894e0012b3387d",
"meta": {
"tags": [
"vossbase",
"V4UC",
"ba_EndToEnd"
],
"cached": true,
"title": "BaseCustomerDOM",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df35ceece894e0012b3387d",
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/DomainModel/5df35ceece894e0012b3387d/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/DomainModel",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35ceece894e0012b3387d"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "BaseCustomerDOM",
"pkid": "5df35ceece894e0012b3387e",
"doc": "Domain model for creating hierarchy nodes of type BaseCustomerDAT",
"Meta": {
"operations": [
"list",
"get",
"add",
"update",
"remove",
"export_bulkload_template",
"bulk_update",
"configuration_template",
"field_display_policy",
"export",
"migration",
"help"
],
"attr_map": [
{
"refattrs": [
{
"refname": "business_data",
"attr": "CustomerName"
}
],
"name": "name",
"title": "Customer Name"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "InternalCustomerID"
}
],
"name": "InternalCustomerID",
"title": "Internal ID"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "Description"
}
],
"name": "Description",
"title": "Description"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "Address1"
}
],
"name": "Address1",
"title": "Address Line 1"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "Address2"
}
],
"name": "Address2",
"title": "Address Line 2"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "Address3"
}
],
"name": "Address3",
"title": "Address Line 3"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "CustomerID"
}
],
"name": "CustomerID",
"title": "Customer ID"
}
],
"refs": [
{
"cardinality": "1",
"resource": "data/BaseCustomerDAT",
"name": "business_data",
"title": "Hierarchy Business Data"
}
],
"workflows": [
{
"operation": "add",
"workflow": "AddHierarchyType_BaseCustomer"
},
{
"operation": "delete",
"workflow": "DelHierarchyType_BaseCustomer"
}
],
"summary_attrs": [
"name"
],
"constraints": [
{
"hierarchy": true,
"unique": [
"name"
],
"business_key": true
}
]
},
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
},
{
"pkid": "5df35cefce894e0012b33886",
"meta": {
"tags": [
"feature_tag_add_provider",
"V4UC",
"ba_EndToEnd"
],
"cached": true,
"title": "BaseProvider",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "0.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df35cefce894e0012b33886",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/DomainModel/5df35cefce894e0012b33886/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/DomainModel",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35cefce894e0012b33886"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"name": "BaseProvider",
"pkid": "5df35cefce894e0012b33887",
"doc": "Domain model for creating hierarchy nodes of type BaseProvider",
"Meta": {
"operations": [
"list",
"get",
"add",
"update",
"remove",
"export_bulkload_template",
"bulk_update",
"configuration_template",
"field_display_policy",
"export",
"migration",
"help"
],
"attr_map": [
{
"refattrs": [
{
"refname": "data_hn",
"attr": "name"
},
{
"refname": "business_data",
"attr": "name"
}
],
"name": "name",
"title": "Provider Name"
},
{
"refattrs": [
{
"refname": "business_data",
"attr": "Description"
}
],
"name": "Description",
"title": "Description"
}
],
"refs": [
{
"cardinality": "1",
"resource": "data/HierarchyNode",
"name": "data_hn",
"title": "Hierarchy Node"
},
{
"cardinality": "1",
"resource": "data/BaseProvider",
"name": "business_data",
"title": "Hierarchy Business Data"
}
],
"workflows": [
{
"operation": "add",
"workflow": "AddHierarchyType_BaseProvider"
},
{
"operation": "delete",
"workflow": "DelHierarchyType_BaseProvider"
}
],
"summary_attrs": [
"name",
"Description"
],
"constraints": [
{
"hierarchy": true,
"unique": [
"name"
],
"business_key": true
}
]
},
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
}
}
]
}
(Show the first instance)
{
"pkid": "5df35ceece894e0012b33880",
"meta": {
"tags": [
"feature_tag_add_cucm_countries",
"V4UC",
"ba_EndToEnd"
],
"cached": false,
"title": "AddPBXCountries",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "0.1",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "5df35ceece894e0012b33880",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/"
}
],
"foreign_key": [
{
"model_type": "data/ProvisioningWorkflow",
"path": "Meta.workflows.0.workflow"
},
{
"model_type": "data/ProvisioningWorkflow",
"path": "Meta.workflows.1.workflow"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DomainModel/5df35ceece894e0012b33880/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DomainModel",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35ceece894e0012b33880"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "5df35ceece894e0012b33881",
"doc": "doc",
"Meta": {
"operations": [
"list",
"get",
"add",
"remove",
"export_bulkload_template",
"configuration_template",
"field_display_policy",
"export",
"migration",
"help"
],
"attr_map": [
{
"refattrs": [
{
"refname": "data",
"attr": "pbx"
}
],
"name": "PBX",
"title": "CUCM Host Name"
},
{
"refattrs": [
{
"refname": "data",
"attr": "Country"
}
],
"name": "Country"
},
{
"refattrs": [
{
"refname": "data",
"attr": "dialplan"
}
],
"name": "DialPlanName",
"title": "Dialplan"
}
],
"refs": [
{
"cardinality": "1",
"resource": "data/PBXCountries",
"name": "data"
}
],
"workflows": [
{
"operation": "add",
"workflow": "AddPBXCountries"
},
{
"operation": "delete",
"workflow": "DelPBXCountries"
}
],
"summary_attrs": [
"PBX",
"Country",
"DialPlanName"
],
"constraints": [
{
"hierarchy": true,
"unique": [
"PBX",
"Country",
"DialPlanName"
],
"business_key": true
}
]
},
"name": "AddPBXCountries"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DomainModel. | GET | /api/data/DomainModel/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DomainModel as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DomainModel/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DomainModel/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DomainModel/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DomainModel/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/DomainModel; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DomainModel/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of data/DomainModel and the JSON format can be used to import instances of data/DomainModel.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DomainModel/[pkid] | hierarchy=[hierarchy] | The data/DomainModel instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DomainModel/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DomainModel. |