[Index]
Model ref.: device/cuc/ConfigurationValue
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": {
"MaxVal": {
"description": " For integer values, the maximum allowed value.",
"title": "Max Val",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "MaxVal"
},
"RequiresRestart": {
"description": " A flag indicating whether or not CUC will need to be restarted if this setting is changed.",
"title": "Requires Restart",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "RequiresRestart"
},
"LastModifiedByComponent": {
"description": " The name of the component that last modified this node.",
"title": "Last Modified By Component",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "LastModifiedByComponent"
},
"MinVal": {
"description": " For integer values, the minimum allowed value.",
"title": "Min Val",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "MinVal"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Value": {
"minItems": 0,
"type": [
"string",
"null"
],
"description": "Value of the node.",
"name": "Value",
"title": "Value"
},
"UserSetting": {
"description": " A flag indicating whether this Configuration object is accessible to an end user (administrator). Some settings are essentially internal, and not meant to be configured by end users.",
"title": "User Setting",
"minItems": 0,
"readonly": true,
"type": "boolean",
"name": "UserSetting"
},
"FullName": {
"description": " The fully qualified name of the node. - template parameter [1]",
"title": "Full Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "FullName"
},
"Type": {
"description": " The data type of the node value.",
"title": "Type",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "Type"
},
"LastModifiedTime": {
"description": " The date and time of the last modification.",
"title": "Last Modified Time",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "LastModifiedTime"
},
"RegexValidation": {
"description": " For string values, a regular expression string used to validate the string value.",
"title": "Regex Validation",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "RegexValidation"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/ConfigurationValue/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/ConfigurationValue/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/ConfigurationValue/[pkid1]", "/api/v0/device/cuc/ConfigurationValue/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/ConfigurationValue/?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/ConfigurationValue |
|
{"hrefs": ["/api/device/cuc/ConfigurationValue/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/ConfigurationValue |
|
{"hrefs": ["/api/device/cuc/ConfigurationValue/[pkid1]", "/api/device/cuc/ConfigurationValue/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/ConfigurationValue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/ConfigurationValue/export/ |
|
{ "hrefs":["/api/device/cuc/ConfigurationValue/[pkid1]", "/api/device/cuc/ConfigurationValue/[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/ConfigurationValue and the JSON format can be used to import instances of device/cuc/ConfigurationValue.
GET http://[host-proxy]/api/device/cuc/ConfigurationValue/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/ConfigurationValue | POST | /api/device/cuc/ConfigurationValue/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/ConfigurationValue/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/ConfigurationValue/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/ConfigurationValue/ |
|
The device/cuc/ConfigurationValue schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/ConfigurationValue instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "FullName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/ConfigurationValue/?skip=0&limit=3&order_by=FullName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2311
},
"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/ConfigurationValue/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/ConfigurationValue",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConfigurationValue/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/ConfigurationValue/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/ConfigurationValue/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/ConfigurationValue/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/ConfigurationValue/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/ConfigurationValue/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/ConfigurationValue/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConfigurationValue",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "FullName",
"title": "Full Name"
},
{
"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": "5dcd30cd8192d40018f77a21",
"meta": {
"tags": [],
"cached": true,
"title": "System",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"self": [
{
"pkid": "5dcd30cd8192d40018f77a21",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30cd8192d40018f77a21/?model_type=device/cuc/ConfigurationValue",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConfigurationValue",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30cd8192d40018f77a21"
],
"summary_attrs": [
{
"name": "FullName",
"title": "Full Name"
},
{
"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": {
"MaxVal": 0,
"RequiresRestart": false,
"MinVal": 0,
"hierarchy": "5dcd2d8b9d77dd0018b0ebe6",
"URI": "/configurationvalues/System",
"UserSetting": false,
"FullName": "System",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"Type": 1,
"hierarchy_friendly_name": "Overton (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "5dcd187756b5de001891482f",
"meta": {
"tags": [],
"cached": true,
"title": "System",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd18514544b7001860529a",
"href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a"
}
],
"self": [
{
"pkid": "5dcd187756b5de001891482f",
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd187756b5de001891482f/?model_type=device/cuc/ConfigurationValue",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/ConfigurationValue/5dcd187756b5de001891482f/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/ConfigurationValue",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd187756b5de001891482f"
],
"summary_attrs": [
{
"name": "FullName",
"title": "Full Name"
},
{
"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": {
"MaxVal": 0,
"RequiresRestart": false,
"MinVal": 0,
"hierarchy": "5dcd1812e186e30018eb7023",
"URI": "/configurationvalues/System",
"UserSetting": false,
"FullName": "System",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"Type": 1,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "5dcd18aa8192d40018f71612",
"meta": {
"tags": [],
"cached": true,
"title": "System",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd18824544b70018605580",
"href": "/api/v0/data/UnityConnection/5dcd18824544b70018605580"
}
],
"self": [
{
"pkid": "5dcd18aa8192d40018f71612",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/"
}
],
"parent": [
{
"pkid": "5dcd1812e186e30018eb7023",
"href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd18aa8192d40018f71612/?model_type=device/cuc/ConfigurationValue",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/ConfigurationValue/5dcd18aa8192d40018f71612/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConfigurationValue",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd1812e186e30018eb7023",
"5dcd18aa8192d40018f71612"
],
"summary_attrs": [
{
"name": "FullName",
"title": "Full Name"
},
{
"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": {
"MaxVal": 0,
"RequiresRestart": false,
"MinVal": 0,
"hierarchy": "5dcd1812e186e30018eb7023",
"URI": "/configurationvalues/System",
"UserSetting": false,
"FullName": "System",
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"Type": 1,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd30cd8192d40018f77a21",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "System",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"self": [
{
"pkid": "5dcd30cd8192d40018f77a21",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd3073e186e30018ebc837",
"href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd30cd8192d40018f77a21/?hierarchy=[hierarchy]&model_type=device/cuc/ConfigurationValue",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/ConfigurationValue/5dcd30cd8192d40018f77a21/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/ConfigurationValue",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd30cd8192d40018f77a21"
],
"summary_attrs": [
{
"name": "FullName",
"title": "Full Name"
},
{
"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": {
"MaxVal": 0,
"RequiresRestart": false,
"MinVal": 0,
"URI": "/configurationvalues/System",
"UserSetting": false,
"FullName": "System",
"Type": 1
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/ConfigurationValue. | GET | /api/device/cuc/ConfigurationValue/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/ConfigurationValue as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/ConfigurationValue/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/ConfigurationValue/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/ConfigurationValue/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/ConfigurationValue | 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/ConfigurationValue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/ConfigurationValue/[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/ConfigurationValue and the JSON format can be used to import instances of device/cuc/ConfigurationValue.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/ConfigurationValue/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/ConfigurationValue instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/ConfigurationValue/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/ConfigurationValue. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/ConfigurationValue/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |