[Index]
Model ref.: device/cuc/PortGroupTemplate
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": {
"TemplateDescriptionDefault": {
"minItems": 0,
"type": "string",
"description": " A description of the MediaPortGroupTemplate to aid the user in the selection of a template for the purpose of creating a new MediaPortGroup. Information such as Cisco Unity Connection system requirements and PBX requirements are contained in this column. ",
"name": "TemplateDescriptionDefault",
"title": "Template Description Default"
},
"CopyTelephonyIntegrationMethodEnum": {
"minItems": 0,
"type": "integer",
"description": " The method used by lines in this group to integrate with the switch.",
"name": "CopyTelephonyIntegrationMethodEnum",
"title": "Copy Telephony Integration Method Enum"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MediaPortGroupTemplate object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/PortGroupTemplate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/PortGroupTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/PortGroupTemplate/[pkid1]", "/api/v0/device/cuc/PortGroupTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/PortGroupTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/PortGroupTemplate |
|
{"hrefs": ["/api/device/cuc/PortGroupTemplate/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/PortGroupTemplate |
|
{"hrefs": ["/api/device/cuc/PortGroupTemplate/[pkid1]", "/api/device/cuc/PortGroupTemplate/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/PortGroupTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/PortGroupTemplate/export/ |
|
{ "hrefs":["/api/device/cuc/PortGroupTemplate/[pkid1]", "/api/device/cuc/PortGroupTemplate/[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 device/cuc/PortGroupTemplate and the JSON format can be used to import instances of device/cuc/PortGroupTemplate.
GET http://[host-proxy]/api/device/cuc/PortGroupTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/PortGroupTemplate | POST | /api/device/cuc/PortGroupTemplate/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/PortGroupTemplate/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/PortGroupTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/PortGroupTemplate/ |
|
The device/cuc/PortGroupTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/PortGroupTemplate instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "TemplateDescriptionDefault",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/PortGroupTemplate/?skip=0&limit=3&order_by=TemplateDescriptionDefault&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 12
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/PortGroupTemplate/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/PortGroupTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PortGroupTemplate/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cuc/PortGroupTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/PortGroupTemplate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/PortGroupTemplate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/PortGroupTemplate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/PortGroupTemplate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/PortGroupTemplate/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PortGroupTemplate",
"model_specific_actions": [
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "TemplateDescriptionDefault",
"title": "Template Description Default"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd30e48192d40018f77dff",
"meta": {
"tags": [],
"cached": true,
"title": "SCCP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd30e48192d40018f77dff",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30e48192d40018f77dff/?model_type=device/cuc/PortGroupTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PortGroupTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30e48192d40018f77dff"
],
"summary_attrs": [
{
"name": "TemplateDescriptionDefault",
"title": "Template Description Default"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"ObjectId": "90dd306f-b8af-46b6-8289-f13437cc1e5e",
"CopyTelephonyIntegrationMethodEnum": 1,
"URI": "/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e",
"TemplateDescriptionDefault": "SCCP",
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "5dcd189456b5de0018914bdd",
"meta": {
"tags": [],
"cached": true,
"title": "SCCP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd18514544b7001860529a",
"href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd189456b5de0018914bdd",
"href": "/api/device/cuc/PortGroupTemplate/5dcd189456b5de0018914bdd/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/PortGroupTemplate/5dcd189456b5de0018914bdd/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd189456b5de0018914bdd/?model_type=device/cuc/PortGroupTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PortGroupTemplate/5dcd189456b5de0018914bdd/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/PortGroupTemplate/5dcd189456b5de0018914bdd/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/PortGroupTemplate/5dcd189456b5de0018914bdd/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/PortGroupTemplate/5dcd189456b5de0018914bdd/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/PortGroupTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd189456b5de0018914bdd"
],
"summary_attrs": [
{
"name": "TemplateDescriptionDefault",
"title": "Template Description Default"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"ObjectId": "90dd306f-b8af-46b6-8289-f13437cc1e5e",
"CopyTelephonyIntegrationMethodEnum": 1,
"URI": "/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e",
"TemplateDescriptionDefault": "SCCP",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5dcd18c68192d40018f71aa4",
"meta": {
"tags": [],
"cached": true,
"title": "SCCP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd18824544b70018605580",
"href": "/api/v0/data/UnityConnection/5dcd18824544b70018605580"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd18c68192d40018f71aa4",
"href": "/api/device/cuc/PortGroupTemplate/5dcd18c68192d40018f71aa4/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/PortGroupTemplate/5dcd18c68192d40018f71aa4/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd18c68192d40018f71aa4/?model_type=device/cuc/PortGroupTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PortGroupTemplate/5dcd18c68192d40018f71aa4/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/PortGroupTemplate/5dcd18c68192d40018f71aa4/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/PortGroupTemplate/5dcd18c68192d40018f71aa4/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/PortGroupTemplate/5dcd18c68192d40018f71aa4/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PortGroupTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd18c68192d40018f71aa4"
],
"summary_attrs": [
{
"name": "TemplateDescriptionDefault",
"title": "Template Description Default"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"ObjectId": "90dd306f-b8af-46b6-8289-f13437cc1e5e",
"CopyTelephonyIntegrationMethodEnum": 1,
"URI": "/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e",
"TemplateDescriptionDefault": "SCCP",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd30e48192d40018f77dff",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "SCCP",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"self": [
{
"pkid": "5dcd30e48192d40018f77dff",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30e48192d40018f77dff/?hierarchy=[hierarchy]&model_type=device/cuc/PortGroupTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/PortGroupTemplate/5dcd30e48192d40018f77dff/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/PortGroupTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30e48192d40018f77dff"
],
"summary_attrs": [
{
"name": "TemplateDescriptionDefault",
"title": "Template Description Default"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"TemplateDescriptionDefault": "SCCP",
"CopyTelephonyIntegrationMethodEnum": 1,
"URI": "/vmrest/portgrouptemplates/90dd306f-b8af-46b6-8289-f13437cc1e5e",
"ObjectId": "90dd306f-b8af-46b6-8289-f13437cc1e5e"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/PortGroupTemplate. | GET | /api/device/cuc/PortGroupTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/PortGroupTemplate as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/PortGroupTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/PortGroupTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/PortGroupTemplate | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/PortGroupTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/PortGroupTemplate/[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 device/cuc/PortGroupTemplate and the JSON format can be used to import instances of device/cuc/PortGroupTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/PortGroupTemplate/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/PortGroupTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/PortGroupTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/PortGroupTemplate. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/PortGroupTemplate/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |