Operation
get /data/otn/connectionTemplates/folders
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/folders
Produces
*/*
Example Response Data
[{ "id": 0, "folderId": 0, "root": true, "path": "/", "name": "template_root", "key": "template_root", "folder": true, "owner": "admin", "isUserFolder": false, "isSystemFolder": false, "isPublished": true }, { "id": 1, "folderId": 1, "parent": 0, "path": "/Best Practices", "name": "Best Practices", "key": "Best Practices", "folder": true, "owner": "admin", "isUserFolder": false, "isSystemFolder": true, "isPublished": true }, { "id": 2, "folderId": 2, "parent": 0, "path": "/My Templates", "name": "My Templates", "key": "My Templates", "folder": true, "owner": "admin", "isUserFolder": true, "isSystemFolder": false, "isPublished": false }, { "id": 3, "folderId": 3, "parent": 0, "path": "/Published", "name": "Published", "key": "Published", "folder": true, "owner": "admin", "isUserFolder": true, "isSystemFolder": false, "isPublished": true }, { "id": 102, "folderId": 102, "parent": 1, "path": "/Best Practices/Infrastructure Trail", "name": "Infrastructure Trail", "key": "Infrastructure Trail", "folder": true, "owner": "system", "isUserFolder": false, "isSystemFolder": true, "isPublished": true }, { "id": 103, "folderId": 103, "parent": 102, "path": "/Best Practices/Infrastructure Trail/Unprotected", "name": "Unprotected", "key": "Unprotected", "folder": true, "owner": "system", "isUserFolder": false, "isSystemFolder": true, "isPublished": true }]
External Docs
Operation
get /data/otn/connectionTemplates/folders/{folderId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderId | required | folder Id can be retrieved from '/data/otn/connectionTemplates/folders'REST call as ID | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
nodeType | optional | nodeType can be retrieved from '/data/npr/{table}' (type=nes) REST call as emleNeType |
folderType | optional | folderType: true, false |
publish | required | publish: true, false |
page | required | page: Deploy |
tmpltype | required | tmpltype: ServiceInfrastructureTemplate |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ObjectNode]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/folders/1?page=Deploy&publish=true
Produces
*/*
Example Response Data
[{ id: 1031, parent: 103, name: "ODUk", key: "ODUk", path: "/Best Practices/Infrastructure Trail/Unprotected", folder: false, folderId: 103, templateId: 1, owner: "system", lastModifiedTime: 1470757369, templateType: "Connection", isPublished: true, description: "" }, { id: 1032, parent: 103, name: "OCS Uplink ODUk", key: "OCS Uplink ODUk", path: "/Best Practices/Infrastructure Trail/Unprotected", folder: false, folderId: 103, templateId: 2, owner: "system", lastModifiedTime: 1470757369, templateType: "Connection", isPublished: true, description: "" }, { id: 1033, parent: 103, name: "ODUk with L0 Restoration", key: "ODUk with L0 Restoration", path: "/Best Practices/Infrastructure Trail/Unprotected", folder: false, folderId: 103, templateId: 3, owner: "system", lastModifiedTime: 1470757369, templateType: "Connection", isPublished: true, description: "" }]
Operation
get /data/otn/connectionTemplates/{templateName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
templateName | required | templateName | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
folder | optional | folder |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Response
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/ODUk?folder=/Best%20Practices/Infrastructure%20Trail/Unprotected
Produces
*/*
Example Response Data
{ reqCompletionStatus: 11, requestId: 8888, clientName: "NBI", clientLocation: null, clientUser: "NBIUser", sessionId: "", mdcId: null, sequenceNum: 0, moreToCome: false, messages: [], errcde: null, errorParams: null, folderFullName: "/Best Practices/Infrastructure Trail/Unprotected", templateName: "ODUk", data: { aConnData: [{ name: "protectiontype", value: "9", type: "Enum", className: "ProtectionType", idlname: "ProtectionType_T", idlvalue: "9" }, { name: "connshape", value: "8", type: "Enum", className: "ConnectionShape", idlname: "ConnectionShape_T", idlvalue: "8" }, { name: "connectionCategory", value: "true", type: "Enum", className: "", idlname: "connectionCategory", idlvalue: "1" }], assuranceParameters: [{ name: "alarmEnable", value: "NOTSET", type: "Enum", className: "AssignAlarmProfile", idlname: "isAlarmProfileEnabled", idlvalue: "notset" }, { name: "AutoInServiceTimer", value: "Default", type: "String", className: "", idlname: "AutoInServiceTimer", idlvalue: "Default" }, { name: "pm15min", value: "false", type: "Boolean", className: "", idlname: "pm15MinuteCollectionType", idlvalue: "Disabled" }, { name: "pm24hr", value: "true", type: "Boolean", className: "", idlname: "pm24HourCollectionType", idlvalue: "Enabled" }], sbnConnParams: [{ name: "reversionTimer", value: "N/A", type: "String", className: "", idlname: "", idlvalue: "N/A" }, { name: "preferredRestorationMode", value: "norestore", type: "Enum", className: "PreferRestorationMode", idlname: "preferredRestorationMode", idlvalue: "Unprotected" }, { name: "reversionMode", value: "ReversionMode_NA", type: "Enum", className: "ReversionMode", idlname: "reversionMode", idlvalue: "Manual" }, { name: "waitForServerRestoration", value: "N/A", type: "String", className: "", idlname: "waitForServerRestoration", idlvalue: "N/A" }], miscConnectionParameters: [{ name: "clientprotectiontype", value: "0", type: "Enum", className: "SNCClientProtectionType", idlname: "clientProtectionType", idlvalue: "None" }, { name: "autoInService", value: "Enable", type: "Enum", className: "AutoInService", idlname: "AutoInService", idlvalue: "Yes" }], miscTransmissionParameters: [{ name: "servicerate", value: "ODU2", type: "String", className: "", idlname: "signalType", idlvalue: "ODU2" }, { name: "signalType", value: "Default", type: "String", className: "", idlname: "signalType", idlvalue: "Default" }, { name: "wavekeyConfig", value: "Auto", type: "String", className: "", idlname: "", idlvalue: "Auto" }, { name: "xmnActualBitRate", value: "Default", type: "String", className: "", idlname: "ProvisionedBitRate", idlvalue: "Default" }] }, failReason: "", failMessage: "", successfulCompletion: true, failedCompletion: false }
External Docs
Operation
get /data/otn/connectionTemplates/templates/{templateId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
templateId | required | 'templateId' can be retrieved as 'id' from the REST call '/data/otn/connectionTemplates/folders/{folderId}/templates' | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | pageType |
tmpltype | optional | tmpltype |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
TemplateObject
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/templates/42
Produces
*/*
Example Response Data
{ "data": { "groups": [{ "groupname": "ASONParams", "paramList": [{ "name": "ASONRouted", "value": false, "type": "Boolean", "label": "ASON Routed" }, { "name": "preferredRestorationMode", "value": "norestore", "type": "Enum", "label": "ASON Restoration", "className": "PreferRestorationMode" }, { "name": "reversionMode", "value": "ReversionMode_NA", "type": "Enum", "label": "ASON Revertive", "className": "ReversionMode" }, { "name": "waitForServerRestoration", "value": "N/A", "type": "String", "label": "Wait For Server Restoration" }] }, { "groupname": "protectionParams", "paramList": [{ "name": "protectiontype", "value": "9", "type": "Enum", "label": "Protection Type", "className": "ProtectionType" }, { "name": "networkProtectionMode", "value": "0", "type": "Enum", "label": "Network Protection Mode", "className": "WdmSncProtectionType" }, { "name": "clientprotectiontype", "value": "0", "type": "Enum", "label": "Client Protection Mode", "className": "SNCClientProtectionType" }, { "name": "switchType", "value": "0", "type": "Enum", "label": "Protection Switch Type", "className": "WdmSwitchMode" }, { "name": "revertive", "value": "2", "type": "Enum", "label": "Protection Reversion Mode", "className": "WdmReversionMode" }, { "name": "reversionTimer", "value": "N/A", "type": "String", "label": "Protection Reversion Timer" }] }, { "groupname": "assuranceParams", "paramList": [{ "name": "alarmEnable", "value": "NOTSET", "type": "Enum", "label": "Alarm Profile", "className": "AssignAlarmProfile" }, { "name": "autoInService", "value": "Enable", "type": "Enum", "label": "Set Service State", "className": "AutoInService" }, { "name": "AutoInServiceTimer", "value": "Default", "type": "String", "label": "AINS Timer" }, { "name": "pm15min", "value": false, "type": "Boolean", "label": "15min PM Collection" }, { "name": "pm24hr", "value": true, "type": "Boolean", "label": "24h PM Collection" }] }, { "groupname": "odukParams", "paramList": [{ "name": "containerrate", "value": "Default", "type": "String", "label": "Container" }, { "name": "LOSPropagation", "value": "BothAZ", "type": "Enum", "label": "LOS Propagation", "className": "NtwConnProvWizLOSPropagation" }, { "name": "xmnActualBitRate", "value": "Default", "type": "String", "label": "Provisioned Bit Rate" }] }, { "groupname": "connectionParams", "paramList": [{ "name": "serviceratetype", "value": "SONET", "type": "Enum", "label": "Service Rate Type", "className": "NtwConnProvWizServiceGroup" }, { "name": "servicerate", "value": "Default", "type": "String", "label": "Service Rate" }, { "name": "signalType", "value": "Default", "type": "String", "label": "Signal Type" }, { "name": "connshape", "value": "8", "type": "Enum", "label": "Connection Shape", "className": "ConnectionShape" }, { "name": "fecMode", "value": "N/A", "type": "String", "label": "FEC Mode" }, { "name": "wavekeyConfig", "value": "N/A", "type": "String", "label": "Wavekey Mode" }] }] }, "info": { "className": "connectionTemplate", "guiLabel": "OC-N", "id": 42, "key": "42/connectionTemplate", "page": "", "folderId": 127, "name": "OC-N", "folder": "/Best Practices/Service/SONET/Unprotected", "owner": "system", "lastmodified": "2016-03-25 13:16:34", "templateType": "Connection", "isPublished": true, "description": null, "isPublishedL": "Yes" } }
Operation
get /data/otn/connectionTemplates/templates/{folderName}/{templateName}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderName | required | folderName can be retrieved as 'folder' from '/data/otn/connectionTemplates/folders/{folderId}/templates' REST call | --- |
templateName | required | templateName can be retrieved as 'guiLabel' from '/data/otn/connectionTemplates/folders/{folderId}/templates' REST call | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | pageType |
tmpltype | optional | tmpltype |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/templates/Best%20Practices+Infrastructure%20Trail+Unprotected/ODUk
Produces
*/*
Example Response Data
{ templateId: 1, data: { groups: [ { groupname: "protectionParams", paramList: [ { name: "protectiontype", value: "9", type: "Enum", label: "Protection Type", className: "ProtectionType" }, { name: "networkProtectionMode", value: "0", type: "Enum", label: "Network Protection Mode", className: "WdmSncProtectionType" }, { name: "clientprotectiontype", value: "0", type: "Enum", label: "Client Protection Mode", className: "SNCClientProtectionType" }, { name: "switchType", value: "0", type: "Enum", label: "Protection Switch Type", className: "WdmSwitchMode" }, { name: "revertive", value: "2", type: "Enum", label: "Protection Reversion Mode", className: "WdmReversionMode" }, { name: "reversionTimer", value: "N/A", type: "String", label: "Protection Reversion Timer" } ] }, { groupname: "connectionParams", paramList: [ { name: "serviceratetype", value: "Trail", type: "Enum", label: "Service Rate Type", className: "NtwConnProvWizServiceGroup" }, { name: "servicerate", value: "ODU2", type: "String", label: "Service Rate" }, { name: "signalType", value: "Default", type: "String", label: "Signal Type" }, { name: "connshape", value: "8", type: "Enum", label: "Connection Shape", className: "ConnectionShape" }, { name: "lopc", value: false, type: "Boolean", label: "Logical Link" }, { name: "fecMode", value: "Default", type: "String", label: "FEC Mode" }, { name: "wavekeyConfig", value: "Auto", type: "String", label: "Wavekey Mode" }, { name: "provwavekey", value: "ProvisionWavekey_key", type: "Enum", label: "Provisionable Wave Key", className: "ProvWaveKey" }, { name: "mrntunnel", value: false, type: "Boolean", label: "MRN Tunnel" } ] }, { groupname: "odukParams", paramList: [ { name: "containerrate", value: "Default", type: "String", label: "Container" }, { name: "LOSPropagation", value: "UseNEValue", type: "Enum", label: "LOS Propagation", className: "NtwConnProvWizLOSPropagation" }, { name: "xmnActualBitRate", value: "Default", type: "String", label: "Provisioned Bit Rate" } ] }, { groupname: "assuranceParams", paramList: [ { name: "alarmEnable", value: "NOTSET", type: "Enum", label: "Alarm Profile", className: "AssignAlarmProfile" }, { name: "autoInService", value: "Enable", type: "Enum", label: "Set Service State", className: "AutoInService" }, { name: "AutoInServiceTimer", value: "Default", type: "String", label: "AINS Timer" }, { name: "pm15min", value: false, type: "Boolean", label: "15min PM Collection" }, { name: "pm24hr", value: true, type: "Boolean", label: "24h PM Collection" } ] }, { groupname: "ASONParams", paramList: [ { name: "ASONRouted", value: false, type: "Boolean", label: "ASON Routed" }, { name: "preferredRestorationMode", value: "norestore", type: "Enum", label: "ASON Restoration", className: "PreferRestorationMode" }, { name: "reversionMode", value: "ReversionMode_NA", type: "Enum", label: "ASON Revertive", className: "ReversionMode" }, { name: "waitForServerRestoration", value: "N/A", type: "String", label: "Wait For Server Restoration" } ] } ] }, info: { className: "connectionTemplate", guiLabel: "ODUk", id: 1, key: "1/connectionTemplate", page: "", folderId: 103, name: "ODUk", folder: "/Best Practices/Infrastructure Trail/Unprotected", owner: "system", lastmodified: "2016-10-06 22:54:01", templateType: "Connection", isPublished: true, description: null, isPublishedL: "Yes" } }
Operation
get /data/otn/connectionTemplates/folders/{folderId}/templates
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderId | required | 'folderId' as 'folderId' can be retrieved from '/data/otn/connectionTemplates/folders' | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | pageType |
tmpltype | optional | tmpltype |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/folders/1/templates
Produces
*/*
Example Response Data
[{ "className": "connectionTemplate", "guiLabel": "ODUk", "id": 1, "key": "1/connectionTemplate", "page": "", "folderId": 103, "name": "ODUk", "folder": "/Best Practices/Infrastructure Trail/Unprotected", "owner": "system", "lastmodified": "2016-03-25 13:16:34", "templateType": "Connection", "isPublished": true, "description": null, "isPublishedL": "Yes" }, { "className": "connectionTemplate", "guiLabel": "OCS Uplink ODUk", "id": 2, "key": "2/connectionTemplate", "page": "", "folderId": 103, "name": "OCS Uplink ODUk", "folder": "/Best Practices/Infrastructure Trail/Unprotected", "owner": "system", "lastmodified": "2016-03-25 13:16:34", "templateType": "Connection", "isPublished": true, "description": null, "isPublishedL": "Yes" }, { "className": "connectionTemplate", "guiLabel": "ODUk with L0 Restoration", "id": 3, "key": "3/connectionTemplate", "page": "", "folderId": 103, "name": "ODUk with L0 Restoration", "folder": "/Best Practices/Infrastructure Trail/Unprotected", "owner": "system", "lastmodified": "2016-03-25 13:16:34", "templateType": "Connection", "isPublished": true, "description": null, "isPublishedL": "Yes" }, { "className": "connectionTemplate", "guiLabel": "ODUk", "id": 4, "key": "4/connectionTemplate", "page": "", "folderId": 104, "name": "ODUk", "folder": "/Best Practices/Infrastructure Trail/OPSA Protected", "owner": "system", "lastmodified": "2016-03-25 13:16:34", "templateType": "Connection", "isPublished": true, "description": null, "isPublishedL": "Yes" }]
Operation
get /data/otn/connectionTemplates/folders/{folderId}/templates/{templateId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
folderId | required | 'folderId' as 'folderId' can be retrieved from '/data/otn/connectionTemplates/folders' | --- |
templateId | required | 'templateId' can be retrieved as 'id' from the REST call '/data/otn/connectionTemplates/folders/{folderId}/templates' | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
page | optional | pageType |
searchKey | optional | searchKey |
context | optional | context |
tmpltype | optional | tmpltype |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
array[ObjectNode]
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Example Request Data
/data/otn/connectionTemplates/folders/1/templates/42?page=deploy
Produces
*/*
Example Response Data
[{ "className": "connectionTemplate", "guiLabel": "OC-N", "id": 42, "key": "42/connectionTemplate", "page": "", "folderId": 127, "name": "OC-N", "folder": "/Best Practices/Service/SONET/Unprotected", "owner": "system", "lastmodified": "2016-03-25 13:16:34", "templateType": "Connection", "isPublished": true, "description": null, "isPublishedL": "Yes" }]
External Docs
HashMap«string,ArrayList«NBI Template Parameter»»
Name |
Type |
Description |
Enum |
---|
ObjectNode
Name |
Type |
Description |
Enum |
---|---|---|---|
object | Boolean boolean |
--- | --- |
nodeType | String string |
--- | [ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING] |
long | Boolean boolean |
--- | --- |
containerNode | Boolean boolean |
--- | --- |
pojo | Boolean boolean |
--- | --- |
integralNumber | Boolean boolean |
--- | --- |
floatingPointNumber | Boolean boolean |
--- | --- |
short | Boolean boolean |
--- | --- |
bigDecimal | Boolean boolean |
--- | --- |
bigInteger | Boolean boolean |
--- | --- |
textual | Boolean boolean |
--- | --- |
boolean | Boolean boolean |
--- | --- |
number | Boolean boolean |
--- | --- |
binary | Boolean boolean |
--- | --- |
double | Boolean boolean |
--- | --- |
int | Boolean boolean |
--- | --- |
missingNode | Boolean boolean |
--- | --- |
valueNode | Boolean boolean |
--- | --- |
float | Boolean boolean |
--- | --- |
array | Boolean boolean |
--- | --- |
null | Boolean boolean |
--- | --- |
OtnI18nMessage
Name |
Type |
Description |
Enum |
---|---|---|---|
messageTime | Long long |
Message Time | --- |
messageType | String string |
Message Type | [Info, Warning, Error] |
messageUnformatted | String string |
Message Unformatted | --- |
validPropertyResourceMessage | Boolean boolean |
--- | --- |
messageId | String string |
Message Id | --- |
messageParams | array[String] string |
Message Params | --- |
message | String string |
Message | --- |
Response
Name |
Type |
Description |
Enum |
---|---|---|---|
reqCompletionStatus | Integer integer |
A value which indicates completion status of the request | --- |
requestId | Long long |
Id generated for the Request passed | --- |
clientName | String string |
Indicates name of the client | --- |
clientLocation | String string |
Indicates location of the client | --- |
clientUser | String string |
Indicates the client User | --- |
sessionId | String string |
Session Id of the event | --- |
mdcId | String string |
MDC Id,if any | --- |
sequenceNum | Integer integer |
Indicates the sequence Number generated for the response | --- |
moreToCome | Boolean boolean |
Indicates with true/false if more responses are to come | --- |
messages | array[OtnI18nMessage] OtnI18nMessage |
Response Messages,if any from the response like an Info,Warning etc | --- |
errcde | String string |
Indicates error code,if any error generated | --- |
errorParams | array[Object] object |
Indicates different error parameters,if any error generated | --- |
folderFullName | String string |
--- | --- |
templateName | String string |
--- | --- |
data | HashMap«string,ArrayList«NBI Template Parameter»» HashMap«string,ArrayList«NBI Template Parameter»» |
--- | --- |
failReason | String string |
--- | --- |
failMessage | String string |
--- | --- |
failedCompletion | Boolean boolean |
Indicates response completion failed with true/false | --- |
successfulCompletion | Boolean boolean |
Indicates successful response completion with true/false | --- |
timeout | Long long |
--- | --- |
nadString | String string |
--- | --- |