@itentialopensource/adapter-nokia_nsp_sdn

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v4/generic/application-id/{id}": { "get": { "tags": [ "SdnGeneric" ], "operationId": "getApplicationId", "description": "The parameters and request body are for method: getApplicationId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "adminState": { "type": "string" }, "appId": { "type": "string" }, "customAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string" }, "attributeValue": { "type": "string" } } } }, "customAttributesTemplateId": { "type": "string" }, "externalIds": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "id": { "type": "string" }, "location": { "type": "array", "items": { "type": "string" } } } } }, "id": { "type": "string" }, "neDeploymentState": { "type": "string" }, "operationalState": { "type": "string" } } }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": { "adminState": "DOWN", "appId": "string", "customAttributes": [ { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" } ], "customAttributesTemplateId": "string", "externalIds": [ { "context": "NSP", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string" ] }, { "context": "MDM", "id": "string", "location": [ "string", "string" ] } ], "id": "string", "neDeploymentState": "DEPLOYED", "operationalState": "UP" }, "endRow": 4, "startRow": 9, "status": 1, "totalRows": 10 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v4/generic/application-id/{id}/{appId}": { "put": { "tags": [ "SdnGeneric" ], "operationId": "setApplicationId", "description": "The parameters and request body are for method: setApplicationId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "adminState": { "type": "string" }, "appId": { "type": "string" }, "customAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string" }, "attributeValue": { "type": "string" } } } }, "customAttributesTemplateId": { "type": "string" }, "externalIds": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "id": { "type": "string" }, "location": { "type": "array", "items": { "type": "string" } } } } }, "id": { "type": "string" }, "neDeploymentState": { "type": "string" }, "operationalState": { "type": "string" } } }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": { "adminState": "UP", "appId": "string", "customAttributes": [ { "attributeName": "string", "attributeValue": "string" } ], "customAttributesTemplateId": "string", "externalIds": [ { "context": "NFM_T", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "MDM", "id": "string", "location": [ "string", "string", "string", "string" ] }, { "context": "NODE", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] } ], "id": "string", "neDeploymentState": "DEPLOYED", "operationalState": "UNKNOWN" }, "endRow": 3, "startRow": 3, "status": 9, "totalRows": 7 } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "appId", "in": "path", "required": true, "schema": { "title": "appId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v4/generic/consumed/{uuid}": { "get": { "tags": [ "SdnGeneric" ], "operationId": "getConsumed", "description": "The parameters and request body are for method: getConsumed. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": [ "USER" ], "endRow": 9, "startRow": 7, "status": 3, "totalRows": 1 } } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v4/generic/find-by-external-id": { "post": { "tags": [ "SdnGeneric" ], "operationId": "findByExternalId", "description": "The parameters and request body are for method: findByExternalId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "string" }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": "READY", "endRow": 8, "startRow": 7, "status": 3, "totalRows": 10 } } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v4/generic/tenants/{uuid}": { "get": { "tags": [ "SdnGeneric" ], "operationId": "getTenants", "description": "The parameters and request body are for method: getTenants. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "string" }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": "READY", "endRow": 3, "startRow": 4, "status": 5, "totalRows": 5 } } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v4/generic/{uuid}": { "get": { "tags": [ "SdnGeneric" ], "operationId": "get", "description": "The parameters and request body are for method: get. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "adminState": { "type": "string" }, "appId": { "type": "string" }, "customAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string" }, "attributeValue": { "type": "string" } } } }, "customAttributesTemplateId": { "type": "string" }, "externalIds": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "id": { "type": "string" }, "location": { "type": "array", "items": { "type": "string" } } } } }, "id": { "type": "string" }, "neDeploymentState": { "type": "string" }, "operationalState": { "type": "string" } } }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": { "adminState": "UP", "appId": "string", "customAttributes": [ { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" } ], "customAttributesTemplateId": "string", "externalIds": [ { "context": "NODE", "id": "string", "location": [ "string", "string", "string", "string", "string", "string" ] }, { "context": "NFM_P", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "NODE", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string", "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string", "string", "string" ] }, { "context": "NFM_P", "id": "string", "location": [ "string" ] }, { "context": "MDM", "id": "string", "location": [ "string", "string", "string", "string", "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string" ] } ], "id": "string", "neDeploymentState": "UNKNOWN", "operationalState": "UP" }, "endRow": 5, "startRow": 10, "status": 3, "totalRows": 3 } } } } } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "title": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint": { "post": { "tags": [ "SdnServices" ], "operationId": "addL2BackhaulEndpoint", "description": "The parameters and request body are for method: addL2BackhaulEndpoint. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actualEndState": { "type": "string" }, "adminState": { "type": "string" }, "appId": { "type": "string" }, "bidirectional": { "type": "string" }, "bw": { "type": "number" }, "customAttributes": { "type": "array", "items": { "type": "object", "properties": { "attributeName": { "type": "string" }, "attributeValue": { "type": "string" } } } }, "customAttributesTemplateId": { "type": "string" }, "customerId": { "type": "number" }, "description": { "type": "string" }, "endpointExtensions": { "type": "array", "items": { "type": "object", "properties": { "connectedInner": { "type": "number" }, "connectedOuter": { "type": "number" }, "connectedPortId": { "type": "string" }, "customAttributes": { "type": "array", "items": { "type": "object" } }, "nniPort": { "type": "object" }, "uniPort": { "type": "object" } } } }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "actualEndState": { "type": "string" }, "adminState": { "type": "string" }, "appId": { "type": "string" }, "customAttributes": { "type": "array", "items": { "type": "object" } }, "customAttributesTemplateId": { "type": "string" }, "description": { "type": "string" }, "externalIds": { "type": "array", "items": { "type": "object" } }, "id": { "type": "string" }, "name": { "type": "string" }, "neDeploymentState": { "type": "string" }, "neId": { "type": "string" }, "neName": { "type": "string" }, "operationalState": { "type": "string" }, "portAdminState": { "type": "string" }, "portId": { "type": "string" }, "portName": { "type": "string" }, "portOperationalState": { "type": "string" }, "portSpeed": { "type": "number" }, "serviceId": { "type": "string" } } } }, "externalIds": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "id": { "type": "string" }, "location": { "type": "array", "items": { "type": "string" } } } } }, "groupId": { "type": "string" }, "id": { "type": "string" }, "lifeCycle": { "type": "object", "properties": { "phase": { "type": "string" }, "reason": { "type": "string" }, "state": { "type": "string" } } }, "maxCost": { "type": "number" }, "maxHops": { "type": "number" }, "maxLatency": { "type": "number" }, "name": { "type": "string" }, "neDeploymentState": { "type": "string" }, "nodeServiceId": { "type": "number" }, "objective": { "type": "string" }, "operationalState": { "type": "string" }, "pathProfileId": { "type": "string" }, "requestedEndState": { "type": "string" }, "reverseBW": { "type": "number" }, "serviceType": { "type": "string" }, "templateId": { "type": "string" }, "tunnelSelectionId": { "type": "string" } } }, "endRow": { "type": "number" }, "startRow": { "type": "number" }, "status": { "type": "number" }, "totalRows": { "type": "number" } } } } }, "example": { "response": { "data": { "actualEndState": "Deployed", "adminState": "UP", "appId": "string", "bidirectional": "ANY_REVERSE_ROUTE", "bw": 6, "customAttributes": [ { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" }, { "attributeName": "string", "attributeValue": "string" } ], "customAttributesTemplateId": "string", "customerId": 1, "description": "string", "endpointExtensions": [ { "connectedInner": 3, "connectedOuter": 1, "connectedPortId": "string", "customAttributes": [ {}, {}, {}, {} ], "nniPort": {}, "uniPort": {} }, { "connectedInner": 6, "connectedOuter": 8, "connectedPortId": "string", "customAttributes": [ {}, {}, {}, {} ], "nniPort": {}, "uniPort": {} }, { "connectedInner": 8, "connectedOuter": 10, "connectedPortId": "string", "customAttributes": [ {}, {}, {}, {}, {} ], "nniPort": {}, "uniPort": {} } ], "endpoints": [ { "actualEndState": "Saved", "adminState": "UP", "appId": "string", "customAttributes": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "customAttributesTemplateId": "string", "description": "string", "externalIds": [ {}, {}, {}, {}, {}, {}, {}, {}, {} ], "id": "string", "name": "string", "neDeploymentState": "NA", "neId": "string", "neName": "string", "operationalState": "PARTIALLY_DOWN", "portAdminState": "DOWN", "portId": "string", "portName": "string", "portOperationalState": "UP", "portSpeed": 1, "serviceId": "string" }, { "actualEndState": "Saved", "adminState": "DOWN", "appId": "string", "customAttributes": [ {}, {} ], "customAttributesTemplateId": "string", "description": "string", "externalIds": [ {} ], "id": "string", "name": "string", "neDeploymentState": "UNKNOWN", "neId": "string", "neName": "string", "operationalState": "DOWN", "portAdminState": "MAINTENANCE", "portId": "string", "portName": "string", "portOperationalState": "DEGRADED", "portSpeed": 5, "serviceId": "string" }, { "actualEndState": "Deployed", "adminState": "MAINTENANCE", "appId": "string", "customAttributes": [ {}, {}, {} ], "customAttributesTemplateId": "string", "description": "string", "externalIds": [ {}, {}, {}, {} ], "id": "string", "name": "string", "neDeploymentState": "PENDING", "neId": "string", "neName": "string", "operationalState": "UNKNOWN", "portAdminState": "MAINTENANCE", "portId": "string", "portName": "string", "portOperationalState": "DOWN", "portSpeed": 5, "serviceId": "string" }, { "actualEndState": "Saved", "adminState": "MAINTENANCE", "appId": "string", "customAttributes": [ {} ], "customAttributesTemplateId": "string", "description": "string", "externalIds": [ {}, {}, {}, {}, {} ], "id": "string", "name": "string", "neDeploymentState": "FAILED", "neId": "string", "neName": "string", "operationalState": "PARTIALLY_DOWN", "portAdminState": "MAINTENANCE", "portId": "string", "portName": "string", "portOperationalState": "UP", "portSpeed": 1, "serviceId": "string" } ], "externalIds": [ { "context": "MDM", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "MDM", "id": "string", "location": [ "string", "string" ] }, { "context": "NFM_T", "id": "string", "location": [ "string" ] }, { "context": "NSP", "id": "string", "location": [ "string", "string", "string", "string", "string", "string", "string", "string", "string", "string" ] }, { "context": "MDM",