[Index]
Configuration Templates are applied to data models and domain models. When they are created, all the attribute fields of the model are exposed. Default values or macros can then be assigned to these fields as required. For array elements of the related data- and domain models, a list and a variable can be specified to loop through so that a value is applied to the model array. More than one Configuration Template can be created for a model. When an instance of the model is added or updated, the Configuration Template that has been enabled for the model applies.
Model ref.: data/ConfigurationTemplate
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": {
"name": {
"required": true,
"type": "string",
"description": "The name that is given to the Configuration Template.",
"title": "Name"
},
"description": {
"required": false,
"type": "string",
"description": "A description for the Configuration Template instance.",
"title": "Description"
},
"feature_usage": {
"items": {
"type": "string"
},
"type": "array",
"description": "Custom feature usage identifier, is the feature name and is used as an additional filter for gui rule filtering",
"title": "Custom feature usage identifier"
},
"foreach": {
"description": "Iterates over the list returned by the macro and appends array elements to the specified field.",
"title": "Foreach Elements",
"items": {
"type": "object",
"properties": {
"property": {
"required": true,
"type": "string",
"description": "The field/property to iterate over.",
"title": "Property"
},
"macro_list": {
"required": true,
"type": "string",
"description": "The macro that produces the list to iterate over.",
"title": "Macro List"
},
"context_var": {
"required": true,
"type": "string",
"description": "The context variable that will contain the data from the iteration.",
"title": "Context Variable"
}
}
},
"required": false,
"type": "array"
},
"schema_defaults": {
"description": "Applicable when the configuration template is used directly in API requests. This attribute contains a list of paths to the properties of the template section that must be used to enrich the default values of the schema. All paths specified must refer to array attributes.",
"title": "Schema Defaults",
"items": {
"type": "string"
},
"required": false,
"type": "array"
},
"target_model_type": {
"required": true,
"type": "string",
"description": "The target model type and name that the Configuration Template applies to.",
"title": "Target Model Type"
},
"merge_strategy": {
"description": "Determines how this CFT will be merged into another CFT when it is being processed in a PWF.",
"title": "Merge Strategy",
"default": "additive",
"required": false,
"choices": [
{
"value": "additive",
"title": "Additive"
},
{
"value": "replace",
"title": "Replace"
}
],
"type": "string"
},
"template": {
"required": true,
"type": "string",
"description": "The contents of the template, such as defaults and macros. The names shown in the template are determined by the attribute names of the Target Model Type.",
"title": "Template"
}
},
"schema_version": "0.1.9"
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/ConfigurationTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/ConfigurationTemplate/[pkid1]", "/api/data/ConfigurationTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/ConfigurationTemplate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/ConfigurationTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/ConfigurationTemplate/[pkid1]", "/api/v0/data/ConfigurationTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/ConfigurationTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/ConfigurationTemplate/export/ |
|
{ "hrefs":["/api/data/ConfigurationTemplate/[pkid1]", "/api/data/ConfigurationTemplate/[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/ConfigurationTemplate and the JSON format can be used to import instances of data/ConfigurationTemplate.
GET http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/ConfigurationTemplate | POST | /api/data/ConfigurationTemplate/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/ConfigurationTemplate/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/ConfigurationTemplate/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/ConfigurationTemplate/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/ConfigurationTemplate/ |
|
The data/ConfigurationTemplate schema and all instances as JSON. |
(The list will return 0 to 3 data/ConfigurationTemplate instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2649,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/ConfigurationTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"update",
"help",
"remove",
"move",
"export",
"list",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/ConfigurationTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"bulk_update_form",
"clone",
"export",
"export_bulkload_template",
"get",
"help",
"list",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "0.1.9",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/ConfigurationTemplate/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/ConfigurationTemplate/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/data/ConfigurationTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ConfigurationTemplate/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ConfigurationTemplate/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/ConfigurationTemplate/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ConfigurationTemplate/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"description": "Template to activate a dial plan site.",
"name": "__DP_UpdateSite_CT",
"target_model_type": "data/DpSite",
"template": {
"active": "(( input.active == True )) <(( True ))> <(( False ))>",
"custName": "{{ previous.custName }}",
"emerNumber": "{{ pwf.evalEmerNumber }}",
"ext": "{{ previous.ext }}",
"extLen": "{{ previous.extLen }}",
"extPrefixReq": "(( previous.extPrefixReq == True )) <(( True ))> <(( False ))>",
"pubNumber": "{{ pwf.evalPubNumber }}",
"siteId": "{{ previous.siteId }}",
"siteName": "{{ previous.siteName }}",
"slc": "{{ previous.slc }}"
},
"pkid": "5ad5c1daaffa9343e4d951de",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/ConfigurationTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "5ad5c1daaffa9343e4d951df",
"version": "0.1.1",
"href": "/api/v0/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/?cached=5ad5c1daaffa9343e4d951df"
}
],
"tags": [
"HcsDialPlan",
"V4UC",
"ba_CommonOverlay"
],
"title": "__DP_UpdateSite_CT - data/DpSite",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/",
"pkid": "5ad5c1daaffa9343e4d951dd"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5c1daaffa9343e4d951dd"
],
"version_tag": "0.1.1",
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5c1daaffa9343e4d951dd"
},
{
"data": {
"name": "_DPCountryCSSCFT",
"foreach": [
{
"property": "members.member",
"context_var": "COUNTRYMEMPT",
"macro_list": "{# input.COUNTRYCSS.CountryPartition #}"
}
],
"template": {
"name": "{{input.COUNTRYCSS.CountryCSS}}",
"members": {
"member": [
{
"index": "{{ cft.COUNTRYMEMPT.SEQ}}",
"routePartitionName": "{{ cft.COUNTRYMEMPT.CountryMemPT }}"
}
]
},
"partitionUsage": "General"
},
"target_model_type": "device/cucm/Css",
"pkid": "5ad5b3eeaffa9343e4d92df2",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/ConfigurationTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"feature_tag_add_dialplan",
"V4UC",
"ba_EndToEnd"
],
"title": "_DPCountryCSSCFT - device/cucm/Css",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/",
"pkid": "5ad5b3eeaffa9343e4d92df1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5b3eeaffa9343e4d92df1"
],
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ConfigurationTemplate/5ad5b3eeaffa9343e4d92df1/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5b3eeaffa9343e4d92df1"
},
{
"data": {
"name": "_DPCountryEDXFCFT",
"template": {
"pattern": "{{input.COUNTRYEDXF.CountryDNISXF}}",
"routePartitionName": "{{input.COUNTRYEDXF.CountryDNISXFPT}}"
},
"target_model_type": "device/cucm/CalledPartyTransformationPattern",
"pkid": "5ad5b3fbaffa9343e4d92e0e",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/ConfigurationTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"feature_tag_add_dialplan",
"V4UC",
"ba_EndToEnd"
],
"title": "_DPCountryEDXFCFT - device/cucm/CalledPartyTransformationPattern",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/",
"pkid": "5ad5b3fbaffa9343e4d92e0d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5b3fbaffa9343e4d92e0d"
],
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ConfigurationTemplate/5ad5b3fbaffa9343e4d92e0d/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ad5b3fbaffa9343e4d92e0d"
}
]
}
(Show the first instance)
{
"data": {
"description": "Template to activate a dial plan site.",
"name": "__DP_UpdateSite_CT",
"target_model_type": "data/DpSite",
"template": {
"active": "(( input.active == True )) <(( True ))> <(( False ))>",
"custName": "{{ previous.custName }}",
"emerNumber": "{{ pwf.evalEmerNumber }}",
"ext": "{{ previous.ext }}",
"extLen": "{{ previous.extLen }}",
"extPrefixReq": "(( previous.extPrefixReq == True )) <(( True ))> <(( False ))>",
"pubNumber": "{{ pwf.evalPubNumber }}",
"siteId": "{{ previous.siteId }}",
"siteName": "{{ previous.siteName }}",
"slc": "{{ previous.slc }}"
},
"pkid": "5ad5c1daaffa9343e4d951de"
},
"meta": {
"model_type": "data/ConfigurationTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "target_model_type",
"title": "Target Model Type"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [
{
"pkid": "5ad5c1daaffa9343e4d951df",
"version": "0.1.1",
"href": "/api/v0/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/?cached=5ad5c1daaffa9343e4d951df"
}
],
"tags": [
"HcsDialPlan",
"V4UC",
"ba_CommonOverlay"
],
"title": "__DP_UpdateSite_CT - data/DpSite",
"business_key": {
"hierarchy": true,
"unique": [
"name",
"target_model_type"
]
},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01",
"pkid": "5ad5bacbaffa9343e4d93e01"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/",
"pkid": "5ad5c1daaffa9343e4d951dd"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ad5c1daaffa9343e4d951dd"
],
"version_tag": "0.1.1",
"system_resource": true,
"schema_version": "0.1.9",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/ConfigurationTemplate/5ad5c1daaffa9343e4d951dd/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ad5c1daaffa9343e4d951dd"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/ConfigurationTemplate. | GET | /api/data/ConfigurationTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/ConfigurationTemplate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/ConfigurationTemplate/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/ConfigurationTemplate/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/ConfigurationTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/ConfigurationTemplate/?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/ConfigurationTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/ConfigurationTemplate/[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/ConfigurationTemplate and the JSON format can be used to import instances of data/ConfigurationTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/ConfigurationTemplate/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/ConfigurationTemplate/[pkid] | hierarchy=[hierarchy] | The data/ConfigurationTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/ConfigurationTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/ConfigurationTemplate. |