[Index]
Mapping from device connection parameters to model type
Model ref.: data/DeviceModelMapping
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": {
"default_helper_params": {
"properties": {
"username": {
"type": "string",
"description": "The username to authenticate with the device API",
"title": "Admin Username"
},
"base_url": {
"type": "string",
"description": "The base URL for the API",
"title": "Base URL"
},
"host": {
"type": "string",
"description": "The host name of the device",
"title": "Host Name"
},
"version": {
"type": "string",
"description": "The version of the device API",
"title": "Version"
},
"password": {
"is_password": true,
"type": "string",
"description": "The password to authenticate with the device API (the text will be hidden)",
"title": "Admin Password"
},
"port": {
"type": "string",
"description": "The port to use to connect to the device",
"title": "Port"
}
},
"type": "object",
"description": "Default parameters to use for connection if there are none defined",
"title": "Default Connection Parameters"
},
"name": {
"type": "string",
"description": "The name of the device that we are mapping. This is typically used in device dropdowns.",
"title": "Name"
},
"generic": {
"type": "boolean",
"description": "Should the generic driver be used for this mapping?",
"title": "Generic"
},
"dynamic_schema": {
"type": "boolean",
"description": "When dynamic_schema is True, schema will be imported before each data import",
"title": "Dynamic Schema"
},
"device_model_type": {
"required": true,
"type": "string",
"description": "Device model type to be managed",
"title": "Device Model Type"
},
"allow_ndl": {
"type": "boolean",
"description": "When Allow in NDL is True, the device will be allowed in the list of devices in a NDL (Network Device List)",
"title": "Allow in NDL"
},
"override_model": {
"target": "/api/data/DataModel/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Override Model",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/DataModel",
"type": "string",
"description": "Model that can be used to override fields on the connection parameters"
},
"connection_parameters_type": {
"required": true,
"type": "string",
"description": "Type of connection parameters to use",
"title": "Connection Parameters Type"
},
"allow_data_sync": {
"type": "boolean",
"description": "When Allow in Data Sync is True, the device will be allowed in the list of devices usable with Data Sync",
"title": "Allow with Data Sync"
}
},
"schema_version": "0.1.9"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DeviceModelMapping/add/ |
|
The GUI Add form of data/DeviceModelMapping 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/DeviceModelMapping | 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/DeviceModelMapping/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DeviceModelMapping/[pkid1]", "/api/data/DeviceModelMapping/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DeviceModelMapping/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/DeviceModelMapping/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/DeviceModelMapping/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/DeviceModelMapping/[pkid1]", "/api/v0/data/DeviceModelMapping/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/DeviceModelMapping/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DeviceModelMapping; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DeviceModelMapping/export/ |
|
{ "hrefs":["/api/data/DeviceModelMapping/[pkid1]", "/api/data/DeviceModelMapping/[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/DeviceModelMapping and the JSON format can be used to import instances of data/DeviceModelMapping.
GET http://[host-proxy]/api/data/DeviceModelMapping/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DeviceModelMapping | POST | /api/data/DeviceModelMapping/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/data/DeviceModelMapping/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DeviceModelMapping/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/DeviceModelMapping/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DeviceModelMapping/ |
|
The data/DeviceModelMapping schema and all instances as JSON. |
(The list will return 0 to 3 data/DeviceModelMapping instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "connection_parameters_type",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/DeviceModelMapping/?skip=0&limit=3&order_by=connection_parameters_type&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 45
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"connection_parameters_type",
"device_model_type"
]
},
"schema_version": "0.1.9",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/DeviceModelMapping/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DeviceModelMapping/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/DeviceModelMapping/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DeviceModelMapping/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/DeviceModelMapping/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DeviceModelMapping/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DeviceModelMapping/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/DeviceModelMapping/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/DeviceModelMapping/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/DeviceModelMapping/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/DeviceModelMapping/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DeviceModelMapping/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DeviceModelMapping",
"model_specific_actions": [
"add",
"bulk_update_form",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"clone",
"migration",
"remove",
"tag",
"tag_version",
"update"
],
"summary_attrs": [
{
"name": "connection_parameters_type",
"title": "Connection Parameters Type"
},
{
"name": "device_model_type",
"title": "Device Model Type"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5df34f0bce894e0012c6003e",
"meta": {
"tags": [
"base",
"core"
],
"cached": true,
"title": "data/activedirectory - device/activedirectory",
"business_key": {
"hierarchy": true,
"unique": [
"connection_parameters_type",
"device_model_type"
]
},
"schema_version": "0.1.9",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df34f0bce894e0012c6003e",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"version_tag": "0.1.1",
"model_type": "data/DeviceModelMapping",
"path": [
"6t0ggef2c0deab00hb595101",
"5df34f0bce894e0012c6003e"
],
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/help",
"method": "GET",
"title": "Help"
}
}
],
"summary_attrs": [
{
"name": "connection_parameters_type",
"title": "Connection Parameters Type"
},
{
"name": "device_model_type",
"title": "Device Model Type"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": [
{
"pkid": "6018facdce894e001163470f",
"version": "0.1.0",
"href": "/api/v0/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?cached=6018facdce894e001163470f"
},
{
"pkid": "63c6492755f0656d18c24f67",
"version": "0.1.1",
"href": "/api/v0/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?cached=63c6492755f0656d18c24f67"
}
]
},
"data": {
"default_helper_params": {
"username": "EXAMPLE\\johnny",
"host": "EXAMPLE\\my-microsoft-instance.microsoft.localhost",
"password": "secret",
"version": "69"
},
"name": "Active Directory",
"pkid": "5df34f0bce894e0012c6003f",
"dynamic_schema": false,
"device_model_type": "device/activedirectory",
"allow_ndl": true,
"hierarchy_friendly_name": "sys (System)",
"allow_data_sync": true,
"connection_parameters_type": "data/activedirectory",
"hierarchy_path": "sys"
}
},
{
"pkid": "5df34f0cce894e0012c60041",
"meta": {
"tags": [
"base",
"core"
],
"cached": true,
"title": "data/activedirectoryhybrid - device/activedirectoryhybrid",
"business_key": {
"hierarchy": true,
"unique": [
"connection_parameters_type",
"device_model_type"
]
},
"schema_version": "0.1.9",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5df34f0cce894e0012c60041",
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"version_tag": "0.1.0",
"model_type": "data/DeviceModelMapping",
"path": [
"6t0ggef2c0deab00hb595101",
"5df34f0cce894e0012c60041"
],
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/DeviceModelMapping/5df34f0cce894e0012c60041/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"summary_attrs": [
{
"name": "connection_parameters_type",
"title": "Connection Parameters Type"
},
{
"name": "device_model_type",
"title": "Device Model Type"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": [
{
"pkid": "6018facdce894e001163470e",
"version": "0.1.0",
"href": "/api/v0/data/DeviceModelMapping/5df34f0cce894e0012c60041/?cached=6018facdce894e001163470e"
}
]
},
"data": {
"default_helper_params": {
"username": "EXAMPLE\\johnny",
"host": "EXAMPLE\\my-microsoft-instance.microsoft.localhost",
"password": "secret",
"version": "69"
},
"name": "Active Directory Hybrid",
"pkid": "5df34f0cce894e0012c60042",
"dynamic_schema": false,
"device_model_type": "device/activedirectoryhybrid",
"allow_ndl": true,
"hierarchy_friendly_name": "sys (System)",
"allow_data_sync": true,
"connection_parameters_type": "data/activedirectoryhybrid",
"hierarchy_path": "sys"
}
},
{
"pkid": "6130ca6be04a4a00161b4ea7",
"meta": {
"tags": [
"assurance",
"V4UC",
"ba_CommonOverlay"
],
"cached": true,
"title": "data/AssuranceArbitrator - device/arbitrator",
"business_key": {
"hierarchy": true,
"unique": [
"connection_parameters_type",
"device_model_type"
]
},
"schema_version": "0.1.9",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6130ca6be04a4a00161b4ea7",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/DeviceModelMapping/6130ca6be04a4a00161b4ea7/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/DeviceModelMapping",
"path": [
"6t0ggef2c0deab00hb595101",
"6130ca6be04a4a00161b4ea7"
],
"summary_attrs": [
{
"name": "connection_parameters_type",
"title": "Connection Parameters Type"
},
{
"name": "device_model_type",
"title": "Device Model Type"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"default_helper_params": {
"version": "1.0.0"
},
"name": "Assurance Arbitrator",
"generic": true,
"device_model_type": "device/arbitrator",
"pkid": "6130ca6be04a4a00161b4ea8",
"allow_ndl": true,
"hierarchy_friendly_name": "sys (System)",
"allow_data_sync": true,
"connection_parameters_type": "data/AssuranceArbitrator",
"hierarchy_path": "sys"
}
}
]
}
(Show the first instance)
{
"pkid": "5df34f0bce894e0012c6003e",
"meta": {
"tags": [
"base",
"core"
],
"cached": false,
"title": "data/activedirectory - device/activedirectory",
"business_key": {
"hierarchy": true,
"unique": [
"connection_parameters_type",
"device_model_type"
]
},
"schema_version": "0.1.9",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "5df34f0bce894e0012c6003e",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"version_tag": "0.1.1",
"model_type": "data/DeviceModelMapping",
"path": [
"6t0ggef2c0deab00hb595101",
"5df34f0bce894e0012c6003e"
],
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DeviceModelMapping/5df34f0bce894e0012c6003e/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"summary_attrs": [
{
"name": "connection_parameters_type",
"title": "Connection Parameters Type"
},
{
"name": "device_model_type",
"title": "Device Model Type"
},
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": [
{
"pkid": "6018facdce894e001163470f",
"version": "0.1.0",
"href": "/api/v0/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?cached=6018facdce894e001163470f"
},
{
"pkid": "63c6492755f0656d18c24f67",
"version": "0.1.1",
"href": "/api/v0/data/DeviceModelMapping/5df34f0bce894e0012c6003e/?cached=63c6492755f0656d18c24f67"
}
]
},
"data": {
"default_helper_params": {
"username": "EXAMPLE\\johnny",
"host": "EXAMPLE\\my-microsoft-instance.microsoft.localhost",
"password": "secret",
"version": "69"
},
"name": "Active Directory",
"pkid": "5df34f0bce894e0012c6003f",
"dynamic_schema": false,
"device_model_type": "device/activedirectory",
"allow_ndl": true,
"connection_parameters_type": "data/activedirectory",
"allow_data_sync": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DeviceModelMapping. | GET | /api/data/DeviceModelMapping/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DeviceModelMapping as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DeviceModelMapping/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DeviceModelMapping/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DeviceModelMapping/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DeviceModelMapping/?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/DeviceModelMapping; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DeviceModelMapping/[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/DeviceModelMapping and the JSON format can be used to import instances of data/DeviceModelMapping.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DeviceModelMapping/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DeviceModelMapping/[pkid] | hierarchy=[hierarchy] | The data/DeviceModelMapping instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DeviceModelMapping/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DeviceModelMapping. |