Operation

delete /cas/v1/tickets/{TGT-ID}
casLogout (casLogout : /cas/v1/tickets/{TGT-ID})
This step is to logout from CAS


Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    DELETE / HTTP/1.1 Host: https://{{serverIp}}/cas/v1/tickets/TGT-4666-kX4UlDciYtFwoDA7MLCJrYBTpjtTtqKkvOfhP0fOp3vhxrbLSV-otneVM1noc Host: 135.250.141.189 Referer: https://{{serverIp}}:8443/oms1350/pages/otn/mainOtn

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response TGT-4666-kX4UlDciYtFwoDA7MLCJrYBTpjtTtqKkvOfhP0fOp3vhxrbLSV-otneVM1noc

    External Docs
    See Also :

    Operation

    get /oms1350/data/common/logout
    commonLogout (commonLogout : /oms1350/data/common/logout)
    This step is to logout from NFM-T


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /oms1350/data/common/logout?= HTTP/1.1 Host: 135.250.207.50:8443 Referer: https://135.250.207.50:8443/oms1350/pages/otn/mainOtn cache-control: no-cache Postman-Token: b7f0773a-900f-4fc8-90b5-737b38d9d796

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    <!doctype html><html><head><meta charset="utf-8"><title>Sign in</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><link rel="icon" href="" /><link rel="stylesheet" type="text/css" href="main.css"></head> <style> @font-face { font-family: 'NokiaPureText'; font-weight: 200; src: url('./font/NokiaPureText-Light.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; src: url('./font/NokiaPureText-Regular.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; font-weight: bold; src: url('./font/NokiaPureText-Medium.woff'); } @font-face { font-family: 'NokiaPureHeadline'; font-weight: 200; src: url('./font/NokiaPureHeadline_Light.woff') format('woff'); } html,body{ width: 100%; height: 100%; margin: 0; padding: 0; } </style><body><div style="display: none" id="cUsername" value=""></div><div style="display: none"> </div><div style="display: none" id="execution" value="24479514-1196-48b9-8100-5573779a7ce1_ZXlKaG kuZUdZMFYybzRUMlp6WWt0NFFVRm1VbmhNV2xwbFJWWnhOV1Y0TDJKNmR6Y3hOVnBxTmtabVQxTkNjRWRWTVhadVVrSkdZakox xKU1pITkRTVWR5UlV4NE4ycFlTak5OZDA1RFFXVnVRelJFVVhreVpHNVphV1UxTDJkRGNITnNNR3gwVFc1TlVGZExNMlowUTIx bE1TRmd2S3pOTk1GaHhjalp4WmtSQlRYTlVhMDQzVWtNMmVUaDJUV3h1WWxKUWVrOW1hWFZHYkRCRllsWmxXV2hpVVhndk1sWm XSHB0YUVRM2NFWlFWMGhOZGpOVGRtUm9TMmx0WjB4V1FrNTFVVlExT1hObmVtcG9ja2hWTDJ0U2NtUkllRFZUVm1wWFVqSnpkR 0WjFsSlFXUnJUM3BWWWk4MWVWTjZjMWwwVms5NFpVZFpjamh5VjNFdlRqUTJVSEo1Y2taMmFsUTJRMjEzTmt0c1owUnpUVzV2Z </div><div style="display: none" id="_eventId" value="submit"></div><div style="display: none" id="geolocation"></div><div id="root" style="height:100%;"></div><script src="./bundle.js"> </script></body></html>

    External Docs
    See Also :

    Operation

    post /oms1350/data/cpb/deauthenticate
    deAuthenticate (deAuthenticate : /oms1350/data/cpb/deauthenticate)
    This step is to deauthenticate from NFM-T system


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST /oms1350/data/cpb/deauthenticate HTTP/1.1 Host: {{serverIp}}:8443 Referer: https://{{serverIp}}:8443/oms1350/pages/otn/mainOtn cache-control: no-cache Postman-Token: 8ea052e9-a076-4425-8f9d-ac3742f490a

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response Ok

    External Docs
    See Also :

    Operation

    post /rest-gateway/rest/api/v1/auth/token
    getAuthenticate (getAuthenticate : /rest-gateway/rest/api/v1/auth/token)
    Single step authentication is specifically designed to be used for NBI. The authentication POST request uses Basic authorization and implements a string in base64 encoding, used to encode the username and password. The access_token lasts for 3600 seconds mentioned in expires_in attribute of the response. Once the token expires, to continue the communication, a new token can be requested. Alternatively, prior to that time expiring, send a post request with the “refresh token” which will generate a new Bearer token that is valid for another “expire_in” seconds without needing to resend credentials using basic authentication.If this API is used for authentication, subsequent API calls to NFMT should additionally pass Bearer token in the header.Note:It is mandatory to revoke the token at the end of usage,a clean sign out mechanism for single step and no need to pass the cookie.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required grant_type=client_credentials String ---
    body2 required grant_type=refresh_token&refresh_token={{refreshToken}} String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST https://{{serverIp}}/rest-gateway/rest/api/v1/auth/token HTTP/1.1 Host: {{serverIp}} Content-Type: application/x-www-form-urlencoded Authorization: Basic YWxjYXRlbDpMdWNlbnQxLiE= User-Agent: PostmanRuntime/7.20.1 Accept: */* Cache-Control: no-cache Postman-Token: 69cea9f2-4b70-4ef2-87ed-6fa4665a377d,8cc87f23-ca57-4ba6-b43d-290c4bc79e2a Host: {{serverIp}} Accept-Encoding: gzip, deflate Content-Length: 29 Connection: keep-alive cache-control: no-cache { grant_type=client_credentials } Refresh token POST https://{{serverIp}}/rest-gateway/rest/api/v1/auth/token HTTP/1.1 Host: 135.249.190.107 Content-Type: application/x-www-form-urlencoded Authorization: Basic YWRtaW46Tm9raWExLiE= User-Agent: PostmanRuntime/7.20.1 Accept: */* Cache-Control: no-cache Postman-Token: 15b61337-9938-4340-bf27-88e2c91ee481,f26b5552-f549-4665-b2dc-8746c5099955 Host: 135.250.207.50 Accept-Encoding: gzip, deflate Content-Length: 52 Connection: keep-alive cache-control: no-cache { "grant_type":"refresh_token", "refresh_token":"{{refresh_token}}" }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "access_token": "VEtOLWFsY2F0ZWwzOTIzMjhiYS03MmJiLTRlNGItYWMxZi1lMWM4NGEzNDEwNzE=", "refresh_token": "UkVUS04tYWxjYXRlbDE5YmQxYWY3LTQ3NjMtNGIxMi05OGNlLTI3M2ZjMzJlMjlmZQ==", "token_type": "Bearer", "expires_in": 3600 } Refresh Token { "access_token": "VEtOLWFsY2F0ZWwzOTIzMjhiYS03MmJiLTRlNGItYWMxZi1lMWM4NGEzNDEwdeE=", "refresh_token": "UkVUS04tYWxjYXRlbDE5YmQxYWY3LTQ3NjMtNGIxMi05OGNlLTI3M2ZjMzJlMjlmZQ==", "token_type": "Bearer", "expires_in": 3600 }

    External Docs
    See Also :

    Operation

    post /cas/v1/tickets/{TG-ID}
    getLoginCas (getLoginCas : /cas/v1/tickets/{TG-ID})
    This is the fifth step of the authentication.Once the TGT-ID is obtained as response in the previous second step.HTTP POST method on TGT URL to get ServiceTicket for Session Manager NFM-T, which returns the service ticket

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    service required https://{{otneIP}}:8443/oms1350/login/cas String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST /cas/v1/tickets/TGT-209-XmlOyIpsUWLadV6wBjNVswLYxRIa6Pb1za4gIgdlbbSpoNho7j-otneVM1 HTTP/1.1 Host: {{serverIp}}:443 Content-Type: application/x-www-form-urlencoded cache-control: no-cache Postman-Token: 1e70c413-062d-48a9-abaf-f996e3511ebe service=https%3A%2F%2F135.250.203.134%3A8443%2Foms1350%2Flogin%2Fcasundefined=undefined

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    ST-212-qYalbpzVHZG9X3Pd1LPE-otneVM1

    External Docs
    See Also :

    Operation

    get /oms1350/login/cas
    getOmsLoginCas (getOmsLoginCas : /oms1350/login/cas)
    This is the sixth step of authentication.Once the service ticket is obtained as response in the previous step , HTTP GET method on SessionManager URL to validate the ServiceTicket NFM-T.(Here the Request Header, Host = Input the IP address of the server or the DNS name of the server (if FQDN is installed) as applicable).

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ticket required ST-LOC ---
    host required Ip Address of Server or the DNS name of the server ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    GET /oms1350/login/cas?ticket=ST-212-qYalbpzVHZG9X3Pd1LPE-otneVM1 HTTP/1.1 Host: {{serverIp}}:8443 Host: {{serverIp}}:8443 cache-control: no-cache Postman-Token: 0090fcd5-89eb-4575-82f9-39a8fb520156

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    <!DOCTYPE HTML> <!-- Note: (5/30/2013, PHM) Currently, Main_Otn.html and Main_Otn.vm are identical. I intend to keep it that way until we begin to use some specific .vm (velocity) functionality TODO: (7JUL2013) Get menu items from a JSON file/object, based upon user preferences. --> <html lang="en" spellcheck="false"> <head> <meta charset="utf-8"> <title>NFM-T</title> <!-- VELOCITY_BEGIN: common.vm --> <!-- Get IE out of Compatibility View mode: It will not load pages properly using "computername". (localhost is ok) --> <meta http-equiv="X-UA-Compatible" content="IE=Edge" spellcheck="false"/> <script type="text/javascript" > <!-- VELOCITY_BEGIN: try.vm --> try { <!-- VELOCITY_END : try.vm --> <!-- VELOCITY_BEGIN: pageLocalVars.vm --> <!-- VELOCITY_BEGIN: try.vm --> try { <!-- VELOCITY_END : try.vm --> /************************************************** * Use the data provided the servlet/controller * This exact code should be included in all pages * *** IMPORTANT NOTE: *** * Because of breadcrumb internationalization, URL can contain strings in double quotes (""). * So, in this file it is mandatory the usage of single quotes to represent strings that come * from velocity variables ($VM...) to avoid syntax errors. * e.g. * var G_queryParamsAsString = 'initLocalStorage=true'; * could actually be expanded by velocity as: * var G_queryParamsAsString = 'component=npr&resources=nodes&tab=NEs&title="Operate"|"Nodes"'; * * In this case specifying: * var G_queryParamsAsString = "initLocalStorage=true"; * (in double quotes) would NOT work!!! (issue: OMSSW-78490 [List] Stand-alone list with 360 view doesn't display) **************************************************/ // used by OtnDojoConfig.js && most vm pages to locate webapp files. var G_webAppContext = '/oms1350'; var G_webAppName = '/oms1350'; var G_pageName = '_pages_mainOtn' + '.vm'; var G_pageContentArea = 'content__pages_mainOtn_0314_065533_316_15991'; var G_uniquePageId = 'content__pages_mainOtn_0314_065533_316_15991'; var G_HostName = 'otneVM1'; var G_RunningInUnitTest = '$VM_RunningInUnitTest'; var G_queryParamsAsString = 'initLocalStorage=true'; //var G_queryParamsAsObject = '{initLocalStorage=true}'; ///////////////////////////////////////////////////////////////// // All query params can now be accessed via a couple of methods. // Say we have ?connectionId=112 // The value can be access by these options // var a1 = G_queryParamsAsObject.connectionId // var a2 = G_queryParamsAsObject["connectionId"] // var myArray = G_queryParamsAsObject; // for (var i in myArray) { // alert('key is: ' + i + ', value is: ' + myArray[i]); // } ///////////////////////////////////////////////////////////////// /* Create a JS object with each query parameter as an attribute. */ var G_queryParamsAsObject = function(){}; G_queryParamsAsObject.initLocalStorage = 'true'; // Information about the OMS component server. (mostly used for unit testing) var G_HostIp = '135.250.203.134'; var G_HostPort = '$VM_HostPort'; // Information about the current user var G_UserLocale = 'en_US'; var G_SystemParam_ShowCustName ='YES'; var G_TimeZoneOffset = "ClientLocal"; try { G_TimeZoneOffset = ClientLocal; } catch(e) { // In case Server does not define this variable ignore the exception and use default "ClientLocal"; } var G_gpcEnabled = 'false'; var G_gpcProvEnabled = 'false'; var G_nrctEnabled = 'false'; var G_olcStateEnabled = 'ENABLED'; </html>

    External Docs
    See Also :

    Operation

    post /cas/v1/tickets/{TGT-ID}
    getServiceTicketFromCas (getServiceTicketFromCas : /cas/v1/tickets/{TGT-ID})
    This is the second step of authentication.Once the TGT-ID is obtained as response in the previous step from the CAS server, HTTP POST method on TGT URL to get ServiceTicket for Session Manager nspOS and this returns a service ticket.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    tGTID required TGT-ID ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    service required NFM-T Server Base path or root URL(https://{{server}}/session-manager/login/cas) String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST /cas/v1/tickets//TGT-206-Cy6rCoPik6BkCftS0yRHZdt5xcPgJraduj6AH16oI5z6XwC5po-otneVM1 HTTP/1.1 Host: {{serverIp}} Content-Type: application/x-www-form-urlencoded cache-control: no-cache Postman-Token: ce5cc35f-7a5a-4b6b-90ca-3c01487c0d4f service=https%3A%2F%2F{{serverIp}}%2Fsession-manager%2Flogin%2Fcasundefined=undefined

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    ST-208-LNZ2l2YGn5U6dQyQuJTR-otneVM1

    External Docs
    See Also :

    Operation

    get /oms1350/data/common/sessionInfo
    getSessionInfo (getSessionInfo : /oms1350/data/common/sessionInfo)
    This is the final step of the authentication.HTTP GET request to register the Session in NFM-T


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /oms1350/data/common/sessionInfo?service= HTTP/1.1 Host: {{serverIp}}:8443 cache-control: no-cache Postman-Token: 986a713f-cb87-4396-ac9f-52e405940fbe

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    { "userId": "admin", "sessionId": "4e1203262e2545e38a098cfa1ae5965d", "channelName": "/omsevents/usession/4e1203262e2545e38a098cfa1ae5965d", "fadList": [ "NERemoteConfig", "ShowSWStatus", "esm_modify_erp", "ManageStaticLink", "ForceActivateSw", "GetNeTime", "AlarmDebounceModify", "SetMeTime", "DeleteME", "esm_prov_tunnel", "CreateJob", "GlobalAlignDownwards", "esm_prov_mclag", "removeSubnet", "MapNodeMovement", "ModifyRNEIndex", "ViewSwdlJobReport", "GetSwPkg", "AdvancedConstruct", "wdm_performanceManagementFunction", "Map_FUNCTION_admin_operator", "ManageNEInventory", "GetNeList", "OSAddressRW", "ShowInformations", "SwStatusSwdlJob", "CreateSwdlSession", "RunPerfMon_15m", "cpb_operationFunction", "AbortSwdlSession", "Cmd_MapInv_SbnListNodes", "F_DELETE_CUSTOMER_TEMPLATE", "esm_prov_npa", "InternalCmd_MapView_View_ZoomIn", "OSAddressRO", "Cmd_TM_FUNCTION_allUser", "esm_modify_lag", "AlignUpwards", "DeleteSwdlNes", "InternalCmd_MapView_Obj_Undo", "ShowBkupSession", "CreateDynamicLink", "ViewRestoreJobReport", "DisplayRI", "PathBuild", "ManageMonitoring", "ShowRestoreNes", "ManageMeTime", "SysMonRead", "DeleteBkpNes", "DeleteSwdlSession", "RemoveGeneric", "ShowSwdlNes", "ManageNTP", "Cmd_CLOG_Admin_Header_P", "ShowEqp", "DeleteBkpSession", "DeleteRestoreSession", "Cmd_CLOG_Admin_Header", "ManageNEPopulation", "GetSwStatusByType", "ShowIsaSWStatus", "MEAddressRW", "ActivateSw", "esm_generate_pm_report", "Cmd_Inv_LinkListConnections", "Cmd_MapNav_ObjPtrToNPAview", "Cmd_CLOG_Ack", "MSGUI_FUNCTION_ADMIN_TOPOLOGICALVIEWS", "PingNE", "esm_modify_mclag", "AbortJob", "ManualAlignDownwards", "Cmd_MapInv_ListTopLevelNtws_PHY_TOPVIEW", "Cmd_MapInv_SbnListChildSbns", "ShowRestoreSession", "Cmd_MapAct_SbnRemoveNode", "F_ADD_CUSTOMER_TEMPLATE", "ManageAccess", "CreateBkupSessionWizard", "CreateRestoreSessionWizard", "ShowJobList", "MigrateME", "OpenJobWizard", "Cmd_TM_FUNCTION_admin_construct", "SysMonAdmin", "ModifyLocation", "wdm_neManagementFunction", "OpenGetSwByTypeWizard", "ModifyME", "Cmd_MapNav_OpcToMap", "NavigationToELM", "Cmd_MapAct_SbnDeleteSbnAndSubordinates", "AbortNe", "Cmd_CLOG_User_Header", "MultipleNeDownload", "Cmd_TM_FUNCTION_admin_construct_operator", "Admin", "AddSwdlNes", "saveSubnet", "wdm_legacyManagementFunction", "GetSwdl", "Cmd_MapInv_SbnCreateMap", "Cmd_MapAct_SbnCommitMapModify", "Cmd_MapInv_ListTopLevelNtws_PHY_Test", "esm_prov_customer", "physconnInNet", "UploadRemoteInventory", "GetSwDetail", "ActiveJob", "NEInventory", "ManageResynchro", "RunPerfMon_hour", "Cmd_MapWiz_ModifySubnet", "AbortBkupSession", "GetNeLabel", "SetNeTime", "InternalCmd_MapView_View_ZoomOut", "NavigationToEquipments", "ManageFilter", "ViewBkupJobReport", "DeleteSw", "wdm_inventoryFunction", "ManageLocalAccess", "NetworkAddressRW", "esm_job_reschedule", "AddBkpNes", "SysMonView", "esm_design_template", "Cmd_MapInv_PopulateSbnsInTree_PHY", "addSubnet", "InternalCmd_MapView_Obj_Redo", "Cmd_MapInv_ShowOpcView", "NetworkAddressRO", "esm_design_feature", "InternalCmd_MapView_View_ZoomBestFit", "AlarmDebounceView", "EditSwdlJobWizard", "CreatePartialSwdlJob", "ModifyACD", "NavigationToURLs", "EMLInventory", "viewMap", "Cmd_TM_FUNCTION_admin", "esm_prov_service", "Cmd_MapAct_SbnAddNode", "DeleteRestoreNes", "ActiveSoftware", "NavigationToHostNe", "AdvancedViewer", "wdm_alarmManagementFunction", "AllUsers", "CreateSUBNE", "ShowSwdlSession", "EditJob", "ManageSupervision", "CreateNE", "esm_modify_tunnel", "ModifyUserLabel", "Cmd_MapWiz_SbnCreateSimple", "esm_modify_npa", "GetNeType", "Cmd_MapAct_DataSynchronize", "OpenGetSwByNameWizard", "InternalCmd_MapView_View_ChangeBackground", "ResynchroAll", "RunPerfMon_day", "MulitpleNeBackup", "ModifyComments", "CreatePartialSwdlJobFromNeList", "F_MODIFY_CUSTOMER_TEMPLATE", "ManageLinkInventory", "GetFtServer", "esm_modify_service", "ManageMib", "EditRestorJobWizard", "esm_deploy_networkConfig", "Cmd_EventParameter", "ShowJobStatus", "ShowStatuses", "addNode", "Cmd_CLOG_User_Header_P", "NavigationToAlarms", "InternalCmd_MapView_Obj_Save", "EditBkupJobWizard", "InternalCmd_MapView_View_SwitchLayer", "CreateRestoreSession", "esm_job_delete", "esm_prov_erp", "Cmd_MapCrt_SbnCreate", "Cmd_MapInv_ListObjsForCreateSbn", "GetSwStatusByName", "CreateSwdlSessionWizard", "DirInventory", "removeNode", "ManageAdmin", "esm_prov_lag", "DeleteJob", "CreateBkupSession", "wdm_provisionFunction", "ManageClone", "modifySubnet", "CommitSw", "CreateME", "ShowAlarms", "InternalCmd_MapView_View_NormalSize", "CreateRNE", "InternalCmd_MapView_View_Miniature", "ShowBackupNes", "Construct", "Cmd_Inv_SbnListPhyconnections", "NERemoteConfig", "ShowSWStatus", "esm_modify_erp", "ManageStaticLink", "ForceActivateSw", "GetNeTime", "AlarmDebounceModify", "SetMeTime", "DeleteME", "esm_prov_tunnel", "CreateJob", "GlobalAlignDownwards", "esm_prov_mclag", "removeSubnet", "MapNodeMovement", "ModifyRNEIndex", "ViewSwdlJobReport", "GetSwPkg", "AdvancedConstruct", "wdm_performanceManagementFunction", "Map_FUNCTION_admin_operator", "ManageNEInventory", "GetNeList", "OSAddressRW", "ShowInformations", "SwStatusSwdlJob", "CreateSwdlSession", "RunPerfMon_15m", "cpb_operationFunction", "AbortSwdlSession", "Cmd_MapInv_SbnListNodes", "F_DELETE_CUSTOMER_TEMPLATE", "esm_prov_npa", "InternalCmd_MapView_View_ZoomIn", "OSAddressRO", "Cmd_TM_FUNCTION_allUser", "esm_modify_lag", "AlignUpwards", "DeleteSwdlNes", "InternalCmd_MapView_Obj_Undo", "ShowBkupSession", "CreateDynamicLink", "ViewRestoreJobReport", "DisplayRI", "PathBuild", "ManageMonitoring", "ShowRestoreNes", "ManageMeTime", "SysMonRead", "DeleteBkpNes", "DeleteSwdlSession", "RemoveGeneric", "ShowSwdlNes", "ManageNTP", "Cmd_CLOG_Admin_Header_P", "ShowEqp", "DeleteBkpSession", "DeleteRestoreSession", "Cmd_CLOG_Admin_Header", "ManageNEPopulation", "GetSwStatusByType", "ShowIsaSWStatus", "MEAddressRW", "ActivateSw", "esm_generate_pm_report", "Cmd_Inv_LinkListConnections", "Cmd_MapNav_ObjPtrToNPAview", "Cmd_CLOG_Ack", "MSGUI_FUNCTION_ADMIN_TOPOLOGICALVIEWS", "PingNE", "esm_modify_mclag", "AbortJob", "ManualAlignDownwards", "Cmd_MapInv_ListTopLevelNtws_PHY_TOPVIEW", "Cmd_MapInv_SbnListChildSbns", "ShowRestoreSession", "Cmd_MapAct_SbnRemoveNode", "F_ADD_CUSTOMER_TEMPLATE", "ManageAccess", "CreateBkupSessionWizard", "CreateRestoreSessionWizard", "ShowJobList", "MigrateME", "OpenJobWizard", "Cmd_TM_FUNCTION_admin_construct", "SysMonAdmin", "ModifyLocation", "wdm_neManagementFunction", "OpenGetSwByTypeWizard", "ModifyME", "Cmd_MapNav_OpcToMap", "NavigationToELM", "Cmd_MapAct_SbnDeleteSbnAndSubordinates", "AbortNe", "Cmd_CLOG_User_Header", "MultipleNeDownload", "Cmd_TM_FUNCTION_admin_construct_operator", "Admin", "AddSwdlNes", "saveSubnet", "wdm_legacyManagementFunction", "GetSwdl", "Cmd_MapInv_SbnCreateMap", "Cmd_MapAct_SbnCommitMapModify", "Cmd_MapInv_ListTopLevelNtws_PHY_Test", "esm_prov_customer", "physconnInNet", "UploadRemoteInventory", "GetSwDetail", "ActiveJob", "NEInventory", "ManageResynchro", "RunPerfMon_hour", "Cmd_MapWiz_ModifySubnet", "AbortBkupSession", "GetNeLabel", "SetNeTime", "InternalCmd_MapView_View_ZoomOut", "NavigationToEquipments", "ManageFilter", "ViewBkupJobReport", "DeleteSw", "wdm_inventoryFunction", "ManageLocalAccess", "NetworkAddressRW", "esm_job_reschedule", "AddBkpNes", "SysMonView", "esm_design_template", "Cmd_MapInv_PopulateSbnsInTree_PHY", "addSubnet", "InternalCmd_MapView_Obj_Redo", "Cmd_MapInv_ShowOpcView", "NetworkAddressRO", "esm_design_feature", "InternalCmd_MapView_View_ZoomBestFit", "AlarmDebounceView", "EditSwdlJobWizard", "CreatePartialSwdlJob", "ModifyACD", "NavigationToURLs", "EMLInventory", "viewMap", "Cmd_TM_FUNCTION_admin", "esm_prov_service", "Cmd_MapAct_SbnAddNode", "DeleteRestoreNes", "ActiveSoftware", "NavigationToHostNe", "AdvancedViewer", "wdm_alarmManagementFunction", "AllUsers", "CreateSUBNE", "ShowSwdlSession", "EditJob", "ManageSupervision", "CreateNE", "esm_modify_tunnel", "ModifyUserLabel", "Cmd_MapWiz_SbnCreateSimple", "esm_modify_npa", "GetNeType", "Cmd_MapAct_DataSynchronize", "OpenGetSwByNameWizard", "InternalCmd_MapView_View_ChangeBackground", "ResynchroAll", "RunPerfMon_day", "MulitpleNeBackup", "ModifyComments", "CreatePartialSwdlJobFromNeList", "F_MODIFY_CUSTOMER_TEMPLATE", "ManageLinkInventory", "GetFtServer", "esm_modify_service", "ManageMib", "EditRestorJobWizard", "esm_deploy_networkConfig", "Cmd_EventParameter", "ShowJobStatus", "ShowStatuses", "addNode", "Cmd_CLOG_User_Header_P", "NavigationToAlarms", "InternalCmd_MapView_Obj_Save", "EditBkupJobWizard", "InternalCmd_MapView_View_SwitchLayer", "CreateRestoreSession", "esm_job_delete", "esm_prov_erp", "Cmd_MapCrt_SbnCreate", "Cmd_MapInv_ListObjsForCreateSbn", "GetSwStatusByName", "CreateSwdlSessionWizard", "DirInventory", "removeNode", "ManageAdmin", "esm_prov_lag", "DeleteJob", "CreateBkupSession", "wdm_provisionFunction", "ManageClone", "modifySubnet", "CommitSw", "CreateME", "ShowAlarms", "InternalCmd_MapView_View_NormalSize", "CreateRNE", "InternalCmd_MapView_View_Miniature", "ShowBackupNes", "Construct", "Cmd_Inv_SbnListPhyconnections" ], "nadString": "unknown", "userNadRole": "GLOBAL" }

    External Docs
    See Also :

    Operation

    post /cas/v1/tickets
    getTgtIdFromCas (getTgtIdFromCas : /cas/v1/tickets)
    This is the first step of the Authentication.When the client visits an application desiring to authenticate to it, the application redirects it to CAS. CAS validates the client’s authenticity by checking a username and password against its db. If authentication succeeds, CAS returns security ticket (TGT Id). HTTP POST method to submit user and password to nspOS.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    username required CAS username String ---
    password required CAS Password String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST /cas/v1/tickets HTTP/1.1 Host: {{serverIp}}:443 cache-control: no-cache Postman-Token: 1b00f153-f075-44a9-b72d-767ea02f4c12 username=adminpassword=Nokia1.!ticket=%7B%7BserviceTicket%7D%7Dpresentation={{serverIp}}%3A8443undefined=undefined

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    <!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\"> <html> <head> <title>201 Created</title> </head> <body> <h1>TGT Created</h1> <form action="https://135.250.203.134/cas/v1/tickets/TGT-206-Cy6rCoPik6BkCftS0yRHZdt5xcPgJraduj6AH16oI5z6XwC5po-otneVM1" method="POST">Service: <input type="text" name="service" value=""> <br> <input type="submit" value="Submit"> </form> </body> </html>

    External Docs
    See Also :

    Operation

    get /session-manager/logout
    sessionLogout (sessionLogout : /session-manager/logout)
    This step is logout from session manager


    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /session-manager/logout HTTP/1.1 Host: 135.250.207.50 Referer: https://135.250.207.50:8443/oms1350/pages/otn/mainOtn cache-control: no-cache Postman-Token: b86b8c75-ef8a-4f89-abaa-8a7911cd61c2

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    <!doctype html><html><head><meta charset="utf-8"><title>Sign in</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><link rel="icon" href="" /><link rel="stylesheet" type="text/css" href="main.css"></head> <style> @font-face { font-family: 'NokiaPureText'; font-weight: 200; src: url('./font/NokiaPureText-Light.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; src: url('./font/NokiaPureText-Regular.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; font-weight: bold; src: url('./font/NokiaPureText-Medium.woff'); } @font-face { font-family: 'NokiaPureHeadline'; font-weight: 200; src: url('./font/NokiaPureHeadline_Light.woff') format('woff'); } html,body{ width: 100%; height: 100%; margin: 0; padding: 0; } </style><body><div style="display: none" id="cUsername" value=""></div><div style="display: none"> </div><div style="display: none" id="execution" value="24479514-1196-48b9-8100-5573779a7ce1_ZXlKaG kuZUdZMFYybzRUMlp6WWt0NFFVRm1VbmhNV2xwbFJWWnhOV1Y0TDJKNmR6Y3hOVnBxTmtabVQxTkNjRWRWTVhadVVrSkdZakox xKU1pITkRTVWR5UlV4NE4ycFlTak5OZDA1RFFXVnVRelJFVVhreVpHNVphV1UxTDJkRGNITnNNR3gwVFc1TlVGZExNMlowUTIx bE1TRmd2S3pOTk1GaHhjalp4WmtSQlRYTlVhMDQzVWtNMmVUaDJUV3h1WWxKUWVrOW1hWFZHYkRCRllsWmxXV2hpVVhndk1sWm XSHB0YUVRM2NFWlFWMGhOZGpOVGRtUm9TMmx0WjB4V1FrNTFVVlExT1hObmVtcG9ja2hWTDJ0U2NtUkllRFZUVm1wWFVqSnpkR 0WjFsSlFXUnJUM3BWWWk4MWVWTjZjMWwwVms5NFpVZFpjamh5VjNFdlRqUTJVSEo1Y2taMmFsUTJRMjEzTmt0c1owUnpUVzV2Z </div><div style="display: none" id="_eventId" value="submit"></div><div style="display: none" id="geolocation"></div><div id="root" style="height:100%;"></div><script src="./bundle.js"> </script></body></html>

    External Docs
    See Also :

    Operation

    get /session-manager/login?service
    sessionManagerLogin (sessionManagerLogin : /session-manager/login?service)
    This is the fourth step of the authentication.HTTP GET method to register the SSO Session in Session-Manager.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    service required https://{{otneIP}}:8443/oms1350/login/cas ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /session-manager/login?service=https://135.250.203.134:8443/oms1350/login/cas HTTP/1.1 Host: 135.250.203.134 cache-control: no-cache Postman-Token: 1e546575-4405-48be-a2ed-051f6aca559f

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    <!doctype html><html><head><meta charset="utf-8"><title>Sign in</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><link rel="icon" href="" /><link rel="stylesheet" type="text/css" href="main.css"></head> <style> @font-face { font-family: 'NokiaPureText'; font-weight: 200; src: url('./font/NokiaPureText-Light.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; src: url('./font/NokiaPureText-Regular.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; font-weight: bold; src: url('./font/NokiaPureText-Medium.woff'); } @font-face { font-family: 'NokiaPureHeadline'; font-weight: 200; src: url('./font/NokiaPureHeadline_Light.woff') format('woff'); } html,body{ width: 100%; height: 100%; margin: 0; padding: 0; } </style><body><div style="display: none" id="cUsername" value=""></div><div style="display: none"> </div><div style="display: none" id="execution" value="24479514-1196-48b9-8100-5573779a7ce1_ZXlKaG kuZUdZMFYybzRUMlp6WWt0NFFVRm1VbmhNV2xwbFJWWnhOV1Y0TDJKNmR6Y3hOVnBxTmtabVQxTkNjRWRWTVhadVVrSkdZakox xKU1pITkRTVWR5UlV4NE4ycFlTak5OZDA1RFFXVnVRelJFVVhreVpHNVphV1UxTDJkRGNITnNNR3gwVFc1TlVGZExNMlowUTIx bE1TRmd2S3pOTk1GaHhjalp4WmtSQlRYTlVhMDQzVWtNMmVUaDJUV3h1WWxKUWVrOW1hWFZHYkRCRllsWmxXV2hpVVhndk1sWm XSHB0YUVRM2NFWlFWMGhOZGpOVGRtUm9TMmx0WjB4V1FrNTFVVlExT1hObmVtcG9ja2hWTDJ0U2NtUkllRFZUVm1wWFVqSnpkR 0WjFsSlFXUnJUM3BWWWk4MWVWTjZjMWwwVms5NFpVZFpjamh5VjNFdlRqUTJVSEo1Y2taMmFsUTJRMjEzTmt0c1owUnpUVzV2Z </div><div style="display: none" id="_eventId" value="submit"></div><div style="display: none" id="geolocation"></div><div id="root" style="height:100%;"></div><script src="./bundle.js"> </script></body></html>

    External Docs
    See Also :

    Operation

    get /session-manager/login/cas
    sessionManagerLoginCas (sessionManagerLoginCas : /session-manager/login/cas)
    This is the third step of the authentication.After getting the Service-Ticket from the previous step, HTTP GET method on SessionManager URL to validate the ServiceTicket nspOS. Note:(Here the Request Header, Host = Input the IP address of the server or the DNS name of the server (if FQDN is installed) as applicable).

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ticket required ST-LOC ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /session-manager/login/cas?ticket=ST-283-11sufBoycnYC3XpHCaHp-CSVANPAPP482 HTTP/1.1 Host: 135.250.203.134 cache-control: no-cache Postman-Token: 405e6c75-0c0b-4d31-a7b0-db8c6876fd4a

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    <!doctype html><html><head><meta charset="utf-8"><title>Sign in</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><link rel="icon" href="" /><link rel="stylesheet" type="text/css" href="main.css"></head><style> @font-face { font-family: 'NokiaPureText'; font-weight: 200; src: url('./font/NokiaPureText-Light.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; src: url('./font/NokiaPureText-Regular.woff') format('woff'); } @font-face { font-family: 'NokiaPureText'; font-weight: bold; src: url('./font/NokiaPureText-Medium.woff'); } @font-face { font-family: 'NokiaPureHeadline'; font-weight: 200; src: url('./font/NokiaPureHeadline_Light.woff') format('woff'); } html,body{ width: 100%; height: 100%; margin: 0; padding: 0; } </style><body><div style="display: none" id="cUsername" value=""></div><div style="display: none"> </div><div style="display: none" id="execution" value="bb040481-7659-44fa-aca2-fdfac66fae7f_ZXlKaGJHY2lPaUp JVXpVeE1pSjkuZVdKT1FrdE9TMFowVW1OWWJqRlJUMjFhVG5kRE0weGpZVkZoS3pCQ2NVUXhUMmRuYTJGMGVYaElUVVpTU0hGdWVsUTBNa2R WZDNsSFJYQXljblJ4YkVGSlZVbExTemd2ZVVnd0wybzFNRlUyVmtWRlNIZDNXRzFaVEVzek0wOUpVV3RYTkRZcldqSk5iMDF0WVdOTk9YY3h XRVpIU2pSdGFuQXJSakpuT0dVNWRWWk9OMnRUU1V4TWVVdEtOSFJpVW5GRGRYaHlkVUYwZVVRMVNEWjJNMnRqU1RKaFJFMVVXRUp6SzJRNVd qTnFSbFphTUZwUk1UaFFWVFJTTDJ3cmIwZFBPVEZWZVVkYU1tOTBZakJtVFhCYWJXZFZRV2RJYmpGd1RETXJVVm95ZEc1c01qbFBja3B0Y21 wd1REaDFVMnA0ZFZFdllrUnNibUYzT1RGWGFubFBkRGxNVlVad1JXTjVkWE5PTlZFMU5qZ3ZUMjV3ZG1wUVN6VnFSeXR3Wm5sTE5rNWhhV1k 1WjNwbEswNXdTM2x6Tm0xVmRXTjRTbEZzWmxKQ2VWUlJiMng0TlhOTmFtWnBSMEZ2SzBoYU1ubGpibWRUV25kaE9Fd3JRbGRtY0hVMFUyZHN TMll4TjBaU1ptbEliVGR5VWxCWFYwY3pWMEpqYkZBNU5HUkpRVGhSTm1aM1RITXZUMU53UWpZd1lsTnpaV3N5UjB4dk9FOXhUVTkwUVZZNGR UZFNUM0JCVlVwamFYSnVURUl2WW5GNmJYaE9OVWhEVnpNMFJtRkZjRGQ2Y0c5UmRtYzVTRkIwWm14a2IxWjVaakIzUmt0Q01ETkhRbUZQTUh SHhGS0R1T1B3"></div><div style="display: none" id="_eventId" value="submit"></div><div style="display: none" id="geolocation"></div><div id="root" style="height:100%;"></div><script src="./bundle.js"></script></body></html>

    External Docs
    See Also :

    Operation

    get /oms1350/data/common/login
    sessionPolling (sessionPolling : /oms1350/data/common/login)
    This API is used to perform polling to keep the session alive.It is suggested to perform polling every 1 min with this GET call so that the session does not expire

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional model ModelMap ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Example Request Data

    GET /oms1350/data/common/login HTTP/1.1 Host: 135.250.76.238:8443 User-Agent: PostmanRuntime/7.20.1 Accept: */* Cache-Control: no-cache Postman-Token: f07db33f-97a1-405b-b5b5-87fa6d9b9d78,3ceeafa6-7220-440d-b5fa-4a0833fe5c99 Host: 135.250.76.238:8443 Accept-Encoding: gzip, deflate Cookie: JSESSIONID=6EE6E2CB58177CA637A1580B37C2500D; NSPOS_JSESSIONID=0BD0D714098E821129FE064F79FC4C95 Connection: keep-alive cache-control: no-cache

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response:201 []

    External Docs
    See Also :

    Operation

    post /rest-gateway/rest/api/v1/auth/revocation
    tokenRevoke (tokenRevoke : /rest-gateway/rest/api/v1/auth/revocation)
    A bearer token can be terminated by sending a POST request to the rest-gateway endpoint with the token or client User_name details.Note:It is mandatory to revoke the token at the end of usage,a clean sign out mechanism for single step and no need to pass the cookie.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    token required Token String ---
    tokenTypeHint required token type String ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    POST https://{{serverIp}}/rest-gateway/rest/api/v1/auth/revocation HTTP/1.1 Host: 135.250.207.140 Content-Type: application/json Authorization: Basic YWRtaW46Tm9raWFOc3AxIQ== data "token={{token}}&token_type_hint=token"

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • */*
    Example Response Data
    Response: 200 OK

    External Docs
    See Also :