@itentialopensource/adapter-nokia_nsp_nfm_p

{ "swagger": "2.0", "info": { "description": "The SAM-O Restful API endpoints allows to :\n 1) Convert an XML document to JSON. The conversion is a straightforward conversion of the original XML document. \n 2) Send a JSON formatted request to the NFMP server. This JSON corresponds to what was converted by this REST service.\n Access Information:Prior to accessing the API services below the API client must authenticate the NSP user via the NSP REST Gateway's authentication API service.\n One authentication method is supported:\n<ul><li>\"Bearer\" token authentication.</li></ul>Note: XML request bodies which contain CDATA formatted text are not supported.Deprecation notice: NFM-P SAM-O (Including SOAP XML, SAM-O REST v1, v2, v3, and JMS Interfaces) are now deprecated. Starting in NSP Release 23, all new greenfield northbound integrations with NSP must be done using the new NSP REST/RESTCONF APIs and Kafka interfaces. Brownfield upgrades with northbound integrations towards NFM-P SAM-O (SOAP/XML, SAM-O v1,v2,v3 and JMS Interfaces) can continue to use those legacy APIs until end of 2025. NFM-P SAM-O (SOAP/XML, SAM-O v1, v2, v3 and JMS Interfaces) will no longer be available for brownfield upgrades of northbound integrations starting in NSP Release 26. Customers are encouraged to use the NSP REST/RESTCONF v3 APIs. ", "title": "SAM-O Restful Api Endpoints", "version": "v3" }, "basePath": "/nfmpv3service/api", "tags": [ { "name": "API v3" } ], "schemes": [ "https", "http" ], "paths": { "/v3/xml-to-json": { "post": { "tags": [ "API v3" ], "summary": "NFMP REST-API v3 convert XML to JSON command", "description": "Use this endpoint to convert any XML or SOAP XML message, and it will return the proper JSON body that you can use for the v3 api.For example, the client makes the following HTTP request:\n \n\n POST /v3/xml-to-json HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/xml\n\n <find xmlns=\"xmlapi_1.0\"><fullClassName>aclfilter.IpFilter</fullClassName></find>\n \n\n\n Which returns: \n\n {\"find\": {\"fullClassName\": \"aclfilter.IpFilter\"}}", "operationId": "xmltojsonEndpoint", "consumes": [ "application/xml" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal server problems" } } } }, "/v3/xml": { "post": { "tags": [ "API v3" ], "summary": "NFMP REST-API v3 'xml' command", "description": "This is the XML REST_API endpoint. Use this endpoint to send XML directly instead of JSON. For example, the client makes the following HTTP request:\n \n\n POST /v3/xml HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/xml\n\n <find><fullClassName>aclfilter.IpFilter</fullClassName></find>", "operationId": "xmlEndpoint", "consumes": [ "application/xml" ], "produces": [ "application/xml" ], "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "type": "string" } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Returns a successful object" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal server problems" } } } }, "/v3/request": { "post": { "tags": [ "API v3" ], "summary": "NFMP REST-API v3 'request' command", "description": "This is the NFMP REST_API endpoint. Use this endpoint to send your converted JSON and obtain a JSON response. For example, the client makes the following HTTP request:\n \n\n POST /v3/request HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n Example that returns JSON response:\n {\"fullClassName\":[\"netw.NetworkElement\"], \"fileName\": \"myFile.xml\", \"resultFilter\": { \"attributes\": [\"objectFullName\",\"siteId\"] } }\n\n\nImportant Note: The /v3/request 'find' response will be in SOAP XML format only. \n It is recommended to use the /v3/find request for REST-API v3 'find' requests and it is mandatory for any v3 request that would result in a large response message greater than 12 MB. \n The return error code will be 500 if a response message size is too large. \n\nDeprecation Notice: The /v3/request 'find' request will be removed in NSP 23.03 release because of the above limitation.\n", "operationId": "requestEndpoint", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "object" } } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Returns a successful object" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal server problems" } } } }, "/v3/find": { "post": { "tags": [ "API v3" ], "summary": "NFMP REST-API v3 'find' command", "description": "This is the recommended endpoint for performing a REST- API v3 \"find\" requests and it is mandatory for any finds with a large result set. The response is only in XML format. For example, the client makes the following HTTP request:\n \n \n POST /v3/find HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"find\": {\n \"fullClassName\": \"security.User\",\n \"resultFilter\": {\n \"children\": \"\",\n \"attribute\": [\n \"objectFullName\",\n \"userName\",\n \"userGroup\"\n ]\n }\n }}\n \n XML response:\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <result>\n <security.User>\n <userName>admin</userName>\n <userGroup>securityManager:userGroup-admin</userGroup>\n <objectFullName>securityManager:user-admin</objectFullName>\n </security.User>\n <security.User>\n <userName>SAMqa</userName>\n <userGroup>securityManager:userGroup-GSAMqa</userGroup>\n <objectFullName>securityManager:user-SAMqa</objectFullName>\n </security.User>\n </result>\n", "operationId": "findEndpoint", "consumes": [ "application/json" ], "produces": [ "application/octet-stream" ], "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "type": "object", "additionalProperties": { "type": "object" } } } ], "security": [ { "api_key": [] } ], "responses": { "200": { "description": "Returns a successful object" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Internal server problems" } } } } }, "securityDefinitions": { "api_key": { "type": "apiKey", "name": "Authorization", "in": "header" } } }