Summary
Get a smart template by ID
Description
Get a Smart Template using its ID
Route
GET /smart_template/id/:id
Roles
admin
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
id |
string |
yes |
Database ID for smart template |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
smart_template |
object |
Smart Template Entity |
Copied to Clipboard
{
"_id": "893680a2-15b5-d9b0-c6c1-f6a153ae8208",
"form": {
"name": "Form 123",
"children": [
{
"properties": {
"type": "leafref",
"path": "/ncs:devices/ncs:device/ncs:name",
"min": "1",
"max": "4",
"minLength": null,
"maxLength": "4",
"default": null,
"direction": "vertical",
"required": false,
"enforce": false,
"hidden": false
},
"id": "in",
"type": "container",
"element": "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}",
"name": "vlan_id_123",
"display_name": "vlan",
"source_type": "service_model",
"source": "/ncs:services/abc_devices:ios.device",
"key": "key545385c3-fc66-491b-bf6f-abc2214366dc"
},
{
"properties": {
"type": "leafref",
"path": "/ncs:devices/ncs:device/ncs:name",
"min": "1",
"max": null,
"minLength": "1",
"maxLength": "4",
"default": "enim",
"direction": "vertical",
"required": true,
"enforce": false,
"hidden": true
},
"id": "mollit ea et",
"type": "container",
"element": "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}",
"name": "vlan_id_123",
"display_name": "vlan",
"source_type": "service_model",
"source": "/ncs:services/abc_devices:ios.device",
"key": "service.vlanid"
},
{
"properties": {
"type": "leafref",
"path": "/ncs:devices/ncs:device/ncs:name",
"min": null,
"max": null,
"minLength": "1",
"maxLength": "4",
"default": true,
"direction": "vertical",
"required": true,
"enforce": false,
"hidden": false
},
"id": "tempor sunt",
"type": "container",
"element": "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}",
"name": "vlan_id_123",
"display_name": "vlan",
"source_type": "service_model",
"source": "/ncs:services/abc_devices:ios.device",
"key": "service.vlanid"
}
],
"elements": [
{
"type": "service_model",
"id": {
"name": "/ncs:services/test_devices:service_name"
}
},
{
"type": "service_model",
"id": {
"name": "/ncs:services/test_devices:service_name"
}
},
{
"type": "service_model",
"id": {
"name": "/ncs:services/test_devices:service_name"
}
}
],
"_id": "23dd3d03-02b8-24e1-8055-cb62081a55ca",
"groups": [
"f85f8262b9dbeec271013c9a",
"1354eb916ccc6f01ac25f8b8",
"2a6e539683c8eb4b4cb53d0b",
"448d53b22265c01a697b47be"
],
"created": "1986-10-12T23:37:35.931Z",
"created_by": "48d126dbf0b73ebe69427672",
"last_updated": "1972-02-25T09:59:49.592Z",
"last_updated_by": "131af13c3d01919ca4cfa721",
"tags": [
"culpa",
"laboris ut",
"id",
"sunt non esse",
"veniam"
]
},
"faml": {
"_attr": {
"type": "keyword",
"ns": "http://tail-f.com/ns/ncs",
"prefix": "ios",
"condition": "cant",
"severity": "error"
}
},
"name": "sCvI",
"native": "interface GigabitEthernet 1",
"os": "eos",
"created": "1538727115252",
"create_by": "tbj"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"_id": {
"type": "string",
"pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$"
},
"form": {
"$ref": "formDocument"
},
"faml": {
"oneOf": [
{
"$ref": "famlObject#/definitions/famlLeaf"
},
{
"$ref": "famlObject#/definitions/famlContainer"
},
{
"$ref": "famlObject#/definitions/famlList"
}
]
},
"name": {
"type": "string",
"pattern": "[A-Za-z]+"
},
"native": {
"type": "string",
"enum": [
"hostname itential",
"interface GigabitEthernet 1"
]
},
"os": {
"type": "string",
"enum": [
"cisco-ios, cisco-iosxr",
"eos",
"junos"
]
},
"create_by": {
"type": "string",
"pattern": "[A-Za-z]+"
},
"created": {
"type": "string",
"pattern": "1[1-9]{12}"
}
},
"required": [
"_id",
"form",
"faml",
"name",
"native",
"os",
"created_by",
"created"
]
}