[Index]
Instances of this model are modules which, when enabled, apply Jinja2 template overrides to DeviceModel instances of a certain type in order to activate a feature.
Model ref.: data/DeviceModelOverride
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": {
"title": "Name",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"type": "string",
"required": true
},
"device_type": {
"title": "Device Type",
"description": "Match device type of device model instances",
"type": "string",
"required": true
},
"version": {
"title": "Version",
"description": "Match version of device model instances",
"type": "string",
"required": true
},
"condition": {
"title": "Condition",
"description": "Jinja2 template which must evaluate to true for this module to be enabled",
"type": "string",
"required": true
},
"overrides": {
"title": "Overrides",
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"operation": {
"title": "Operation",
"description": "Regular expression to match device model operation names",
"type": "string",
"required": true
},
"template_type": {
"title": "Template Type",
"description": "Template type to match device model template types",
"type": "string",
"required": true,
"choices": [
{
"value": "uri",
"title": "URI"
},
{
"value": "request_template",
"title": "Request Template"
},
{
"value": "response_code_template",
"title": "Response Code Template"
},
{
"value": "response_template",
"title": "Response Template"
}
]
},
"template": {
"title": "Template",
"description": "Jinja2 template that will receive the output of the previous render for this operation and template type along with the normal context",
"type": "string",
"required": true
}
}
}
}
},
"schema_version": "0.8.6"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DeviceModelOverride/add/ |
|
The GUI Add form of data/DeviceModelOverride 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/DeviceModelOverride | 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/DeviceModelOverride/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DeviceModelOverride/[pkid1]", "/api/data/DeviceModelOverride/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DeviceModelOverride/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/DeviceModelOverride/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/DeviceModelOverride/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/DeviceModelOverride/[pkid1]", "/api/v0/data/DeviceModelOverride/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/DeviceModelOverride/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DeviceModelOverride; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DeviceModelOverride/export/ |
|
{ "hrefs":["/api/data/DeviceModelOverride/[pkid1]", "/api/data/DeviceModelOverride/[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/DeviceModelOverride and the JSON format can be used to import instances of data/DeviceModelOverride.
GET http://[host-proxy]/api/data/DeviceModelOverride/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DeviceModelOverride | POST | /api/data/DeviceModelOverride/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DeviceModelOverride/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/data/DeviceModelOverride/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/DeviceModelOverride/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DeviceModelOverride/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/DeviceModelOverride/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DeviceModelOverride/ |
|
The data/DeviceModelOverride schema and all instances as JSON. |
(The list will return 0 to 3 data/DeviceModelOverride instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/DeviceModelOverride/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"remove",
"move",
"get",
"add",
"list",
"export",
"bulk_update_form",
"transform",
"export_bulkload_template",
"configuration_template",
"help",
"migration",
"update",
"field_display_policy"
],
"meta": {
"model_type": "data/DeviceModelOverride",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove",
"tag",
"tag_version",
"update"
],
"schema_version": "0.8.6",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/DeviceModelOverride/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceModelOverride/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/data/DeviceModelOverride/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/DeviceModelOverride/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/DeviceModelOverride/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DeviceModelOverride/+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/DeviceModelOverride/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/data/DeviceModelOverride/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/data/DeviceModelOverride/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/data/DeviceModelOverride/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/DeviceModelOverride/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceModelOverride/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/data/DeviceModelOverride/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": [
{
"data": {
"name": "MSGraph_502/504_Error_Retries",
"description": "Override for MSGraph 502/504 error retries",
"device_type": "device/msgraph",
"version": "1.0",
"condition": "{{ driver_parameters.enable_502_504_retry if driver_parameters.enable_502_504_retry else false }}",
"overrides": [
{
"operation": ".*",
"template_type": "response_code_template",
"template": "{%- set status = previous_render or {} %}\n{%- if input.get('error', {}).get('code', '') in ('UnknownError', 'BadGateway') %}\n {%- set _=status.__setitem__('retry_code', 'RetryRequest') %}\n {%- set _=status.__setitem__('code', 'RetryRequest') %}\n {%- set _=status.__setitem__('success_code', 'does_not_match_code') %}\n{%- endif %}\n\n{{ status | to_json }}"
}
],
"pkid": "682e959a5c69e65974788829",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/DeviceModelOverride",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"EKB19729",
"V4UC",
"ba_CommonOverlay"
],
"title": "MSGraph_502/504_Error_Retries",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/",
"pkid": "682e959a5c69e65974788828"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"682e959a5c69e65974788828"
],
"schema_version": "0.8.6",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "682e959a5c69e65974788828"
},
{
"data": {
"name": "Webex_Override_Retry",
"description": "Webex_Override_Retry",
"device_type": "device/spark",
"version": "1.0.0",
"condition": "true",
"overrides": [
{
"operation": ".*",
"template_type": "response_code_template",
"template": "{%- set ns=namespace(\n status=previous_render or {}, \n retry_after=variables.get('_httpheaders', {}).get('Retry-After', ''), \n default_retry=driver_parameters.get('default_retry_delay', '') \n) %}\n\n{%- if not ns.retry_after %}\n {%- set ns.retry_after = variables.get('_httpheaders', {}).get('retry-after', '') %}\n{%- endif %}\n\n{%- if ns.retry_after %}\n {%- set default_retry_int = (ns.default_retry | int) if ns.default_retry else 120 %}\n {%- set retry_after_int = ns.retry_after | int %}\n {%- set retry_delay = retry_after_int if retry_after_int < default_retry_int else default_retry_int %}\n {%- set ns.status = {\n \"retry_limit\": '20',\n \"retry_code\": 'RetryRequest',\n \"code\": 'RetryRequest',\n \"success_code\": 'does_not_match_code',\n \"retry_delay\": retry_delay | string\n } %}\n{%- endif %}\n\n{{ ns.status|to_json }}"
}
],
"pkid": "682e959a5c69e65974788825",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/DeviceModelOverride",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"V4UC",
"ba_CommonOverlay"
],
"title": "Webex_Override_Retry",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/",
"pkid": "682e959a5c69e65974788824"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"682e959a5c69e65974788824"
],
"schema_version": "0.8.6",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/+tag_version/",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788824/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "682e959a5c69e65974788824"
}
]
}
(Show the first instance)
{
"data": {
"name": "MSGraph_502/504_Error_Retries",
"description": "Override for MSGraph 502/504 error retries",
"device_type": "device/msgraph",
"version": "1.0",
"condition": "{{ driver_parameters.enable_502_504_retry if driver_parameters.enable_502_504_retry else false }}",
"overrides": [
{
"operation": ".*",
"template_type": "response_code_template",
"template": "{%- set status = previous_render or {} %}\n{%- if input.get('error', {}).get('code', '') in ('UnknownError', 'BadGateway') %}\n {%- set _=status.__setitem__('retry_code', 'RetryRequest') %}\n {%- set _=status.__setitem__('code', 'RetryRequest') %}\n {%- set _=status.__setitem__('success_code', 'does_not_match_code') %}\n{%- endif %}\n\n{{ status | to_json }}"
}
],
"pkid": "682e959a5c69e65974788829"
},
"meta": {
"model_type": "data/DeviceModelOverride",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "device_type",
"title": "Device Type"
},
{
"name": "version",
"title": "Version"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [
"EKB19729",
"V4UC",
"ba_CommonOverlay"
],
"title": "MSGraph_502/504_Error_Retries",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": false,
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/",
"pkid": "682e959a5c69e65974788828"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"682e959a5c69e65974788828"
],
"schema_version": "0.8.6",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/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/DeviceModelOverride/682e959a5c69e65974788828/+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/DeviceModelOverride/682e959a5c69e65974788828/+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/DeviceModelOverride/682e959a5c69e65974788828/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/DeviceModelOverride/682e959a5c69e65974788828/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "682e959a5c69e65974788828"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DeviceModelOverride. | GET | /api/data/DeviceModelOverride/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DeviceModelOverride as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/data/DeviceModelOverride/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DeviceModelOverride/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DeviceModelOverride/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DeviceModelOverride/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DeviceModelOverride/?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/DeviceModelOverride; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DeviceModelOverride/[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/DeviceModelOverride and the JSON format can be used to import instances of data/DeviceModelOverride.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DeviceModelOverride/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DeviceModelOverride/[pkid] | hierarchy=[hierarchy] | The data/DeviceModelOverride instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DeviceModelOverride/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DeviceModelOverride. |