{
"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",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Deploying"
},
"maxCost": 8,
"maxHops": 6,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 2,
"objective": "TE_METRIC",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "PHYSICAL_LINK",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 7,
"startRow": 9,
"status": 8,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateL2BackhaulEndpoint",
"description": "The parameters and request body are for method: updateL2BackhaulEndpoint. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 5,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"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": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "RoutedAndSaved"
},
"maxCost": 2,
"maxHops": 9,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 3,
"objective": "TE_METRIC",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 4,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 2,
"startRow": 5,
"status": 2,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL2BackhaulEndpoint",
"description": "The parameters and request body are for method: patchL2BackhaulEndpoint. 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": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 3,
"customAttributes": [
{
"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": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 10,
"maxHops": 2,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 10,
"objective": "LATENCY",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 1,
"serviceType": "L2_BACKHAUL",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 7,
"startRow": 3,
"status": 3,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/ietf/ethtsvc/l2backhaul/{autoPath}": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createL2backhaul",
"description": "The parameters and request body are for method: createL2backhaul. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 9,
"maxHops": 8,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 3,
"objective": "DISTANCE",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 6,
"serviceType": "LAG",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 2,
"startRow": 8,
"status": 2,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "autoPath",
"in": "path",
"required": true,
"schema": {
"title": "autoPath",
"type": "boolean"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/ietf/ethtsvc/l2backhaul/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateL2backhaul",
"description": "The parameters and request body are for method: updateL2backhaul. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "PartiallyDeployed"
},
"maxCost": 2,
"maxHops": 7,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 9,
"objective": "HOPS",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 10,
"startRow": 9,
"status": 9,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL2backhaul",
"description": "The parameters and request body are for method: patchL2backhaul. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Delete"
},
"maxCost": 6,
"maxHops": 3,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "STAR_WEIGHT",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 7,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 6,
"status": 2,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getV4Services",
"description": "The parameters and request body are for method: getV4Services. 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": "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": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 3,
"maxHops": 6,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 8,
"objective": "LATENCY",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 10,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"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": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"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": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 3,
"maxHops": 3,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 8,
"objective": "COST",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 6,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 1,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"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"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 10,
"maxHops": 5,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 6,
"objective": "DISTANCE",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "PHYSICAL_LINK",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 3,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 5,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 8,
"maxHops": 9,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 3,
"objective": "LATENCY",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "NO",
"bw": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Routing"
},
"maxCost": 4,
"maxHops": 6,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 9,
"objective": "STAR_WEIGHT",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"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": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"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": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 6,
"maxHops": 4,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 2,
"objective": "DISTANCE",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 4,
"serviceType": "L2_EXTENSION_UNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"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": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"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": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "PartiallyDeployed"
},
"maxCost": 6,
"maxHops": 9,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 5,
"objective": "DISTANCE",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 2,
"serviceType": "ELAN",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 4,
"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": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 7,
"maxHops": 6,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 4,
"objective": "STAR_WEIGHT",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 4,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 6,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 2,
"maxHops": 10,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 1,
"objective": "DISTANCE",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "L2_EXTENSION_UNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"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": "PARTIALLY_DOWN",
"portSpeed": 9,
"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": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 8,
"maxHops": 6,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 10,
"objective": "LATENCY",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
}
],
"endRow": 6,
"startRow": 1,
"status": 4,
"totalRows": 2
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/clines": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createClines",
"description": "The parameters and request body are for method: createClines. 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": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Planned"
},
"maxCost": 9,
"maxHops": 4,
"maxLatency": 9,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "STAR_WEIGHT",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "EACCESS",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 7,
"status": 7,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/clines/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateClines",
"description": "The parameters and request body are for method: updateClines. 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": "NO",
"bw": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 6,
"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": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"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": "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": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 10,
"maxHops": 3,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 4,
"objective": "STAR_WEIGHT",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 9,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 2,
"status": 10,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchClines",
"description": "The parameters and request body are for method: patchClines. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 5,
"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": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"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": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Deployed"
},
"maxCost": 1,
"maxHops": 3,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 4,
"objective": "LATENCY",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 7,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 8,
"status": 4,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/clines/{serviceUuid}/endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateClineEndpoint",
"description": "The parameters and request body are for method: updateClineEndpoint. 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": "NO",
"bw": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Planned"
},
"maxCost": 8,
"maxHops": 2,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 9,
"objective": "DISTANCE",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "LAG",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 5,
"status": 7,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchClineEndpoint",
"description": "The parameters and request body are for method: patchClineEndpoint. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"bw": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 10,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"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": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Delete"
},
"maxCost": 7,
"maxHops": 1,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 9,
"objective": "COST",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 6,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 1,
"status": 8,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/components/{uuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getComponents",
"description": "The parameters and request body are for method: getComponents. 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": {
"baseServiceHierarchy": {
"type": "object",
"properties": {
"baseService": {
"type": "object"
},
"serviceTunnels": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"baseServiceHierarchy": {
"baseService": {},
"serviceTunnels": [
{},
{},
{},
{}
]
}
},
"endRow": 7,
"startRow": 7,
"status": 10,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/eaccess": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createEaccess",
"description": "The parameters and request body are for method: createEaccess. 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": "ASYMMETRIC_LOOSE",
"bw": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 6,
"maxHops": 5,
"maxLatency": 9,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 7,
"objective": "HOPS",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 6,
"startRow": 10,
"status": 2,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/eaccess/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateEaccess",
"description": "The parameters and request body are for method: updateEaccess. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 4,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 6,
"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": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"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"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Planned"
},
"maxCost": 3,
"maxHops": 8,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 8,
"objective": "COST",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 9,
"status": 4,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchEaccess",
"description": "The parameters and request body are for method: patchEaccess. 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": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 9,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 7,
"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": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Delete"
},
"maxCost": 3,
"maxHops": 10,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 8,
"objective": "STAR_WEIGHT",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "L2_DCI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 3,
"status": 10,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elans": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createElans",
"description": "The parameters and request body are for method: createElans. 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": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 9,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"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": "DEGRADED",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"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": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"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": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Deployed"
},
"maxCost": 4,
"maxHops": 1,
"maxLatency": 9,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "LATENCY",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 6,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 3,
"status": 4,
"totalRows": 8
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elans/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateElans",
"description": "The parameters and request body are for method: updateElans. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"bw": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "RoutingFailed"
},
"maxCost": 10,
"maxHops": 7,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 6,
"objective": "DISTANCE",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 5,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 7,
"status": 4,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchElans",
"description": "The parameters and request body are for method: patchElans. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 4,
"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": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"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": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"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"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 8,
"maxHops": 8,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 2,
"objective": "COST",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 5,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 10,
"startRow": 6,
"status": 1,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elans/{serviceUuid}/endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addElanEndpoint",
"description": "The parameters and request body are for method: addElanEndpoint. 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": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 8,
"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": 5,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 4,
"maxHops": 6,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 2,
"objective": "COST",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "TUNNEL",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 2,
"startRow": 6,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elans/{serviceUuid}/endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateElanEndpoint",
"description": "The parameters and request body are for method: updateElanEndpoint. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "NO",
"bw": 5,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Delete"
},
"maxCost": 3,
"maxHops": 2,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 3,
"objective": "LATENCY",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "L3_DCI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 2,
"startRow": 1,
"status": 10,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchElanEndpoint",
"description": "The parameters and request body are for method: patchElanEndpoint. 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": "ASYMMETRIC_LOOSE",
"bw": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 9,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 7,
"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": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"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": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Planned"
},
"maxCost": 9,
"maxHops": 5,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 8,
"objective": "LATENCY",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 6,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 6,
"status": 10,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elines": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createElines",
"description": "The parameters and request body are for method: createElines. 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": "SYMMETRIC_LOOSE",
"bw": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 10,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Planned"
},
"maxCost": 8,
"maxHops": 2,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 7,
"objective": "DISTANCE",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 5,
"serviceType": "LAG",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 5,
"status": 7,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elines/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateElines",
"description": "The parameters and request body are for method: updateElines. 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": "DOWN",
"appId": "string",
"bidirectional": "NO",
"bw": 4,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"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": "DOWN",
"portSpeed": 8,
"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": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Saved"
},
"maxCost": 10,
"maxHops": 7,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 8,
"objective": "HOPS",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 1,
"startRow": 7,
"status": 5,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchElines",
"description": "The parameters and request body are for method: patchElines. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 5,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Routing"
},
"maxCost": 4,
"maxHops": 7,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 10,
"objective": "LATENCY",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 9,
"serviceType": "IES",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 7,
"startRow": 9,
"status": 9,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elines/{serviceUuid}/endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateElineEndpoint",
"description": "The parameters and request body are for method: updateElineEndpoint. 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": "ASYMMETRIC_STRICT",
"bw": 8,
"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": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 6,
"maxHops": 2,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 4,
"objective": "LATENCY",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "ELAN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 3,
"status": 9,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchElineEndpoint",
"description": "The parameters and request body are for method: patchElineEndpoint. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"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": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"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": "PARTIALLY_DOWN",
"portSpeed": 6,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "RoutingFailed"
},
"maxCost": 2,
"maxHops": 5,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 1,
"objective": "TE_METRIC",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 7,
"serviceType": "L2_EXTENSION_UNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 1,
"status": 8,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/fix-l3-vpn-vrf-membership/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateFixL3VpnVrfMembership",
"description": "The parameters and request body are for method: updateFixL3VpnVrfMembership. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 9,
"startRow": 5,
"status": 7,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/ies": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createIes",
"description": "The parameters and request body are for method: createIes. 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": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"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": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 1,
"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": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "RoutedAndSaved"
},
"maxCost": 2,
"maxHops": 7,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 7,
"objective": "STAR_WEIGHT",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 2,
"status": 8,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/ies/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateIes",
"description": "The parameters and request body are for method: updateIes. 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": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 9,
"maxHops": 10,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "TE_METRIC",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 2,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 5,
"status": 5,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchIes",
"description": "The parameters and request body are for method: patchIes. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "RoutingFailed"
},
"maxCost": 2,
"maxHops": 10,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 4,
"objective": "DISTANCE",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 6,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 5,
"status": 2,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/ies/{serviceUuid}/endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addIesEndpoint",
"description": "The parameters and request body are for method: addIesEndpoint. 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": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 9,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"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": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 9,
"maxHops": 5,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "TE_METRIC",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 4,
"serviceType": "EACCESS",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 8,
"startRow": 1,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/ies/{serviceUuid}/endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateIesEndpoint",
"description": "The parameters and request body are for method: updateIesEndpoint. 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": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 9,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Deploying"
},
"maxCost": 10,
"maxHops": 9,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 9,
"objective": "STAR_WEIGHT",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 2,
"serviceType": "L3_DCI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 10,
"startRow": 7,
"status": 9,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchIesEndpoint",
"description": "The parameters and request body are for method: patchIesEndpoint. 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": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 6,
"maxHops": 10,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 3,
"objective": "HOPS",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 5,
"serviceType": "LAG",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 8,
"startRow": 5,
"status": 8,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/ies/{serviceUuid}/loopback-endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addIesLoopbackEndpoint",
"description": "The parameters and request body are for method: addIesLoopbackEndpoint. 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": "ASYMMETRIC_STRICT",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 1,
"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": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 1,
"maxHops": 9,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 1,
"objective": "DISTANCE",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "ELAN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 8,
"status": 5,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/ies/{serviceUuid}/loopback-endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateIesLoopbackEndpoint",
"description": "The parameters and request body are for method: updateIesLoopbackEndpoint. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"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": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"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": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Deployed"
},
"maxCost": 10,
"maxHops": 6,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "DISTANCE",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "TUNNEL",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 1,
"startRow": 7,
"status": 1,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchIesLoopbackEndpoint",
"description": "The parameters and request body are for method: patchIesLoopbackEndpoint. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"bw": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "RoutingFailed"
},
"maxCost": 7,
"maxHops": 2,
"maxLatency": 10,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 9,
"objective": "STAR_WEIGHT",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 3,
"serviceType": "L2_EXTENSION_UNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 6,
"startRow": 7,
"status": 2,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-dci-vpns": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createL3DciVpns",
"description": "The parameters and request body are for method: createL3DciVpns. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 2,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"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": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 6,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 5,
"maxHops": 8,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 6,
"objective": "COST",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 7,
"serviceType": "EACCESS",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 5,
"status": 2,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-dcis/{serviceUuid}/endpoint/{endpointUuid}": {
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL3DciL3Endpoint",
"description": "The parameters and request body are for method: patchL3DciL3Endpoint. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"bw": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"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": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 1,
"maxHops": 7,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 7,
"objective": "LATENCY",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 7,
"serviceType": "LAG",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 10,
"status": 6,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-vpn-rt-audit": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getL3VpnRtAudit",
"description": "The parameters and request body are for method: getL3VpnRtAudit. 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": [
"ADMIN",
"OPERATOR",
"USER",
"ADMIN",
"OPERATOR",
"OPERATOR",
"ADMIN"
],
"endRow": 2,
"startRow": 6,
"status": 4,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/l3-vpns": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createL3Vpns",
"description": "The parameters and request body are for method: createL3Vpns. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Delete"
},
"maxCost": 5,
"maxHops": 10,
"maxLatency": 9,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 8,
"objective": "LATENCY",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 10,
"serviceType": "EACCESS",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 2,
"startRow": 9,
"status": 8,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-vpns/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateL3Vpns",
"description": "The parameters and request body are for method: updateL3Vpns. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "RoutingFailed"
},
"maxCost": 9,
"maxHops": 6,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 1,
"objective": "STAR_WEIGHT",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 10,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 2,
"status": 7,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL3Vpns",
"description": "The parameters and request body are for method: patchL3Vpns. 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": "ASYMMETRIC_LOOSE",
"bw": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"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": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "RoutedAndSaved"
},
"maxCost": 10,
"maxHops": 9,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 9,
"objective": "DISTANCE",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 9,
"serviceType": "L2_DCI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 7,
"status": 10,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-vpns/{serviceUuid}/endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addL3VpnEndpoint",
"description": "The parameters and request body are for method: addL3VpnEndpoint. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 10,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 2,
"maxHops": 10,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 10,
"objective": "TE_METRIC",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 2,
"startRow": 6,
"status": 10,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateL3VpnEndpoint",
"description": "The parameters and request body are for method: updateL3VpnEndpoint. 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": "ASYMMETRIC_LOOSE",
"bw": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Routing"
},
"maxCost": 5,
"maxHops": 7,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 4,
"objective": "HOPS",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 3,
"startRow": 3,
"status": 2,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL3VpnEndpoint",
"description": "The parameters and request body are for method: patchL3VpnEndpoint. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 7,
"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": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"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": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Deployed"
},
"maxCost": 5,
"maxHops": 7,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 7,
"objective": "LATENCY",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 6,
"serviceType": "L2_BACKHAUL",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 10,
"startRow": 1,
"status": 4,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-vpns/{serviceUuid}/loopback-endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addL3VpnLoopbackEndpoint",
"description": "The parameters and request body are for method: addL3VpnLoopbackEndpoint. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 4,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 10,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"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": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"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": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Routing"
},
"maxCost": 2,
"maxHops": 6,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "DISTANCE",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "L2_BACKHAUL",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 8,
"startRow": 6,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateL3VpnLoopbackEndpoint",
"description": "The parameters and request body are for method: updateL3VpnLoopbackEndpoint. 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": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 10,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Routing"
},
"maxCost": 4,
"maxHops": 6,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 5,
"objective": "LATENCY",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 5,
"status": 4,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL3VpnLoopbackEndpoint",
"description": "The parameters and request body are for method: patchL3VpnLoopbackEndpoint. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 5,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"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": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 4,
"maxHops": 1,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 6,
"objective": "LATENCY",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 3,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 7,
"startRow": 4,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/lags": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createLags",
"description": "The parameters and request body are for method: createLags. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 5,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Planned"
},
"maxCost": 3,
"maxHops": 7,
"maxLatency": 9,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 9,
"objective": "HOPS",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 6,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 1,
"status": 5,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/lags/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateLags",
"description": "The parameters and request body are for method: updateLags. 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": "Saved",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"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": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"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"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 5,
"maxHops": 10,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 9,
"objective": "TE_METRIC",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 3,
"serviceType": "LAG",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 3,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/normalized-l3-vpns": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createNormalizedL3Vpns",
"description": "The parameters and request body are for method: createNormalizedL3Vpns. 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": "SYMMETRIC_STRICT",
"bw": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Saved"
},
"maxCost": 7,
"maxHops": 1,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 6,
"objective": "LATENCY",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 1,
"serviceType": "PHYSICAL_LINK",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 10,
"status": 4,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/normalized-l3-vpns/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateNormalizedL3Vpns",
"description": "The parameters and request body are for method: updateNormalizedL3Vpns. 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": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Delete"
},
"maxCost": 3,
"maxHops": 8,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 6,
"objective": "COST",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 9,
"startRow": 7,
"status": 9,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchNormalizedL3Vpns",
"description": "The parameters and request body are for method: patchNormalizedL3Vpns. 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": "ASYMMETRIC_STRICT",
"bw": 4,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 4,
"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": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "PartiallyDeployed"
},
"maxCost": 10,
"maxHops": 7,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 9,
"objective": "STAR_WEIGHT",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 3,
"serviceType": "L3_DCI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 2,
"status": 8,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/normalized-l3-vpns/{serviceUuid}/endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addL3VpnNormalizedEndpoint",
"description": "The parameters and request body are for method: addL3VpnNormalizedEndpoint. 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": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"bw": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 10,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Deploying"
},
"maxCost": 7,
"maxHops": 1,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 1,
"objective": "TE_METRIC",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 3,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 4,
"status": 10,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/optical": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "createOptical",
"description": "The parameters and request body are for method: createOptical. 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": "NO",
"bw": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 8,
"maxHops": 6,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 10,
"objective": "DISTANCE",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 7,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 8,
"status": 10,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/optical/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateOptical",
"description": "The parameters and request body are for method: updateOptical. 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": "ASYMMETRIC_LOOSE",
"bw": 4,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Delete"
},
"maxCost": 4,
"maxHops": 5,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 6,
"objective": "HOPS",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 7,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 1,
"status": 5,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchOptical",
"description": "The parameters and request body are for method: patchOptical. 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": "DOWN",
"appId": "string",
"bidirectional": "NO",
"bw": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 5,
"maxHops": 6,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 5,
"objective": "COST",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 10,
"serviceType": "TUNNEL",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 5,
"startRow": 5,
"status": 1,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/physical-links-on-service/{serviceUuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getPhysicalLinksOnService",
"description": "The parameters and request body are for method: getPhysicalLinksOnService. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"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": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"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",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 2
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 2,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
}
],
"endRow": 10,
"startRow": 1,
"status": 1,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/resource-count/{tenantUuid}/{resourceType}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getResourceCount",
"description": "The parameters and request body are for method: getResourceCount. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "number"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": 9,
"endRow": 2,
"startRow": 1,
"status": 6,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
},
{
"name": "resourceType",
"in": "path",
"required": true,
"schema": {
"title": "resourceType",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/services-on-tunnel/{tunnelUuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getServicesOnTunnel",
"description": "The parameters and request body are for method: getServicesOnTunnel. 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": "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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 5,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"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": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"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": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"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",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Routing"
},
"maxCost": 5,
"maxHops": 7,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 2,
"objective": "STAR_WEIGHT",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 5,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"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": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 3,
"maxHops": 10,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 9,
"objective": "HOPS",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 2,
"serviceType": "L3_VPN",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 2,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"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"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Deploying"
},
"maxCost": 10,
"maxHops": 2,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 4,
"objective": "STAR_WEIGHT",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 1,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"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"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 10,
"maxHops": 5,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 4,
"objective": "TE_METRIC",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 2,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 9,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"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": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 6,
"maxHops": 5,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 8,
"objective": "STAR_WEIGHT",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 10,
"serviceType": "L2_BACKHAUL",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"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": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"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": "DEGRADED",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Saved"
},
"maxCost": 3,
"maxHops": 3,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 9,
"objective": "STAR_WEIGHT",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 6,
"serviceType": "L3_DCI",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 1,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"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": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 6,
"maxHops": 8,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 3,
"objective": "TE_METRIC",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "OCH",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 5,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Delete"
},
"maxCost": 6,
"maxHops": 1,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 6,
"objective": "TE_METRIC",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 9,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
}
],
"endRow": 4,
"startRow": 3,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "tunnelUuid",
"in": "path",
"required": true,
"schema": {
"title": "tunnelUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/tenant/{uuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getV4ServicesTenantUuid",
"description": "The parameters and request body are for method: getV4ServicesTenantUuid. 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": "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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"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": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"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": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"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": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 2,
"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": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 10,
"maxHops": 8,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 10,
"objective": "TE_METRIC",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 4,
"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": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Planned"
},
"maxCost": 2,
"maxHops": 10,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 5,
"objective": "STAR_WEIGHT",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 10,
"serviceType": "ELINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 9,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 2,
"maxHops": 7,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 6,
"objective": "HOPS",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 2,
"serviceType": "L2_BACKHAUL",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"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": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Deploying"
},
"maxCost": 8,
"maxHops": 9,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 8,
"objective": "STAR_WEIGHT",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 7,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"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": "PARTIALLY_DOWN",
"portSpeed": 4,
"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": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"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"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Planned"
},
"maxCost": 5,
"maxHops": 4,
"maxLatency": 9,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 1,
"objective": "LATENCY",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 2,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"bw": 4,
"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": 10,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Planned"
},
"maxCost": 3,
"maxHops": 2,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 1,
"objective": "COST",
"operationalState": "UNKNOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 9,
"serviceType": "TUNNEL",
"templateId": "string",
"tunnelSelectionId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"bidirectional": "NO",
"bw": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"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": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Planned"
},
"maxCost": 10,
"maxHops": 7,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 6,
"objective": "LATENCY",
"operationalState": "TRANSITION",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 10,
"serviceType": "CLINE",
"templateId": "string",
"tunnelSelectionId": "string"
}
],
"endRow": 3,
"startRow": 5,
"status": 8,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/tunnel/{tunnelUuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getTunnel",
"description": "The parameters and request body are for method: getTunnel. 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"
},
"availableBw": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"bw": {
"type": "number"
},
"cost": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"customerId": {
"type": "number"
},
"description": {
"type": "string"
},
"destinationEndpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"portId": {
"type": "string"
}
}
}
},
"destinationNodeId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"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"
},
"hops": {
"type": "number"
},
"id": {
"type": "string"
},
"latency": {
"type": "number"
},
"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"
},
"ownership": {
"type": "object",
"properties": {
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"modifiable": {
"type": "boolean"
}
}
},
"pathProfileId": {
"type": "string"
},
"physicalLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"requestedEndState": {
"type": "string"
},
"reverseBW": {
"type": "number"
},
"serviceType": {
"type": "string"
},
"sourceEndpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"portId": {
"type": "string"
}
}
}
},
"sourceNodeId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"steeringParameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"templateId": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"tunnelType": {
"type": "string"
},
"underlyingTransport": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"availableBw": 7,
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 2,
"cost": 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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"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": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 2,
"id": "string",
"latency": 8,
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 4,
"maxHops": 8,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 4,
"objective": "COST",
"operationalState": "UNKNOWN",
"ownership": {
"consumable": false,
"deletable": true,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "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",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 3,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 2,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 1
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 1,
"serviceType": "L3_DCI",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_te_loose",
"underlyingTransport": "MPLS"
},
"endRow": 2,
"startRow": 6,
"status": 2,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "tunnelUuid",
"in": "path",
"required": true,
"schema": {
"title": "tunnelUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateTunnel",
"description": "The parameters and request body are for method: updateTunnel. 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": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 9,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"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"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"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": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Planned"
},
"maxCost": 9,
"maxHops": 10,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 3,
"objective": "COST",
"operationalState": "DEGRADED",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 4,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 7,
"status": 3,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "tunnelUuid",
"in": "path",
"required": true,
"schema": {
"title": "tunnelUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/tunnels": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getTunnels",
"description": "The parameters and request body are for method: getTunnels. 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": "object",
"properties": {
"actualEndState": {
"type": "string"
},
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableBw": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"bw": {
"type": "number"
},
"cost": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"customerId": {
"type": "number"
},
"description": {
"type": "string"
},
"destinationEndpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"portId": {
"type": "string"
}
}
}
},
"destinationNodeId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"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"
},
"hops": {
"type": "number"
},
"id": {
"type": "string"
},
"latency": {
"type": "number"
},
"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"
},
"ownership": {
"type": "object",
"properties": {
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"modifiable": {
"type": "boolean"
}
}
},
"pathProfileId": {
"type": "string"
},
"physicalLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"requestedEndState": {
"type": "string"
},
"reverseBW": {
"type": "number"
},
"serviceType": {
"type": "string"
},
"sourceEndpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"portId": {
"type": "string"
}
}
}
},
"sourceNodeId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"steeringParameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"templateId": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"tunnelType": {
"type": "string"
},
"underlyingTransport": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"availableBw": 1,
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 7,
"cost": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 5,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"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": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 9,
"id": "string",
"latency": 2,
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 1,
"maxHops": 8,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 7,
"objective": "DISTANCE",
"operationalState": "UP",
"ownership": {
"consumable": true,
"deletable": true,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 1
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 2,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 4,
"serviceType": "L2_EXTENSION_NNI",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_ospf",
"underlyingTransport": "IPV4"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"availableBw": 4,
"bidirectional": "SYMMETRIC_STRICT",
"bw": 3,
"cost": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 4,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
}
],
"groupId": "string",
"hops": 9,
"id": "string",
"latency": 1,
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Undeploy"
},
"maxCost": 9,
"maxHops": 7,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 4,
"objective": "LATENCY",
"operationalState": "TRANSITION",
"ownership": {
"consumable": true,
"deletable": true,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"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"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "ELAN",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_pcc_initiated",
"underlyingTransport": "MPLS"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"availableBw": 1,
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 9,
"cost": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 3,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"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": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 10,
"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": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"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"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 4,
"id": "string",
"latency": 2,
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "RoutedAndSaved"
},
"maxCost": 1,
"maxHops": 3,
"maxLatency": 6,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 2,
"objective": "COST",
"operationalState": "PARTIALLY_DOWN",
"ownership": {
"consumable": false,
"deletable": false,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 2,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 8,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "TUNNEL",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "gre",
"underlyingTransport": "GRE"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"availableBw": 1,
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 9,
"cost": 2,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 6,
"id": "string",
"latency": 3,
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Delete"
},
"maxCost": 2,
"maxHops": 2,
"maxLatency": 8,
"name": "string",
"neDeploymentState": "NA",
"nodeServiceId": 1,
"objective": "STAR_WEIGHT",
"operationalState": "UP",
"ownership": {
"consumable": false,
"deletable": true,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "TUNNEL",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "rsvp_loose",
"underlyingTransport": "MPLS"
}
],
"endRow": 3,
"startRow": 7,
"status": 4,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/tunnels-on-service/{serviceUuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getTunnelsOnService",
"description": "The parameters and request body are for method: getTunnelsOnService. 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": "object",
"properties": {
"actualEndState": {
"type": "string"
},
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableBw": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"bw": {
"type": "number"
},
"cost": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"customerId": {
"type": "number"
},
"description": {
"type": "string"
},
"destinationEndpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"portId": {
"type": "string"
}
}
}
},
"destinationNodeId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"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"
},
"hops": {
"type": "number"
},
"id": {
"type": "string"
},
"latency": {
"type": "number"
},
"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"
},
"ownership": {
"type": "object",
"properties": {
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"modifiable": {
"type": "boolean"
}
}
},
"pathProfileId": {
"type": "string"
},
"physicalLinks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"requestedEndState": {
"type": "string"
},
"reverseBW": {
"type": "number"
},
"serviceType": {
"type": "string"
},
"sourceEndpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nodeId": {
"type": "string"
},
"portId": {
"type": "string"
}
}
}
},
"sourceNodeId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"steeringParameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"templateId": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"tunnelType": {
"type": "string"
},
"underlyingTransport": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"availableBw": 9,
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 8,
"cost": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 6,
"id": "string",
"latency": 5,
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Delete"
},
"maxCost": 2,
"maxHops": 6,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 5,
"objective": "TE_METRIC",
"operationalState": "DOWN",
"ownership": {
"consumable": true,
"deletable": true,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 3,
"serviceType": "L2_BACKHAUL",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_isis",
"underlyingTransport": "VXLAN"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"availableBw": 10,
"bidirectional": "SYMMETRIC_STRICT",
"bw": 5,
"cost": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 1,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 10,
"id": "string",
"latency": 4,
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Delete"
},
"maxCost": 3,
"maxHops": 5,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 8,
"objective": "STAR_WEIGHT",
"operationalState": "PARTIALLY_DOWN",
"ownership": {
"consumable": true,
"deletable": false,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 2,
"latency": 2
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"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"
]
}
],
"id": "string",
"linkCost": {
"cost": 2,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 1
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 5,
"serviceType": "IES",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_pcc_initiated",
"underlyingTransport": "GRE"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"availableBw": 1,
"bidirectional": "NO",
"bw": 9,
"cost": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 10,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 10,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"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": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"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"
]
}
],
"groupId": "string",
"hops": 1,
"id": "string",
"latency": 4,
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "RoutedAndSaved"
},
"maxCost": 1,
"maxHops": 9,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 5,
"objective": "TE_METRIC",
"operationalState": "UP",
"ownership": {
"consumable": true,
"deletable": true,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 1
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 2
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 9,
"serviceType": "ELINE",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "ldp",
"underlyingTransport": "GRE"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"availableBw": 3,
"bidirectional": "NO",
"bw": 2,
"cost": 3,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 7,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 4,
"id": "string",
"latency": 1,
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Planned"
},
"maxCost": 9,
"maxHops": 9,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 9,
"objective": "LATENCY",
"operationalState": "PARTIALLY_DOWN",
"ownership": {
"consumable": false,
"deletable": true,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 3,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"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"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 8,
"serviceType": "ODU",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_pcc_initiated",
"underlyingTransport": "VXLAN"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"availableBw": 1,
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 7,
"cost": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 7,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "UP",
"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": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 1,
"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": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 9,
"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": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 5,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 3,
"id": "string",
"latency": 4,
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "Planned"
},
"maxCost": 6,
"maxHops": 9,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 8,
"objective": "TE_METRIC",
"operationalState": "DOWN",
"ownership": {
"consumable": false,
"deletable": true,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 7,
"serviceType": "L2_BACKHAUL",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "ldp",
"underlyingTransport": "L2TPV3"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"availableBw": 7,
"bidirectional": "SYMMETRIC_LOOSE",
"bw": 2,
"cost": 2,
"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": 6,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 3,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 9,
"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": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 5,
"id": "string",
"latency": 3,
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "PartiallyDeployed"
},
"maxCost": 5,
"maxHops": 10,
"maxLatency": 4,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 1,
"objective": "COST",
"operationalState": "UP",
"ownership": {
"consumable": false,
"deletable": true,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"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": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 2
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"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"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"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"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 3,
"serviceType": "CLINE",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "sr_isis",
"underlyingTransport": "VXLAN"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"availableBw": 2,
"bidirectional": "ASYMMETRIC_STRICT",
"bw": 5,
"cost": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 3,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 7,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 8,
"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": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 10,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 7,
"id": "string",
"latency": 1,
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "PartiallyDeployed"
},
"maxCost": 7,
"maxHops": 8,
"maxLatency": 7,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 7,
"objective": "TE_METRIC",
"operationalState": "UNKNOWN",
"ownership": {
"consumable": false,
"deletable": false,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 5
},
"lxcontainer": {
"lxinformationList": [
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 2
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 4
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 6,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
}
],
"requestedEndState": "Saved",
"reverseBW": 4,
"serviceType": "EACCESS",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "rsvp_strict",
"underlyingTransport": "IPV4"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"availableBw": 7,
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 5,
"cost": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 4,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 6,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 5,
"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": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 6,
"id": "string",
"latency": 5,
"lifeCycle": {
"phase": "Activation",
"reason": "string",
"state": "Deployed"
},
"maxCost": 5,
"maxHops": 6,
"maxLatency": 3,
"name": "string",
"neDeploymentState": "FAILED",
"nodeServiceId": 1,
"objective": "HOPS",
"operationalState": "DOWN",
"ownership": {
"consumable": true,
"deletable": true,
"modifiable": false
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 2
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 3,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 1
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": false,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 1
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 8,
"serviceType": "LAG",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "bgp",
"underlyingTransport": "L2TPV3"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"availableBw": 9,
"bidirectional": "ASYMMETRIC_LOOSE",
"bw": 3,
"cost": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 6,
"description": "string",
"destinationEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"destinationNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 10,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"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": "TRANSITION",
"portSpeed": 10,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"hops": 1,
"id": "string",
"latency": 4,
"lifeCycle": {
"phase": "Deployment",
"reason": "string",
"state": "DeploymentFailed"
},
"maxCost": 10,
"maxHops": 10,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "DEPLOYED",
"nodeServiceId": 3,
"objective": "STAR_WEIGHT",
"operationalState": "DOWN",
"ownership": {
"consumable": true,
"deletable": true,
"modifiable": true
},
"pathProfileId": "string",
"physicalLinks": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 8
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "DEGRADED",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 4,
"latency": 6
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "FAILED",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 5,
"latency": 3
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "UP",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string"
]
}
],
"requestedEndState": "Deployed",
"reverseBW": 6,
"serviceType": "CLINE",
"sourceEndpoints": [
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
},
{
"nodeId": "string",
"portId": "string"
}
],
"sourceNodeId": {
"ipv4Address": {},
"ipv6Address": {}
},
"steeringParameters": [
{
"name": {
"string": "string"
}
}
],
"templateId": "string",
"tunnelSelectionId": "string",
"tunnelType": "ldp",
"underlyingTransport": "VXLAN"
}
],
"endRow": 8,
"startRow": 5,
"status": 5,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/{serviceUuid}/endpoint/{endpointUuid}": {
"delete": {
"tags": [
"SdnServices"
],
"operationId": "deleteServiceEndpoint",
"description": "The parameters and request body are for method: deleteServiceEndpoint. 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": "SYMMETRIC_LOOSE",
"bw": 1,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customerId": 2,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 1,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 9,
"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": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 5,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 10,
"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": "UNKNOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "Undeployed"
},
"maxCost": 4,
"maxHops": 9,
"maxLatency": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"nodeServiceId": 1,
"objective": "HOPS",
"operationalState": "UP",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 2,
"serviceType": "L2_EXTENSION_NNI",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 10,
"startRow": 2,
"status": 6,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
},
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/{serviceUuid}/endpoints": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getEndpoints",
"description": "The parameters and request body are for method: getEndpoints. 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": "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"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"actualEndState": "Deployed",
"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": "TRANSITION",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 7,
"serviceId": "string"
}
],
"endRow": 4,
"startRow": 9,
"status": 4,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/services/{uuid}": {
"get": {
"tags": [
"SdnServices"
],
"operationId": "getV4ServicesUuid",
"description": "The parameters and request body are for method: getV4ServicesUuid. 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": "Saved",
"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"
}
],
"customAttributesTemplateId": "string",
"customerId": 8,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 2,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 9,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 3,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 2,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DEGRADED",
"portSpeed": 4,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "DOWN",
"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": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "TRANSITION",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "MAINTENANCE",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 2,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Planning",
"reason": "string",
"state": "Routing"
},
"maxCost": 1,
"maxHops": 8,
"maxLatency": 2,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 1,
"objective": "COST",
"operationalState": "PARTIALLY_DOWN",
"pathProfileId": "string",
"requestedEndState": "Deployed",
"reverseBW": 1,
"serviceType": "ODU",
"templateId": "string",
"tunnelSelectionId": "string"
},
"endRow": 4,
"startRow": 4,
"status": 8,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"delete": {
"tags": [
"SdnServices"
],
"operationId": "deleteV4ServicesUuid",
"description": "The parameters and request body are for method: deleteV4ServicesUuid. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 3,
"status": 9,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ietf/te/link/{linkId}": {
"get": {
"tags": [
"SdnIetf"
],
"operationId": "getLink",
"description": "The parameters and request body are for method: getLink. 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": {
"destination": {
"type": "object",
"properties": {
"destNode": {
"type": "string"
},
"destTp": {
"type": "string"
}
}
},
"linkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"nspLink": {
"type": "object",
"properties": {
"linkConfig": {
"type": "object"
},
"linkState": {
"type": "object"
}
}
},
"source": {
"type": "object",
"properties": {
"sourceNode": {
"type": "string"
},
"sourceTp": {
"type": "string"
}
}
},
"supportingLink": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"destination": {
"destNode": "string",
"destTp": "string"
},
"linkId": {
"uri": {}
},
"nspLink": {
"linkConfig": {},
"linkState": {}
},
"source": {
"sourceNode": "string",
"sourceTp": "string"
},
"supportingLink": {}
},
"endRow": 5,
"startRow": 3,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ietf/te/link/{linkUuid}": {
"patch": {
"tags": [
"SdnIetf"
],
"operationId": "patchLink",
"description": "The parameters and request body are for method: patchLink. 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": {
"destination": {
"type": "object",
"properties": {
"destNode": {
"type": "string"
},
"destTp": {
"type": "string"
}
}
},
"linkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"nspLink": {
"type": "object",
"properties": {
"linkConfig": {
"type": "object"
},
"linkState": {
"type": "object"
}
}
},
"source": {
"type": "object",
"properties": {
"sourceNode": {
"type": "string"
},
"sourceTp": {
"type": "string"
}
}
},
"supportingLink": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"destination": {
"destNode": "string",
"destTp": "string"
},
"linkId": {
"uri": {}
},
"nspLink": {
"linkConfig": {},
"linkState": {}
},
"source": {
"sourceNode": "string",
"sourceTp": "string"
},
"supportingLink": {}
},
"endRow": 2,
"startRow": 6,
"status": 4,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "linkUuid",
"in": "path",
"required": true,
"schema": {
"title": "linkUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/ietf/te/network/{networkId}": {
"get": {
"tags": [
"SdnIetf"
],
"operationId": "getNetwork",
"description": "The parameters and request body are for method: getNetwork. 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": {
"link": {
"type": "object"
},
"networkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"networkTypes": {
"type": "object"
},
"node": {
"type": "object"
},
"nspNetwork": {
"type": "object",
"properties": {
"networkConfig": {
"type": "object"
},
"networkName": {
"type": "string"
},
"networkState": {
"type": "object"
}
}
},
"serverProvided": {
"type": "boolean"
},
"supportingNetwork": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"link": {},
"networkId": {
"uri": {}
},
"networkTypes": {},
"node": {},
"nspNetwork": {
"networkConfig": {},
"networkName": "string",
"networkState": {}
},
"serverProvided": false,
"supportingNetwork": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
"endRow": 9,
"startRow": 7,
"status": 4,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"title": "networkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ietf/te/networks": {
"get": {
"tags": [
"SdnIetf"
],
"operationId": "getNetworks",
"description": "The parameters and request body are for method: getNetworks. 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": {
"network": {
"type": "object"
},
"nspNetworks": {
"type": "object",
"properties": {
"networksConfig": {
"type": "object"
},
"networksState": {
"type": "object"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"network": {},
"nspNetworks": {
"networksConfig": {},
"networksState": {}
}
},
"endRow": 6,
"startRow": 8,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ietf/te/node/{nodeId}": {
"get": {
"tags": [
"SdnIetf"
],
"operationId": "getNode",
"description": "The parameters and request body are for method: getNode. 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": {
"nodeId": {
"type": "object"
},
"nspNode": {
"type": "object"
},
"supportingNode": {
"type": "object"
},
"terminationPoint": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"nodeId": {},
"nspNode": {},
"supportingNode": {},
"terminationPoint": {}
},
"endRow": 10,
"startRow": 2,
"status": 10,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "nodeId",
"in": "path",
"required": true,
"schema": {
"title": "nodeId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ietf/te/termination-point/{tpId}": {
"get": {
"tags": [
"SdnIetf"
],
"operationId": "getTerminationPoint",
"description": "The parameters and request body are for method: getTerminationPoint. 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": {
"nspTerminationPoint": {
"type": "object",
"properties": {
"terminationPointConfig": {
"type": "object"
},
"terminationPointState": {
"type": "object"
}
}
},
"supportingTerminationPoint": {
"type": "object"
},
"tpId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"nspTerminationPoint": {
"terminationPointConfig": {},
"terminationPointState": {}
},
"supportingTerminationPoint": {},
"tpId": {
"uri": {}
}
},
"endRow": 5,
"startRow": 7,
"status": 4,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "tpId",
"in": "path",
"required": true,
"schema": {
"title": "tpId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/l2/backhaul/paths/l2-paths": {
"get": {
"tags": [
"SdnBackhaulPaths"
],
"operationId": "getL2Paths",
"description": "The parameters and request body are for method: getL2Paths. 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": {
"isHetrogenous": {
"type": "boolean"
},
"methodType": {
"type": "string"
},
"pathNumber": {
"type": "number"
},
"routeList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accessLtpId": {
"type": "object",
"properties": {
"ipAddress": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"uint32": {
"type": "number"
}
}
},
"accessNodeId": {
"type": "object",
"properties": {
"dottedQuad": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
},
"bandwidthProfiles": {
"type": "object",
"properties": {
"egressBandwidthProfileName": {
"type": "string"
},
"ingressBandwidthProfileName": {
"type": "string"
},
"ingressEgressBandwidthProfileName": {
"type": "string"
}
}
},
"baseEndpointRequest": {
"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"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"readOnly": {
"type": "boolean"
}
}
},
"outerTag": {
"type": "object",
"properties": {
"vlanClassification": {
"type": "object",
"properties": {
"tagType": {
"type": "object"
},
"vlanRange": {
"type": "object"
},
"vlanValue": {
"type": "object"
}
}
}
}
},
"secondTag": {
"type": "object",
"properties": {
"vlanClassification": {
"type": "object",
"properties": {
"tagType": {
"type": "object"
},
"vlanRange": {
"type": "object"
},
"vlanValue": {
"type": "object"
}
}
}
}
},
"serviceClassificationType": {
"type": "object"
},
"splitHorizonGroup": {
"type": "string"
},
"vlanOperations": {
"type": "object",
"properties": {
"asymmetricalOperation": {
"type": "object",
"properties": {
"egress": {
"type": "object"
},
"ingress": {
"type": "object"
}
}
},
"symmetricalOperation": {
"type": "object",
"properties": {
"vlanOperations": {
"type": "object"
}
}
}
}
}
}
}
},
"sourceService": {
"type": "string"
},
"uuid": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"isHetrogenous": false,
"methodType": "RING_COMPLETION",
"pathNumber": 8,
"routeList": [
{
"accessLtpId": {
"ipAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"uint32": 8
},
"accessNodeId": {
"dottedQuad": {
"string": "string"
}
},
"bandwidthProfiles": {
"egressBandwidthProfileName": "string",
"ingressBandwidthProfileName": "string",
"ingressEgressBandwidthProfileName": "string"
},
"baseEndpointRequest": {
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"description": "string",
"id": "string",
"name": "string",
"readOnly": false
},
"outerTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"secondTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"serviceClassificationType": {},
"splitHorizonGroup": "string",
"vlanOperations": {
"asymmetricalOperation": {
"egress": {},
"ingress": {}
},
"symmetricalOperation": {
"vlanOperations": {}
}
}
},
{
"accessLtpId": {
"ipAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"uint32": 10
},
"accessNodeId": {
"dottedQuad": {
"string": "string"
}
},
"bandwidthProfiles": {
"egressBandwidthProfileName": "string",
"ingressBandwidthProfileName": "string",
"ingressEgressBandwidthProfileName": "string"
},
"baseEndpointRequest": {
"adminState": "MAINTENANCE",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"description": "string",
"id": "string",
"name": "string",
"readOnly": false
},
"outerTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"secondTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"serviceClassificationType": {},
"splitHorizonGroup": "string",
"vlanOperations": {
"asymmetricalOperation": {
"egress": {},
"ingress": {}
},
"symmetricalOperation": {
"vlanOperations": {}
}
}
},
{
"accessLtpId": {
"ipAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"uint32": 4
},
"accessNodeId": {
"dottedQuad": {
"string": "string"
}
},
"bandwidthProfiles": {
"egressBandwidthProfileName": "string",
"ingressBandwidthProfileName": "string",
"ingressEgressBandwidthProfileName": "string"
},
"baseEndpointRequest": {
"adminState": "MAINTENANCE",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"description": "string",
"id": "string",
"name": "string",
"readOnly": true
},
"outerTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"secondTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"serviceClassificationType": {},
"splitHorizonGroup": "string",
"vlanOperations": {
"asymmetricalOperation": {
"egress": {},
"ingress": {}
},
"symmetricalOperation": {
"vlanOperations": {}
}
}
},
{
"accessLtpId": {
"ipAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"uint32": 3
},
"accessNodeId": {
"dottedQuad": {
"string": "string"
}
},
"bandwidthProfiles": {
"egressBandwidthProfileName": "string",
"ingressBandwidthProfileName": "string",
"ingressEgressBandwidthProfileName": "string"
},
"baseEndpointRequest": {
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"description": "string",
"id": "string",
"name": "string",
"readOnly": true
},
"outerTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"secondTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"serviceClassificationType": {},
"splitHorizonGroup": "string",
"vlanOperations": {
"asymmetricalOperation": {
"egress": {},
"ingress": {}
},
"symmetricalOperation": {
"vlanOperations": {}
}
}
},
{
"accessLtpId": {
"ipAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"uint32": 7
},
"accessNodeId": {
"dottedQuad": {
"string": "string"
}
},
"bandwidthProfiles": {
"egressBandwidthProfileName": "string",
"ingressBandwidthProfileName": "string",
"ingressEgressBandwidthProfileName": "string"
},
"baseEndpointRequest": {
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"description": "string",
"id": "string",
"name": "string",
"readOnly": true
},
"outerTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"secondTag": {
"vlanClassification": {
"tagType": {},
"vlanRange": {},
"vlanValue": {}
}
},
"serviceClassificationType": {},
"splitHorizonGroup": "string",
"vlanOperations": {
"asymmetricalOperation": {
"egress": {},
"ingress": {}
},
"symmetricalOperation": {
"vlanOperations": {}
}
}
}
],
"sourceService": "string",
"uuid": "string"
},
"endRow": 5,
"startRow": 3,
"status": 3,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mediation/ami-version-templates": {
"get": {
"tags": [
"SdnMediation"
],
"operationId": "getAmiVersionTemplates",
"description": "The parameters and request body are for method: getAmiVersionTemplates. 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": "object",
"properties": {
"amiName": {
"type": "string"
},
"amiVersion": {
"type": "string"
},
"globalTemplateNames": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"amiName": "string",
"amiVersion": "string",
"globalTemplateNames": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersion": "string",
"globalTemplateNames": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"endRow": 7,
"startRow": 10,
"status": 4,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mediation/amis-versions": {
"get": {
"tags": [
"SdnMediation"
],
"operationId": "getAmisVersions",
"description": "The parameters and request body are for method: getAmisVersions. 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": "object",
"properties": {
"amiName": {
"type": "string"
},
"amiVersions": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string",
"string"
]
},
{
"amiName": "string",
"amiVersions": [
"string",
"string"
]
}
],
"endRow": 6,
"startRow": 10,
"status": 8,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mediation/augmentation-meta": {
"get": {
"tags": [
"SdnMediation"
],
"operationId": "getAllAugmentationMeta",
"description": "The parameters and request body are for method: getAllAugmentationMeta. 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": "object",
"properties": {
"id": {
"type": "string"
},
"pathName": {
"type": "string"
},
"templateName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"id": "string",
"pathName": "string",
"templateName": "string"
}
],
"endRow": 2,
"startRow": 1,
"status": 3,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnMediation"
],
"operationId": "createAugmentationMeta",
"description": "The parameters and request body are for method: createAugmentationMeta. 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": {
"augmentationMetaInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pathName": {
"type": "string"
},
"templateName": {
"type": "string"
}
}
},
"augmentationMetaJsonFileName": {
"type": "object",
"properties": {
"jsonFileName": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"augmentationMetaInput": {
"id": "string",
"pathName": "string",
"templateName": "string"
},
"augmentationMetaJsonFileName": {
"jsonFileName": "string"
}
},
"endRow": 3,
"startRow": 6,
"status": 4,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mediation/augmentation-meta/{id}": {
"put": {
"tags": [
"SdnMediation"
],
"operationId": "updateAugmentationMeta",
"description": "The parameters and request body are for method: updateAugmentationMeta. 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": {
"augmentationMetaInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pathName": {
"type": "string"
},
"templateName": {
"type": "string"
}
}
},
"augmentationMetaJsonFileName": {
"type": "object",
"properties": {
"jsonFileName": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"augmentationMetaInput": {
"id": "string",
"pathName": "string",
"templateName": "string"
},
"augmentationMetaJsonFileName": {
"jsonFileName": "string"
}
},
"endRow": 2,
"startRow": 6,
"status": 10,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnMediation"
],
"operationId": "deleteAugmentationMeta",
"description": "The parameters and request body are for method: deleteAugmentationMeta. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 7,
"startRow": 7,
"status": 3,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mediation/mediation-augmentation": {
"post": {
"tags": [
"SdnMediation"
],
"operationId": "getMediationAugmentation",
"description": "The parameters and request body are for method: getMediationAugmentation. 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": "INIT",
"endRow": 10,
"startRow": 1,
"status": 2,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-list": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "fetchLspList",
"description": "The parameters and request body are for method: fetchLspList. 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": "object",
"properties": {
"externalId": {
"type": "object"
},
"lspId": {
"type": "string"
},
"lspName": {
"type": "string"
},
"measuredBandwidth": {
"type": "number"
},
"paths": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 8,
"paths": {},
"tunnelId": 6
},
{
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 6,
"paths": {},
"tunnelId": 8
}
],
"endRow": 5,
"startRow": 10,
"status": 10,
"totalRows": 2
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-path": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "createLspPath",
"description": "The parameters and request body are for method: createLspPath. 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": 3,
"status": 6,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-path-list": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "fetchLspPathList",
"description": "The parameters and request body are for method: fetchLspPathList. 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": "object",
"properties": {
"administrativeFailureErrorCode": {
"type": "string"
},
"administrativeState": {
"type": "string"
},
"computationState": {
"type": "string"
},
"computedHops": {
"type": "object"
},
"creationType": {
"type": "string"
},
"destinationAddress": {
"type": "object"
},
"destinationId": {
"type": "string"
},
"destinationNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"latency": {
"type": "number"
},
"lifecycleState": {
"type": "string"
},
"lspId": {
"type": "string"
},
"maintenanceAffected": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"ownershipState": {
"type": "object"
},
"paramsConfig": {
"type": "object"
},
"paramsState": {
"type": "object"
},
"pathErrorCode": {
"type": "string"
},
"pathId": {
"type": "string"
},
"pathName": {
"type": "string"
},
"pathType": {
"type": "string"
},
"protectionState": {
"type": "string"
},
"protectionType": {
"type": "string"
},
"provisionedHops": {
"type": "object"
},
"recordedHops": {
"type": "object"
},
"sourceAddress": {
"type": "object"
},
"sourceId": {
"type": "string"
},
"sourceNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceRouterAddress": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"administrativeFailureErrorCode": "VSR_NOT_CAPABLE",
"administrativeState": "DOWN",
"computationState": "PATH_FOUND",
"computedHops": {},
"creationType": "INITIATED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 7,
"lifecycleState": "DeploymentFailed",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "PARTIALLY_DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "SRC_NOT_EXIST",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "INACTIVE",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 7
},
{
"administrativeFailureErrorCode": "VSR_NOT_CAPABLE",
"administrativeState": "UP",
"computationState": "PATH_NOT_FOUND",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string"
],
"latency": 1,
"lifecycleState": "Deploying",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "SYNC_DELETE",
"pathId": "string",
"pathName": "string",
"pathType": "RSVP",
"protectionState": "INACTIVE",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 10
},
{
"administrativeFailureErrorCode": "NO_ERROR",
"administrativeState": "UP",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "INITIATED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 2,
"lifecycleState": "Delete",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "ADMIN_DOWN",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 2
},
{
"administrativeFailureErrorCode": "NO_RESPONSE",
"administrativeState": "DOWN",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "DISCOVERED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 9,
"lifecycleState": "Deploying",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "INVALID_PLSPID",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "PRIMARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 4
},
{
"administrativeFailureErrorCode": "PCC_NOT_EXIST",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "INITIATED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 7,
"lifecycleState": "Delete",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "TRANSITION",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PATH_NAME_IN_USE",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 8
},
{
"administrativeFailureErrorCode": "LSP_BAD_PARAM",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_FOUND",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 10,
"lifecycleState": "DeploymentFailed",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "UP",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "SRC_NOT_EXIST",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "ACTIVE",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 7
},
{
"administrativeFailureErrorCode": "VSR_NOT_CAPABLE",
"administrativeState": "UP",
"computationState": "PATH_FOUND",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 1,
"lifecycleState": "Undeploy",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "UNKNOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "VSR_NOT_CAPABLE",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 6
},
{
"administrativeFailureErrorCode": "ADMIN_DOWN",
"administrativeState": "UP",
"computationState": "PATH_NOT_COMPUTED",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 3,
"lifecycleState": "PartiallyDeployed",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "SIGNALLING",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "PRIMARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 9
},
{
"administrativeFailureErrorCode": "PATH_NAME_IN_USE",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_FOUND",
"computedHops": {},
"creationType": "DISCOVERED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 1,
"lifecycleState": "Saved",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "UNKNOWN_REASON",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "ACTIVE",
"protectionType": "PRIMARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 5
},
{
"administrativeFailureErrorCode": "VSR_NOT_EXSIST",
"administrativeState": "UP",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string"
],
"latency": 9,
"lifecycleState": "Undeploy",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "UP",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "UNKNOWN_REASON",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "ACTIVE",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 4
}
],
"endRow": 10,
"startRow": 6,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-path/{pathId}": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getLspPath",
"description": "The parameters and request body are for method: getLspPath. 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": {
"administrativeFailureErrorCode": {
"type": "string"
},
"administrativeState": {
"type": "string"
},
"computationState": {
"type": "string"
},
"computedHops": {
"type": "object"
},
"creationType": {
"type": "string"
},
"destinationAddress": {
"type": "object"
},
"destinationId": {
"type": "string"
},
"destinationNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"latency": {
"type": "number"
},
"lifecycleState": {
"type": "string"
},
"lspId": {
"type": "string"
},
"maintenanceAffected": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"ownershipState": {
"type": "object"
},
"paramsConfig": {
"type": "object"
},
"paramsState": {
"type": "object"
},
"pathErrorCode": {
"type": "string"
},
"pathId": {
"type": "string"
},
"pathName": {
"type": "string"
},
"pathType": {
"type": "string"
},
"protectionState": {
"type": "string"
},
"protectionType": {
"type": "string"
},
"provisionedHops": {
"type": "object"
},
"recordedHops": {
"type": "object"
},
"sourceAddress": {
"type": "object"
},
"sourceId": {
"type": "string"
},
"sourceNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceRouterAddress": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"administrativeFailureErrorCode": "PATH_NAME_IN_USE",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 2,
"lifecycleState": "DeploymentFailed",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "UNKNOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "NO_ERROR",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "ACTIVE",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 3
},
"endRow": 6,
"startRow": 2,
"status": 6,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "pathId",
"in": "path",
"required": true,
"schema": {
"title": "pathId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"delete": {
"tags": [
"SdnMpls"
],
"operationId": "deleteLspPath",
"description": "The parameters and request body are for method: deleteLspPath. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 6,
"startRow": 9,
"status": 9,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "pathId",
"in": "path",
"required": true,
"schema": {
"title": "pathId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnMpls"
],
"operationId": "patchLspPath",
"description": "The parameters and request body are for method: patchLspPath. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 8,
"startRow": 5,
"status": 5,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "pathId",
"in": "path",
"required": true,
"schema": {
"title": "pathId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-paths": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getLspPaths",
"description": "The parameters and request body are for method: getLspPaths. 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": "object",
"properties": {
"administrativeFailureErrorCode": {
"type": "string"
},
"administrativeState": {
"type": "string"
},
"computationState": {
"type": "string"
},
"computedHops": {
"type": "object"
},
"creationType": {
"type": "string"
},
"destinationAddress": {
"type": "object"
},
"destinationId": {
"type": "string"
},
"destinationNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"latency": {
"type": "number"
},
"lifecycleState": {
"type": "string"
},
"lspId": {
"type": "string"
},
"maintenanceAffected": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"ownershipState": {
"type": "object"
},
"paramsConfig": {
"type": "object"
},
"paramsState": {
"type": "object"
},
"pathErrorCode": {
"type": "string"
},
"pathId": {
"type": "string"
},
"pathName": {
"type": "string"
},
"pathType": {
"type": "string"
},
"protectionState": {
"type": "string"
},
"protectionType": {
"type": "string"
},
"provisionedHops": {
"type": "object"
},
"recordedHops": {
"type": "object"
},
"sourceAddress": {
"type": "object"
},
"sourceId": {
"type": "string"
},
"sourceNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceRouterAddress": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"administrativeFailureErrorCode": "UNDEFINED_PATH_ERR",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 9,
"lifecycleState": "Deploying",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "LIMIT_RCHD",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "ACTIVE",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 9
},
{
"administrativeFailureErrorCode": "SIGNALLING",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "INITIATED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string"
],
"latency": 3,
"lifecycleState": "DeploymentFailed",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "INTERNAL_ERROR",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "INACTIVE",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 1
},
{
"administrativeFailureErrorCode": "SIGNALLING",
"administrativeState": "UP",
"computationState": "PATH_FOUND",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string"
],
"latency": 3,
"lifecycleState": "Planned",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "INTERNAL_ERROR",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "INACTIVE",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 8
},
{
"administrativeFailureErrorCode": "PCC_NOT_CAPABLE",
"administrativeState": "MAINTENANCE",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 4,
"lifecycleState": "Routing",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "UP",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PCC_ADMIN_DOWN",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "ACTIVE",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 1
},
{
"administrativeFailureErrorCode": "PCC_NOT_CAPABLE",
"administrativeState": "DOWN",
"computationState": "PATH_FOUND",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 8,
"lifecycleState": "DeploymentFailed",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "VSR_NOT_EXSIST",
"pathId": "string",
"pathName": "string",
"pathType": "RSVP",
"protectionState": "INACTIVE",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 5
},
{
"administrativeFailureErrorCode": "UNKNOWN_REASON",
"administrativeState": "UP",
"computationState": "PATH_NOT_COMPUTED",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 2,
"lifecycleState": "Undeploy",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "ADMIN_DOWN",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 7
},
{
"administrativeFailureErrorCode": "PCE_NOT_FOUND",
"administrativeState": "DOWN",
"computationState": "PATH_NOT_FOUND",
"computedHops": {},
"creationType": "INITIATED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string"
],
"latency": 4,
"lifecycleState": "RoutingFailed",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "UNKNOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PCC_ADMIN_DOWN",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "ACTIVE",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 4
},
{
"administrativeFailureErrorCode": "SRC_NOT_UNIQUE",
"administrativeState": "DOWN",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 10,
"lifecycleState": "Undeploy",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "UNKNOWN_REASON",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 9
},
{
"administrativeFailureErrorCode": "LIMIT_RCHD",
"administrativeState": "UP",
"computationState": "PATH_NOT_FOUND",
"computedHops": {},
"creationType": "INITIATED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string"
],
"latency": 3,
"lifecycleState": "Saved",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "LIMIT_RCHD",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "PRIMARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 6
},
{
"administrativeFailureErrorCode": "VSR_NOT_EXSIST",
"administrativeState": "DOWN",
"computationState": "PATH_ERROR",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 4,
"lifecycleState": "Saved",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PROTO_DISCONNECTED",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string"
],
"sourceRouterAddress": {},
"tunnelId": 5
}
],
"endRow": 4,
"startRow": 5,
"status": 5,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnMpls"
],
"operationId": "createLspPaths",
"description": "The parameters and request body are for method: createLspPaths. 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",
"ADMIN",
"OPERATOR",
"OPERATOR",
"OPERATOR",
"USER",
"USER",
"USER",
"OPERATOR"
],
"endRow": 8,
"startRow": 10,
"status": 3,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnMpls"
],
"operationId": "deleteLspPaths",
"description": "The parameters and request body are for method: deleteLspPaths. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 7,
"startRow": 6,
"status": 6,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-paths-paginated/{limit}/{page}": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getLspPathsPaginated",
"description": "The parameters and request body are for method: getLspPathsPaginated. 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": "object",
"properties": {
"administrativeFailureErrorCode": {
"type": "string"
},
"administrativeState": {
"type": "string"
},
"computationState": {
"type": "string"
},
"computedHops": {
"type": "object"
},
"creationType": {
"type": "string"
},
"destinationAddress": {
"type": "object"
},
"destinationId": {
"type": "string"
},
"destinationNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"latency": {
"type": "number"
},
"lifecycleState": {
"type": "string"
},
"lspId": {
"type": "string"
},
"maintenanceAffected": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"ownershipState": {
"type": "object"
},
"paramsConfig": {
"type": "object"
},
"paramsState": {
"type": "object"
},
"pathErrorCode": {
"type": "string"
},
"pathId": {
"type": "string"
},
"pathName": {
"type": "string"
},
"pathType": {
"type": "string"
},
"protectionState": {
"type": "string"
},
"protectionType": {
"type": "string"
},
"provisionedHops": {
"type": "object"
},
"recordedHops": {
"type": "object"
},
"sourceAddress": {
"type": "object"
},
"sourceId": {
"type": "string"
},
"sourceNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceRouterAddress": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"administrativeFailureErrorCode": "INTERNAL_ERROR",
"administrativeState": "MAINTENANCE",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string"
],
"latency": 6,
"lifecycleState": "PartiallyDeployed",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "UNKNOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PCC_NOT_EXIST",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "ACTIVE",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 3
},
{
"administrativeFailureErrorCode": "UNKNOWN_REASON",
"administrativeState": "DOWN",
"computationState": "PATH_NOT_FOUND",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string"
],
"latency": 8,
"lifecycleState": "Routing",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "SYNC_DELETE",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "PRIMARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 2
},
{
"administrativeFailureErrorCode": "PCE_NOT_FOUND",
"administrativeState": "DOWN",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "REQUESTED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 5,
"lifecycleState": "RoutingFailed",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "UNKNOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "INTERNAL_ERROR",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "ACTIVE",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 4
},
{
"administrativeFailureErrorCode": "UNACCEPTABLE_PARAM",
"administrativeState": "DOWN",
"computationState": "PATH_NOT_COMPUTED",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string"
],
"latency": 2,
"lifecycleState": "Saved",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "UP",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PCE_NOT_FOUND",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 4
},
{
"administrativeFailureErrorCode": "NO_ERROR",
"administrativeState": "UP",
"computationState": "PATH_NOT_COMPUTED",
"computedHops": {},
"creationType": "DISCOVERED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 9,
"lifecycleState": "DeploymentFailed",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "PARTIALLY_DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PCC_INTERNAL_ERROR",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 8
},
{
"administrativeFailureErrorCode": "NSP_INTERNAL",
"administrativeState": "UP",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string"
],
"latency": 8,
"lifecycleState": "Deployed",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "DEGRADED",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PCC_NOT_EXIST",
"pathId": "string",
"pathName": "string",
"pathType": "RSVP",
"protectionState": "ACTIVE",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 3
},
{
"administrativeFailureErrorCode": "UNDEFINED_PATH_ERR",
"administrativeState": "UP",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string"
],
"latency": 2,
"lifecycleState": "Undeployed",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "PARTIALLY_DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "INVALID_PLSPID",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "UNKNOWN",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 1
},
{
"administrativeFailureErrorCode": "UNACCEPTABLE_PARAM",
"administrativeState": "UP",
"computationState": "PATH_NOT_FOUND",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string"
],
"latency": 1,
"lifecycleState": "WaitingForDeployment",
"lspId": "string",
"maintenanceAffected": "NONE",
"operationalState": "UNKNOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "VSR_NOT_EXSIST",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "ACTIVE",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 2
},
{
"administrativeFailureErrorCode": "NO_RESPONSE",
"administrativeState": "MAINTENANCE",
"computationState": "PATH_NOT_COMPUTED",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string"
],
"latency": 4,
"lifecycleState": "Deployed",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "UP",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "SYNC_DELETE",
"pathId": "string",
"pathName": "string",
"pathType": "UNKNOWN",
"protectionState": "INACTIVE",
"protectionType": "STANDBY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 8
}
],
"endRow": 8,
"startRow": 1,
"status": 9,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "limit",
"in": "path",
"required": true,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "page",
"in": "path",
"required": true,
"schema": {
"title": "page",
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/lsp/{lspId}": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getLsp",
"description": "The parameters and request body are for method: getLsp. 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": {
"externalId": {
"type": "object"
},
"lspId": {
"type": "string"
},
"lspName": {
"type": "string"
},
"measuredBandwidth": {
"type": "number"
},
"paths": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 4,
"paths": {},
"tunnelId": 9
},
"endRow": 4,
"startRow": 9,
"status": 3,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "lspId",
"in": "path",
"required": true,
"schema": {
"title": "lspId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/lsps": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getLsps",
"description": "The parameters and request body are for method: getLsps. 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": "object",
"properties": {
"externalId": {
"type": "object"
},
"lspId": {
"type": "string"
},
"lspName": {
"type": "string"
},
"measuredBandwidth": {
"type": "number"
},
"paths": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 7,
"paths": {},
"tunnelId": 1
},
{
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 9,
"paths": {},
"tunnelId": 2
},
{
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 2,
"paths": {},
"tunnelId": 5
},
{
"externalId": {},
"lspId": "string",
"lspName": "string",
"measuredBandwidth": 6,
"paths": {},
"tunnelId": 4
}
],
"endRow": 9,
"startRow": 5,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/optimization": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "createOptimization",
"description": "The parameters and request body are for method: createOptimization. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 9,
"startRow": 1,
"status": 1,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/resignal": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "createResignal",
"description": "The parameters and request body are for method: createResignal. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 4,
"status": 2,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp/paths/on-link/{linkId}/{requestType}": {
"get": {
"tags": [
"SdnMplsLspPath"
],
"operationId": "getOnLink",
"description": "The parameters and request body are for method: getOnLink. 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": "object",
"properties": {
"administrativeFailureErrorCode": {
"type": "string"
},
"administrativeState": {
"type": "string"
},
"computationState": {
"type": "string"
},
"computedHops": {
"type": "object"
},
"creationType": {
"type": "string"
},
"destinationAddress": {
"type": "object"
},
"destinationId": {
"type": "string"
},
"destinationNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"latency": {
"type": "number"
},
"lifecycleState": {
"type": "string"
},
"lspId": {
"type": "string"
},
"maintenanceAffected": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"ownershipState": {
"type": "object"
},
"paramsConfig": {
"type": "object"
},
"paramsState": {
"type": "object"
},
"pathErrorCode": {
"type": "string"
},
"pathId": {
"type": "string"
},
"pathName": {
"type": "string"
},
"pathType": {
"type": "string"
},
"protectionState": {
"type": "string"
},
"protectionType": {
"type": "string"
},
"provisionedHops": {
"type": "object"
},
"recordedHops": {
"type": "object"
},
"sourceAddress": {
"type": "object"
},
"sourceId": {
"type": "string"
},
"sourceNetworkName": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceRouterAddress": {
"type": "object"
},
"tunnelId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"administrativeFailureErrorCode": "PCC_NOT_CAPABLE",
"administrativeState": "UP",
"computationState": "PATH_NOT_FOUND",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 4,
"lifecycleState": "RoutedAndSaved",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PROTO_DISCONNECTED",
"pathId": "string",
"pathName": "string",
"pathType": "RSVP",
"protectionState": "UNKNOWN",
"protectionType": "PRIMARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 6
},
{
"administrativeFailureErrorCode": "NSP_INTERNAL",
"administrativeState": "MAINTENANCE",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "PROVISIONED",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string"
],
"latency": 5,
"lifecycleState": "Deploying",
"lspId": "string",
"maintenanceAffected": "HOPS_IN_MAINTENANCE",
"operationalState": "UP",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "NO_ERROR",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "UNKNOWN",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 5
},
{
"administrativeFailureErrorCode": "UNDEFINED_PATH_ERR",
"administrativeState": "DOWN",
"computationState": "UNKNOWN",
"computedHops": {},
"creationType": "UNKNOWN",
"destinationAddress": {},
"destinationId": "string",
"destinationNetworkName": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"latency": 6,
"lifecycleState": "Saved",
"lspId": "string",
"maintenanceAffected": "MAINTENANCE_CLEAR",
"operationalState": "DOWN",
"ownershipState": {},
"paramsConfig": {},
"paramsState": {},
"pathErrorCode": "PATH_NAME_IN_USE",
"pathId": "string",
"pathName": "string",
"pathType": "SRTE",
"protectionState": "UNKNOWN",
"protectionType": "SECONDARY",
"provisionedHops": {},
"recordedHops": {},
"sourceAddress": {},
"sourceId": "string",
"sourceNetworkName": [
"string",
"string",
"string"
],
"sourceRouterAddress": {},
"tunnelId": 9
}
],
"endRow": 4,
"startRow": 6,
"status": 2,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
},
{
"name": "requestType",
"in": "path",
"required": true,
"schema": {
"title": "requestType",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ne": {
"get": {
"tags": [
"SdnNe"
],
"operationId": "gets",
"description": "The parameters and request body are for method: gets. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"baseMacAddress": {
"type": "string"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"customProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"geoLocation": {
"type": "object",
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"id": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"l3vpnCapable": {
"type": "boolean"
},
"location": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"platform": {
"type": "object",
"properties": {
"machine": {
"type": "string"
},
"osName": {
"type": "string"
},
"osRelease": {
"type": "string"
},
"osVersion": {
"type": "string"
}
}
},
"pwSwitchingCapable": {
"type": "boolean"
},
"siteName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "UP",
"appId": "string",
"baseMacAddress": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
}
],
"geoLocation": {
"latitude": 10,
"longitude": 4
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": true,
"location": "string",
"neDeploymentState": "FAILED",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
{
"adminState": "UP",
"appId": "string",
"baseMacAddress": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string"
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"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"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 10,
"longitude": 10
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": true,
"location": "string",
"neDeploymentState": "UNKNOWN",
"nspDbFdn": "string",
"operationalState": "DOWN",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"baseMacAddress": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 2,
"longitude": 1
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": true,
"location": "string",
"neDeploymentState": "PENDING",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": true,
"siteName": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"baseMacAddress": "string",
"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",
"customProperties": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 6,
"longitude": 4
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": false,
"location": "string",
"neDeploymentState": "NA",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"baseMacAddress": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 9,
"longitude": 6
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": true,
"location": "string",
"neDeploymentState": "NA",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"baseMacAddress": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string",
"string"
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 9,
"longitude": 3
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": false,
"location": "string",
"neDeploymentState": "UNKNOWN",
"nspDbFdn": "string",
"operationalState": "DOWN",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"baseMacAddress": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 4,
"longitude": 3
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": false,
"location": "string",
"neDeploymentState": "PENDING",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
}
],
"endRow": 10,
"startRow": 9,
"status": 4,
"totalRows": 2
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ne/system/{systemId}": {
"get": {
"tags": [
"SdnNe"
],
"operationId": "getSystem",
"description": "The parameters and request body are for method: getSystem. 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"
},
"baseMacAddress": {
"type": "string"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"customProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"geoLocation": {
"type": "object",
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"id": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"l3vpnCapable": {
"type": "boolean"
},
"location": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"platform": {
"type": "object",
"properties": {
"machine": {
"type": "string"
},
"osName": {
"type": "string"
},
"osRelease": {
"type": "string"
},
"osVersion": {
"type": "string"
}
}
},
"pwSwitchingCapable": {
"type": "boolean"
},
"siteName": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"baseMacAddress": "string",
"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",
"customProperties": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 4,
"longitude": 9
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": false,
"location": "string",
"neDeploymentState": "DEPLOYED",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
"endRow": 3,
"startRow": 8,
"status": 2,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "systemId",
"in": "path",
"required": true,
"schema": {
"title": "systemId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ne/{id}": {
"put": {
"tags": [
"SdnNe"
],
"operationId": "update",
"description": "The parameters and request body are for method: update. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 6,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/ne/{uuid}": {
"get": {
"tags": [
"SdnNe"
],
"operationId": "getV4NeUuid",
"description": "The parameters and request body are for method: getV4NeUuid. 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"
},
"baseMacAddress": {
"type": "string"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"customProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"geoLocation": {
"type": "object",
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"id": {
"type": "string"
},
"ipAddress": {
"type": "string"
},
"l3vpnCapable": {
"type": "boolean"
},
"location": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"platform": {
"type": "object",
"properties": {
"machine": {
"type": "string"
},
"osName": {
"type": "string"
},
"osRelease": {
"type": "string"
},
"osVersion": {
"type": "string"
}
}
},
"pwSwitchingCapable": {
"type": "boolean"
},
"siteName": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"baseMacAddress": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"customProperties": [
"string",
"string",
"string",
"string"
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"geoLocation": {
"latitude": 9,
"longitude": 7
},
"id": "string",
"ipAddress": "string",
"l3vpnCapable": true,
"location": "string",
"neDeploymentState": "DEPLOYED",
"nspDbFdn": "string",
"operationalState": "UP",
"platform": {
"machine": "string",
"osName": "string",
"osRelease": "string",
"osVersion": "string"
},
"pwSwitchingCapable": false,
"siteName": "string"
},
"endRow": 8,
"startRow": 1,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/configuration/latency": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getLatency",
"description": "The parameters and request body are for method: getLatency. 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": {
"classic": {
"type": "boolean"
},
"modelDriven": {
"type": "boolean"
},
"twampTests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"destination": {
"type": "string"
},
"session": {
"type": "string"
},
"source": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"classic": true,
"modelDriven": true,
"twampTests": [
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
},
{
"destination": "string",
"session": "string",
"source": "string"
}
]
},
"endRow": 6,
"startRow": 8,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchLatency",
"description": "The parameters and request body are for method: patchLatency. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 10,
"status": 8,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/latency/{session}": {
"delete": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "deleteLatency",
"description": "The parameters and request body are for method: deleteLatency. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 7,
"startRow": 7,
"status": 9,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "session",
"in": "path",
"required": true,
"schema": {
"title": "session",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/configuration/tca-config-policy": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getTcaConfigPolicy",
"description": "The parameters and request body are for method: getTcaConfigPolicy. 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": {
"ipTcaPolicyFdn": {
"type": "string"
},
"mplsTcaPolicyFdn": {
"type": "string"
},
"policyEnabled": {
"type": "boolean"
},
"sarIpTcaPolicyFdn": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"ipTcaPolicyFdn": "string",
"mplsTcaPolicyFdn": "string",
"policyEnabled": false,
"sarIpTcaPolicyFdn": "string"
},
"endRow": 6,
"startRow": 7,
"status": 10,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchTcaConfigPolicy",
"description": "The parameters and request body are for method: patchTcaConfigPolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 2,
"status": 2,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/traffic-data-collection": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getTrafficDataCollection",
"description": "The parameters and request body are for method: getTrafficDataCollection. 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": {
"enabled": {
"type": "boolean"
},
"flowCollection": {
"type": "object",
"properties": {
"mplsLabelStackQueryRate": {
"type": "number"
},
"srTeLspEnabled": {
"type": "boolean"
},
"staleStatsWipeInterval": {
"type": "number"
},
"statsTimeToLive": {
"type": "number"
}
}
},
"linkBwTargetThreshold": {
"type": "number"
},
"linkBwTriggerThreshold": {
"type": "number"
},
"source": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"enabled": false,
"flowCollection": {
"mplsLabelStackQueryRate": 10,
"srTeLspEnabled": false,
"staleStatsWipeInterval": 4,
"statsTimeToLive": 9
},
"linkBwTargetThreshold": 2,
"linkBwTriggerThreshold": 10,
"source": "mdm"
},
"endRow": 2,
"startRow": 4,
"status": 5,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchTrafficDataCollection",
"description": "The parameters and request body are for method: patchTrafficDataCollection. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 4,
"startRow": 1,
"status": 7,
"totalRows": 8
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/net/l3/link/tp/{tpId}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getLinkTp",
"description": "The parameters and request body are for method: getLinkTp. 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": {
"destination": {
"type": "object",
"properties": {
"destNode": {
"type": "string"
},
"destTp": {
"type": "string"
}
}
},
"linkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"nspLink": {
"type": "object",
"properties": {
"linkConfig": {
"type": "object"
},
"linkState": {
"type": "object"
}
}
},
"source": {
"type": "object",
"properties": {
"sourceNode": {
"type": "string"
},
"sourceTp": {
"type": "string"
}
}
},
"supportingLink": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"destination": {
"destNode": "string",
"destTp": "string"
},
"linkId": {
"uri": {}
},
"nspLink": {
"linkConfig": {},
"linkState": {}
},
"source": {
"sourceNode": "string",
"sourceTp": "string"
},
"supportingLink": {}
},
"endRow": 2,
"startRow": 2,
"status": 9,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "tpId",
"in": "path",
"required": true,
"schema": {
"title": "tpId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/link/{linkId}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getV4NspNetL3LinkLinkId",
"description": "The parameters and request body are for method: getV4NspNetL3LinkLinkId. 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": {
"destination": {
"type": "object",
"properties": {
"destNode": {
"type": "string"
},
"destTp": {
"type": "string"
}
}
},
"linkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"nspLink": {
"type": "object",
"properties": {
"linkConfig": {
"type": "object"
},
"linkState": {
"type": "object"
}
}
},
"source": {
"type": "object",
"properties": {
"sourceNode": {
"type": "string"
},
"sourceTp": {
"type": "string"
}
}
},
"supportingLink": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"destination": {
"destNode": "string",
"destTp": "string"
},
"linkId": {
"uri": {}
},
"nspLink": {
"linkConfig": {},
"linkState": {}
},
"source": {
"sourceNode": "string",
"sourceTp": "string"
},
"supportingLink": {}
},
"endRow": 3,
"startRow": 8,
"status": 4,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/link/{linkUuid}": {
"patch": {
"tags": [
"SdnNsp"
],
"operationId": "patchV4NspNetL3LinkLinkUuid",
"description": "The parameters and request body are for method: patchV4NspNetL3LinkLinkUuid. 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": {
"destination": {
"type": "object",
"properties": {
"destNode": {
"type": "string"
},
"destTp": {
"type": "string"
}
}
},
"linkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"nspLink": {
"type": "object",
"properties": {
"linkConfig": {
"type": "object"
},
"linkState": {
"type": "object"
}
}
},
"source": {
"type": "object",
"properties": {
"sourceNode": {
"type": "string"
},
"sourceTp": {
"type": "string"
}
}
},
"supportingLink": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"destination": {
"destNode": "string",
"destTp": "string"
},
"linkId": {
"uri": {}
},
"nspLink": {
"linkConfig": {},
"linkState": {}
},
"source": {
"sourceNode": "string",
"sourceTp": "string"
},
"supportingLink": {}
},
"endRow": 10,
"startRow": 8,
"status": 7,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "linkUuid",
"in": "path",
"required": true,
"schema": {
"title": "linkUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/net/l3/network/{networkId}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getV4NspNetL3NetworkNetworkId",
"description": "The parameters and request body are for method: getV4NspNetL3NetworkNetworkId. 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": {
"link": {
"type": "object"
},
"networkId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
},
"networkTypes": {
"type": "object"
},
"node": {
"type": "object"
},
"nspNetwork": {
"type": "object",
"properties": {
"networkConfig": {
"type": "object"
},
"networkName": {
"type": "string"
},
"networkState": {
"type": "object"
}
}
},
"serverProvided": {
"type": "boolean"
},
"supportingNetwork": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"link": {},
"networkId": {
"uri": {}
},
"networkTypes": {},
"node": {},
"nspNetwork": {
"networkConfig": {},
"networkName": "string",
"networkState": {}
},
"serverProvided": true,
"supportingNetwork": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
"endRow": 3,
"startRow": 10,
"status": 3,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"title": "networkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/networks": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getV4NspNetL3Networks",
"description": "The parameters and request body are for method: getV4NspNetL3Networks. 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": {
"network": {
"type": "object"
},
"nspNetworks": {
"type": "object",
"properties": {
"networksConfig": {
"type": "object"
},
"networksState": {
"type": "object"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"network": {},
"nspNetworks": {
"networksConfig": {},
"networksState": {}
}
},
"endRow": 9,
"startRow": 1,
"status": 9,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/node/{nodeId}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getV4NspNetL3NodeNodeId",
"description": "The parameters and request body are for method: getV4NspNetL3NodeNodeId. 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": {
"nodeId": {
"type": "object"
},
"nspNode": {
"type": "object"
},
"supportingNode": {
"type": "object"
},
"terminationPoint": {
"type": "object"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"nodeId": {},
"nspNode": {},
"supportingNode": {},
"terminationPoint": {}
},
"endRow": 8,
"startRow": 10,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "nodeId",
"in": "path",
"required": true,
"schema": {
"title": "nodeId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/nodes/router/{routerId}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getNodesRouter",
"description": "The parameters and request body are for method: getNodesRouter. 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": "object",
"properties": {
"networkId": {
"type": "string"
},
"nodeData": {
"type": "object",
"properties": {
"nspNode": {
"type": "object"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
}
],
"endRow": 6,
"startRow": 9,
"status": 9,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "routerId",
"in": "path",
"required": true,
"schema": {
"title": "routerId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/nodes/site/{siteIp}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getNodesSite",
"description": "The parameters and request body are for method: getNodesSite. 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": "object",
"properties": {
"networkId": {
"type": "string"
},
"nodeData": {
"type": "object",
"properties": {
"nspNode": {
"type": "object"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
},
{
"networkId": "string",
"nodeData": {
"nspNode": {}
}
}
],
"endRow": 3,
"startRow": 9,
"status": 8,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "siteIp",
"in": "path",
"required": true,
"schema": {
"title": "siteIp",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/termination-point/{tpId}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getV4NspNetL3TerminationPointTpId",
"description": "The parameters and request body are for method: getV4NspNetL3TerminationPointTpId. 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": {
"nspTerminationPoint": {
"type": "object",
"properties": {
"terminationPointConfig": {
"type": "object"
},
"terminationPointState": {
"type": "object"
}
}
},
"supportingTerminationPoint": {
"type": "object"
},
"tpId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"nspTerminationPoint": {
"terminationPointConfig": {},
"terminationPointState": {}
},
"supportingTerminationPoint": {},
"tpId": {
"uri": {}
}
},
"endRow": 5,
"startRow": 4,
"status": 9,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "tpId",
"in": "path",
"required": true,
"schema": {
"title": "tpId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/termination-point/{tpId}/reverse": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getTerminationPointReverse",
"description": "The parameters and request body are for method: getTerminationPointReverse. 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": {
"nspTerminationPoint": {
"type": "object",
"properties": {
"terminationPointConfig": {
"type": "object"
},
"terminationPointState": {
"type": "object"
}
}
},
"supportingTerminationPoint": {
"type": "object"
},
"tpId": {
"type": "object",
"properties": {
"uri": {
"type": "object"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"nspTerminationPoint": {
"terminationPointConfig": {},
"terminationPointState": {}
},
"supportingTerminationPoint": {},
"tpId": {
"uri": {}
}
},
"endRow": 6,
"startRow": 10,
"status": 2,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "tpId",
"in": "path",
"required": true,
"schema": {
"title": "tpId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/termination-points/{nodeId}/{ipAddress}": {
"get": {
"tags": [
"SdnNsp"
],
"operationId": "getTerminationPointsNodeip",
"description": "The parameters and request body are for method: getTerminationPointsNodeip. 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": "object",
"properties": {
"terminationPointConfig": {
"type": "object"
},
"terminationPointState": {
"type": "object"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"terminationPointConfig": {},
"terminationPointState": {}
},
{
"terminationPointConfig": {},
"terminationPointState": {}
},
{
"terminationPointConfig": {},
"terminationPointState": {}
},
{
"terminationPointConfig": {},
"terminationPointState": {}
}
],
"endRow": 4,
"startRow": 4,
"status": 5,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "nodeId",
"in": "path",
"required": true,
"schema": {
"title": "nodeId",
"type": "string"
}
},
{
"name": "ipAddress",
"in": "path",
"required": true,
"schema": {
"title": "ipAddress",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/openflow/flows": {
"post": {
"tags": [
"SdnOpenflow"
],
"operationId": "createFlows",
"description": "The parameters and request body are for method: createFlows. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
}
},
"example": {
"result": {},
"setOrExpired": true
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnOpenflow"
],
"operationId": "deleteFlows",
"description": "The parameters and request body are for method: deleteFlows. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
}
},
"example": {
"result": {},
"setOrExpired": false
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"patch": {
"tags": [
"SdnOpenflow"
],
"operationId": "patchFlows",
"description": "The parameters and request body are for method: patchFlows. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
}
},
"example": {
"result": {},
"setOrExpired": true
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/openflow/flows/search": {
"post": {
"tags": [
"SdnOpenflow"
],
"operationId": "getFlowsearch",
"description": "The parameters and request body are for method: getFlowsearch. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "object"
},
"setOrExpired": {
"type": "boolean"
}
}
},
"example": {
"result": {},
"setOrExpired": true
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/openflow/flows/search-by-id": {
"post": {
"tags": [
"SdnOpenflow"
],
"operationId": "getFlowsearchById",
"description": "The parameters and request body are for method: getFlowsearchById. 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": "object",
"properties": {
"applicationGroupId": {
"type": "number"
},
"applicationId": {
"type": "number"
},
"auditstate": {
"type": "string"
},
"cookie": {
"type": "string"
},
"datapathId": {
"type": "string"
},
"flowId": {
"type": "string"
},
"lifecycle": {
"type": "string"
},
"openflowInstruction": {
"type": "object",
"properties": {
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"actionType": {
"type": "string"
},
"experimenterActionType": {
"type": "string"
},
"ipAddress": {
"type": "object"
},
"isIndirect": {
"type": "boolean"
},
"outerVlanId": {
"type": "number"
},
"portId": {
"type": "number"
},
"sdpId": {
"type": "number"
},
"vcId": {
"type": "number"
},
"vlanId": {
"type": "number"
}
}
}
},
"instructionType": {
"type": "string"
}
}
},
"openflowMatch": {
"type": "object",
"properties": {
"destIpAddress": {
"type": "object",
"properties": {
"ipv4Prefix": {
"type": "object"
},
"ipv6Prefix": {
"type": "object"
}
}
},
"destPort": {
"type": "number"
},
"dscp": {
"type": "object",
"properties": {
"uint8": {
"type": "number"
}
}
},
"ethernetType": {
"type": "string"
},
"inPort": {
"type": "number"
},
"ipProtocolType": {
"type": "number"
},
"outerVlanId": {
"type": "number"
},
"sourceIpAddress": {
"type": "object",
"properties": {
"ipv4Prefix": {
"type": "object"
},
"ipv6Prefix": {
"type": "object"
}
}
},
"sourcePort": {
"type": "number"
},
"vlanId": {
"type": "number"
}
}
},
"priority": {
"type": "number"
},
"tableId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"applicationGroupId": 7,
"applicationId": 9,
"auditstate": "NOT_DONE",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "PENDING_CREATE",
"openflowInstruction": {
"actions": [
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 2,
"portId": 5,
"sdpId": 4,
"vcId": 7,
"vlanId": 9
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 2,
"portId": 4,
"sdpId": 3,
"vcId": 10,
"vlanId": 10
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 3,
"portId": 6,
"sdpId": 3,
"vcId": 9,
"vlanId": 2
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 8,
"portId": 10,
"sdpId": 3,
"vcId": 1,
"vlanId": 8
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 8,
"portId": 9,
"sdpId": 3,
"vcId": 6,
"vlanId": 5
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 7,
"portId": 10,
"sdpId": 10,
"vcId": 7,
"vlanId": 4
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 10,
"portId": 3,
"sdpId": 10,
"vcId": 10,
"vlanId": 4
}
],
"instructionType": "CLEAR_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 7,
"dscp": {
"uint8": 9
},
"ethernetType": "string",
"inPort": 7,
"ipProtocolType": 7,
"outerVlanId": 5,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 9,
"vlanId": 7
},
"priority": 1,
"tableId": 3
},
{
"applicationGroupId": 9,
"applicationId": 7,
"auditstate": "NOT_DONE",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "NO_ACTION",
"openflowInstruction": {
"actions": [
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 4,
"portId": 3,
"sdpId": 1,
"vcId": 3,
"vlanId": 8
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 2,
"portId": 1,
"sdpId": 7,
"vcId": 9,
"vlanId": 5
}
],
"instructionType": "WRITE_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 10,
"dscp": {
"uint8": 2
},
"ethernetType": "string",
"inPort": 6,
"ipProtocolType": 2,
"outerVlanId": 6,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 1,
"vlanId": 10
},
"priority": 7,
"tableId": 9
},
{
"applicationGroupId": 5,
"applicationId": 8,
"auditstate": "FAILURE",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "NO_ACTION",
"openflowInstruction": {
"actions": [
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 10,
"portId": 7,
"sdpId": 2,
"vcId": 1,
"vlanId": 1
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 6,
"portId": 1,
"sdpId": 2,
"vcId": 6,
"vlanId": 2
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 8,
"portId": 9,
"sdpId": 1,
"vcId": 9,
"vlanId": 2
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 7,
"portId": 9,
"sdpId": 4,
"vcId": 5,
"vlanId": 3
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 6,
"portId": 10,
"sdpId": 3,
"vcId": 1,
"vlanId": 5
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 1,
"portId": 9,
"sdpId": 3,
"vcId": 4,
"vlanId": 6
}
],
"instructionType": "WRITE_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 6,
"dscp": {
"uint8": 1
},
"ethernetType": "string",
"inPort": 2,
"ipProtocolType": 4,
"outerVlanId": 8,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 6,
"vlanId": 3
},
"priority": 2,
"tableId": 7
},
{
"applicationGroupId": 6,
"applicationId": 6,
"auditstate": "SUCCESS",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "PENDING_SYNC",
"openflowInstruction": {
"actions": [
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 3,
"portId": 2,
"sdpId": 2,
"vcId": 7,
"vlanId": 3
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 10,
"portId": 2,
"sdpId": 6,
"vcId": 10,
"vlanId": 9
}
],
"instructionType": "CLEAR_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 6,
"dscp": {
"uint8": 10
},
"ethernetType": "string",
"inPort": 10,
"ipProtocolType": 1,
"outerVlanId": 1,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 4,
"vlanId": 9
},
"priority": 7,
"tableId": 10
},
{
"applicationGroupId": 10,
"applicationId": 9,
"auditstate": "SUCCESS",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "PENDING_SYNC",
"openflowInstruction": {
"actions": [
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 10,
"portId": 1,
"sdpId": 2,
"vcId": 7,
"vlanId": 7
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 6,
"portId": 6,
"sdpId": 3,
"vcId": 6,
"vlanId": 6
}
],
"instructionType": "CLEAR_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 3,
"dscp": {
"uint8": 9
},
"ethernetType": "string",
"inPort": 2,
"ipProtocolType": 5,
"outerVlanId": 2,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 9,
"vlanId": 7
},
"priority": 4,
"tableId": 10
},
{
"applicationGroupId": 1,
"applicationId": 3,
"auditstate": "FAILURE",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "PENDING_SYNC",
"openflowInstruction": {
"actions": [
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 3,
"portId": 1,
"sdpId": 3,
"vcId": 4,
"vlanId": 10
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 2,
"portId": 7,
"sdpId": 6,
"vcId": 1,
"vlanId": 1
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 8,
"portId": 3,
"sdpId": 8,
"vcId": 3,
"vlanId": 1
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 9,
"portId": 5,
"sdpId": 1,
"vcId": 5,
"vlanId": 4
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 3,
"portId": 10,
"sdpId": 5,
"vcId": 9,
"vlanId": 7
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 6,
"portId": 3,
"sdpId": 5,
"vcId": 10,
"vlanId": 1
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 9,
"portId": 10,
"sdpId": 10,
"vcId": 9,
"vlanId": 9
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 3,
"portId": 6,
"sdpId": 8,
"vcId": 5,
"vlanId": 3
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 7,
"portId": 4,
"sdpId": 5,
"vcId": 9,
"vlanId": 1
}
],
"instructionType": "WRITE_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 5,
"dscp": {
"uint8": 10
},
"ethernetType": "string",
"inPort": 8,
"ipProtocolType": 8,
"outerVlanId": 3,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 3,
"vlanId": 10
},
"priority": 1,
"tableId": 2
},
{
"applicationGroupId": 10,
"applicationId": 7,
"auditstate": "SUCCESS",
"cookie": "string",
"datapathId": "string",
"flowId": "string",
"lifecycle": "NO_ACTION",
"openflowInstruction": {
"actions": [
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 3,
"portId": 9,
"sdpId": 7,
"vcId": 1,
"vlanId": 6
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 5,
"portId": 6,
"sdpId": 10,
"vcId": 10,
"vlanId": 2
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 2,
"portId": 4,
"sdpId": 10,
"vcId": 10,
"vlanId": 5
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 2,
"portId": 6,
"sdpId": 7,
"vcId": 5,
"vlanId": 1
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 4,
"portId": 9,
"sdpId": 3,
"vcId": 6,
"vlanId": 9
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 1,
"portId": 6,
"sdpId": 4,
"vcId": 10,
"vlanId": 2
},
{
"actionType": "SET_FIELD",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 1,
"portId": 1,
"sdpId": 7,
"vcId": 8,
"vlanId": 7
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_SVCT",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 3,
"portId": 3,
"sdpId": 3,
"vcId": 3,
"vlanId": 5
},
{
"actionType": "EXPERIMENTER",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": false,
"outerVlanId": 2,
"portId": 2,
"sdpId": 8,
"vcId": 10,
"vlanId": 2
},
{
"actionType": "OUT_PORT",
"experimenterActionType": "REDIRECT_TO_NEXTHOP",
"ipAddress": {},
"isIndirect": true,
"outerVlanId": 3,
"portId": 7,
"sdpId": 5,
"vcId": 6,
"vlanId": 1
}
],
"instructionType": "CLEAR_ACTIONS"
},
"openflowMatch": {
"destIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"destPort": 9,
"dscp": {
"uint8": 5
},
"ethernetType": "string",
"inPort": 6,
"ipProtocolType": 5,
"outerVlanId": 2,
"sourceIpAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
},
"sourcePort": 5,
"vlanId": 9
},
"priority": 3,
"tableId": 3
}
],
"endRow": 3,
"startRow": 4,
"status": 8,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/openflow/ports/{datapathId}": {
"get": {
"tags": [
"SdnOpenflow"
],
"operationId": "getPorts",
"description": "The parameters and request body are for method: getPorts. 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": "object",
"properties": {
"datapathId": {
"type": "string"
},
"hardwareAddress": {
"type": "string"
},
"portId": {
"type": "number"
},
"portName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"datapathId": "string",
"hardwareAddress": "string",
"portId": 7,
"portName": "string"
},
{
"datapathId": "string",
"hardwareAddress": "string",
"portId": 8,
"portName": "string"
},
{
"datapathId": "string",
"hardwareAddress": "string",
"portId": 2,
"portName": "string"
},
{
"datapathId": "string",
"hardwareAddress": "string",
"portId": 10,
"portName": "string"
},
{
"datapathId": "string",
"hardwareAddress": "string",
"portId": 2,
"portName": "string"
}
],
"endRow": 4,
"startRow": 9,
"status": 9,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "datapathId",
"in": "path",
"required": true,
"schema": {
"title": "datapathId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/openflow/switches": {
"get": {
"tags": [
"SdnOpenflow"
],
"operationId": "getSwitches",
"description": "The parameters and request body are for method: getSwitches. 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": "object",
"properties": {
"datapathId": {
"type": "string"
},
"dpDescription": {
"type": "string"
},
"hwDescription": {
"type": "string"
},
"maxTables": {
"type": "number"
},
"mfgDescription": {
"type": "string"
},
"numberOfBuffers": {
"type": "number"
},
"openflowVersion": {
"type": "string"
},
"serialNumber": {
"type": "string"
},
"status": {
"type": "string"
},
"swDescription": {
"type": "string"
},
"switchAddress": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"vendorType": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 3,
"mfgDescription": "string",
"numberOfBuffers": 6,
"openflowVersion": "V150",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 8,
"mfgDescription": "string",
"numberOfBuffers": 3,
"openflowVersion": "V200",
"serialNumber": "string",
"status": "DOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "NOKIA"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 4,
"mfgDescription": "string",
"numberOfBuffers": 4,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 10,
"mfgDescription": "string",
"numberOfBuffers": 2,
"openflowVersion": "V140",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 9,
"mfgDescription": "string",
"numberOfBuffers": 7,
"openflowVersion": "V131",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 2,
"mfgDescription": "string",
"numberOfBuffers": 8,
"openflowVersion": "V200",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "OTHER"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 8,
"mfgDescription": "string",
"numberOfBuffers": 5,
"openflowVersion": "V131",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 2,
"mfgDescription": "string",
"numberOfBuffers": 7,
"openflowVersion": "V130",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 5,
"mfgDescription": "string",
"numberOfBuffers": 4,
"openflowVersion": "V131",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 9,
"mfgDescription": "string",
"numberOfBuffers": 3,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "DOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "OTHER"
}
],
"endRow": 7,
"startRow": 1,
"status": 7,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/openflow/switches/{neId}": {
"get": {
"tags": [
"SdnOpenflow"
],
"operationId": "getSwitchesInRouter",
"description": "The parameters and request body are for method: getSwitchesInRouter. 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": "object",
"properties": {
"datapathId": {
"type": "string"
},
"dpDescription": {
"type": "string"
},
"hwDescription": {
"type": "string"
},
"maxTables": {
"type": "number"
},
"mfgDescription": {
"type": "string"
},
"numberOfBuffers": {
"type": "number"
},
"openflowVersion": {
"type": "string"
},
"serialNumber": {
"type": "string"
},
"status": {
"type": "string"
},
"swDescription": {
"type": "string"
},
"switchAddress": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"vendorType": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 1,
"mfgDescription": "string",
"numberOfBuffers": 4,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "NOKIA"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 1,
"mfgDescription": "string",
"numberOfBuffers": 2,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 8,
"mfgDescription": "string",
"numberOfBuffers": 5,
"openflowVersion": "V131",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 5,
"mfgDescription": "string",
"numberOfBuffers": 7,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "NOKIA"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 1,
"mfgDescription": "string",
"numberOfBuffers": 10,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "DOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "NOKIA"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 8,
"mfgDescription": "string",
"numberOfBuffers": 8,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "NOKIA"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 10,
"mfgDescription": "string",
"numberOfBuffers": 1,
"openflowVersion": "V131",
"serialNumber": "string",
"status": "DOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 3,
"mfgDescription": "string",
"numberOfBuffers": 10,
"openflowVersion": "V140",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 3,
"mfgDescription": "string",
"numberOfBuffers": 6,
"openflowVersion": "V10",
"serialNumber": "string",
"status": "ACTIVE",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "ALCATEL"
},
{
"datapathId": "string",
"dpDescription": "string",
"hwDescription": "string",
"maxTables": 8,
"mfgDescription": "string",
"numberOfBuffers": 1,
"openflowVersion": "V140",
"serialNumber": "string",
"status": "UNKNOWN",
"swDescription": "string",
"switchAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"vendorType": "OTHER"
}
],
"endRow": 10,
"startRow": 4,
"status": 9,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/openflow/tables/{datapathId}": {
"get": {
"tags": [
"SdnOpenflow"
],
"operationId": "getTables",
"description": "The parameters and request body are for method: getTables. 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": "object",
"properties": {
"datapathId": {
"type": "string"
},
"maxEntries": {
"type": "number"
},
"tableId": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"datapathId": "string",
"maxEntries": 5,
"tableId": 7
},
{
"datapathId": "string",
"maxEntries": 2,
"tableId": 2
},
{
"datapathId": "string",
"maxEntries": 8,
"tableId": 3
},
{
"datapathId": "string",
"maxEntries": 1,
"tableId": 10
}
],
"endRow": 6,
"startRow": 4,
"status": 6,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "datapathId",
"in": "path",
"required": true,
"schema": {
"title": "datapathId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/physicallinks": {
"get": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "getV4Physicallinks",
"description": "The parameters and request body are for method: getV4Physicallinks. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": true,
"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",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 7,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "PARTIALLY_DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string"
]
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 9,
"latency": 7
},
"lxcontainer": {
"lxinformationList": [
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"endRow": 8,
"startRow": 10,
"status": 3,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/physicallinks/{linkId}": {
"delete": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "delete",
"description": "The parameters and request body are for method: delete. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 2,
"status": 7,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/physicallinks/{srcId}/{destId}": {
"post": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "create",
"description": "The parameters and request body are for method: create. 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"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 1,
"latency": 10
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": true,
"name": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DOWN",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
"endRow": 2,
"startRow": 10,
"status": 1,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "srcId",
"in": "path",
"required": true,
"schema": {
"title": "srcId",
"type": "string"
}
},
{
"name": "destId",
"in": "path",
"required": true,
"schema": {
"title": "destId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/physicallinks/{uuid}": {
"get": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "getV4PhysicallinksUuid",
"description": "The parameters and request body are for method: getV4PhysicallinksUuid. 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"
},
"bidirectional": {
"type": "boolean"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"destinationId": {
"type": "string"
},
"destinationName": {
"type": "string"
},
"destinationPortId": {
"type": "string"
},
"destinationPortName": {
"type": "string"
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"linkCost": {
"type": "object",
"properties": {
"cost": {
"type": "number"
},
"latency": {
"type": "number"
}
}
},
"lxcontainer": {
"type": "object",
"properties": {
"lxinformationList": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"lxpresent": {
"type": "boolean"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceName": {
"type": "string"
},
"sourcePortId": {
"type": "string"
},
"sourcePortName": {
"type": "string"
},
"srlgs": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"bidirectional": true,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"destinationId": "string",
"destinationName": "string",
"destinationPortId": "string",
"destinationPortName": "string",
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"linkCost": {
"cost": 10,
"latency": 9
},
"lxcontainer": {
"lxinformationList": [
{},
{},
{},
{},
{},
{}
]
},
"lxpresent": false,
"name": "string",
"neDeploymentState": "NA",
"operationalState": "TRANSITION",
"sourceId": "string",
"sourceName": "string",
"sourcePortId": "string",
"sourcePortName": "string",
"srlgs": [
"string"
]
},
"endRow": 1,
"startRow": 2,
"status": 5,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/ip-optical-correlation-policiy": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getAllIpOpticalCorrelationPolicy",
"description": "The parameters and request body are for method: getAllIpOpticalCorrelationPolicy. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"latencyUploadPolicy": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"srlgUploadPolicy": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"latencyUploadPolicy": "manual",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "auto"
},
{
"appId": "string",
"id": "string",
"latencyUploadPolicy": "manual",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "auto"
},
{
"appId": "string",
"id": "string",
"latencyUploadPolicy": "manual",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "manual"
},
{
"appId": "string",
"id": "string",
"latencyUploadPolicy": "auto",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "auto"
},
{
"appId": "string",
"id": "string",
"latencyUploadPolicy": "auto",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "auto"
}
],
"endRow": 8,
"startRow": 5,
"status": 6,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/ip-optical-correlation-policy": {
"post": {
"tags": [
"SdnPolicy"
],
"operationId": "createIpOpticalCorrelationPolicy",
"description": "The parameters and request body are for method: createIpOpticalCorrelationPolicy. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"latencyUploadPolicy": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"srlgUploadPolicy": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"latencyUploadPolicy": "auto",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "auto"
},
"endRow": 3,
"startRow": 10,
"status": 5,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/policy/ip-optical-correlation-policy/{policyId}": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getIpOpticalCorrelationPolicy",
"description": "The parameters and request body are for method: getIpOpticalCorrelationPolicy. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"latencyUploadPolicy": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"srlgUploadPolicy": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"latencyUploadPolicy": "manual",
"name": "string",
"objectDescription": "string",
"srlgUploadPolicy": "auto"
},
"endRow": 1,
"startRow": 5,
"status": 10,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnPolicy"
],
"operationId": "updateIpOpticalCorrelationPolicy",
"description": "The parameters and request body are for method: updateIpOpticalCorrelationPolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 4,
"startRow": 10,
"status": 10,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnPolicy"
],
"operationId": "deleteIpOpticalCorrelationPolicy",
"description": "The parameters and request body are for method: deleteIpOpticalCorrelationPolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 4,
"startRow": 2,
"status": 1,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/rd-rt-ranges": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getAllRdRtRanges",
"description": "The parameters and request body are for method: getAllRdRtRanges. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"maxAssignedForRd": {
"type": "number"
},
"maxAssignedForRt": {
"type": "number"
},
"maxAssignedForRtExtranet": {
"type": "number"
},
"minAssignedForRd": {
"type": "number"
},
"minAssignedForRt": {
"type": "number"
},
"minAssignedForRtExtranet": {
"type": "number"
},
"name": {
"type": "string"
},
"networkASForRd": {
"type": "boolean"
},
"networkASForRt": {
"type": "boolean"
},
"networkASForRtExtranet": {
"type": "boolean"
},
"objectDescription": {
"type": "string"
},
"policyType": {
"type": "string"
},
"rdAS": {
"type": "number"
},
"rdType": {
"type": "number"
},
"rtAS": {
"type": "number"
},
"rtExtranetAS": {
"type": "number"
},
"rtExtranetType": {
"type": "number"
},
"rtType": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 6,
"maxAssignedForRt": 9,
"maxAssignedForRtExtranet": 3,
"minAssignedForRd": 6,
"minAssignedForRt": 1,
"minAssignedForRtExtranet": 8,
"name": "string",
"networkASForRd": true,
"networkASForRt": true,
"networkASForRtExtranet": true,
"objectDescription": "string",
"policyType": "RD_AND_RT",
"rdAS": 10,
"rdType": 2,
"rtAS": 8,
"rtExtranetAS": 4,
"rtExtranetType": 2,
"rtType": 6
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 1,
"maxAssignedForRt": 8,
"maxAssignedForRtExtranet": 5,
"minAssignedForRd": 9,
"minAssignedForRt": 2,
"minAssignedForRtExtranet": 1,
"name": "string",
"networkASForRd": false,
"networkASForRt": true,
"networkASForRtExtranet": false,
"objectDescription": "string",
"policyType": "RD_AND_RT",
"rdAS": 3,
"rdType": 10,
"rtAS": 3,
"rtExtranetAS": 9,
"rtExtranetType": 5,
"rtType": 8
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 2,
"maxAssignedForRt": 3,
"maxAssignedForRtExtranet": 2,
"minAssignedForRd": 1,
"minAssignedForRt": 3,
"minAssignedForRtExtranet": 7,
"name": "string",
"networkASForRd": false,
"networkASForRt": false,
"networkASForRtExtranet": false,
"objectDescription": "string",
"policyType": "RD_AND_RT",
"rdAS": 9,
"rdType": 3,
"rtAS": 8,
"rtExtranetAS": 4,
"rtExtranetType": 10,
"rtType": 8
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 8,
"maxAssignedForRt": 4,
"maxAssignedForRtExtranet": 8,
"minAssignedForRd": 6,
"minAssignedForRt": 2,
"minAssignedForRtExtranet": 10,
"name": "string",
"networkASForRd": false,
"networkASForRt": false,
"networkASForRtExtranet": true,
"objectDescription": "string",
"policyType": "RD_AND_RT",
"rdAS": 10,
"rdType": 10,
"rtAS": 1,
"rtExtranetAS": 5,
"rtExtranetType": 8,
"rtType": 6
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 10,
"maxAssignedForRt": 1,
"maxAssignedForRtExtranet": 10,
"minAssignedForRd": 2,
"minAssignedForRt": 10,
"minAssignedForRtExtranet": 10,
"name": "string",
"networkASForRd": true,
"networkASForRt": false,
"networkASForRtExtranet": false,
"objectDescription": "string",
"policyType": "RT_EXTRANET_ONLY",
"rdAS": 7,
"rdType": 7,
"rtAS": 5,
"rtExtranetAS": 5,
"rtExtranetType": 6,
"rtType": 3
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 1,
"maxAssignedForRt": 8,
"maxAssignedForRtExtranet": 8,
"minAssignedForRd": 5,
"minAssignedForRt": 8,
"minAssignedForRtExtranet": 3,
"name": "string",
"networkASForRd": false,
"networkASForRt": false,
"networkASForRtExtranet": true,
"objectDescription": "string",
"policyType": "RT_EXTRANET_ONLY",
"rdAS": 7,
"rdType": 7,
"rtAS": 7,
"rtExtranetAS": 7,
"rtExtranetType": 6,
"rtType": 9
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 7,
"maxAssignedForRt": 5,
"maxAssignedForRtExtranet": 7,
"minAssignedForRd": 2,
"minAssignedForRt": 8,
"minAssignedForRtExtranet": 8,
"name": "string",
"networkASForRd": true,
"networkASForRt": false,
"networkASForRtExtranet": false,
"objectDescription": "string",
"policyType": "RD_ONLY",
"rdAS": 7,
"rdType": 7,
"rtAS": 6,
"rtExtranetAS": 9,
"rtExtranetType": 7,
"rtType": 1
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 6,
"maxAssignedForRt": 7,
"maxAssignedForRtExtranet": 6,
"minAssignedForRd": 7,
"minAssignedForRt": 3,
"minAssignedForRtExtranet": 9,
"name": "string",
"networkASForRd": true,
"networkASForRt": false,
"networkASForRtExtranet": true,
"objectDescription": "string",
"policyType": "RT_EXTRANET_ONLY",
"rdAS": 1,
"rdType": 7,
"rtAS": 3,
"rtExtranetAS": 3,
"rtExtranetType": 8,
"rtType": 2
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 4,
"maxAssignedForRt": 9,
"maxAssignedForRtExtranet": 5,
"minAssignedForRd": 10,
"minAssignedForRt": 4,
"minAssignedForRtExtranet": 9,
"name": "string",
"networkASForRd": true,
"networkASForRt": true,
"networkASForRtExtranet": false,
"objectDescription": "string",
"policyType": "RD_ONLY",
"rdAS": 9,
"rdType": 3,
"rtAS": 10,
"rtExtranetAS": 3,
"rtExtranetType": 3,
"rtType": 3
},
{
"appId": "string",
"id": "string",
"maxAssignedForRd": 4,
"maxAssignedForRt": 8,
"maxAssignedForRtExtranet": 5,
"minAssignedForRd": 9,
"minAssignedForRt": 4,
"minAssignedForRtExtranet": 4,
"name": "string",
"networkASForRd": false,
"networkASForRt": false,
"networkASForRtExtranet": false,
"objectDescription": "string",
"policyType": "RT_ONLY",
"rdAS": 3,
"rdType": 5,
"rtAS": 10,
"rtExtranetAS": 6,
"rtExtranetType": 4,
"rtType": 6
}
],
"endRow": 9,
"startRow": 3,
"status": 4,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnPolicy"
],
"operationId": "createRdRtRanges",
"description": "The parameters and request body are for method: createRdRtRanges. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"maxAssignedForRd": {
"type": "number"
},
"maxAssignedForRt": {
"type": "number"
},
"maxAssignedForRtExtranet": {
"type": "number"
},
"minAssignedForRd": {
"type": "number"
},
"minAssignedForRt": {
"type": "number"
},
"minAssignedForRtExtranet": {
"type": "number"
},
"name": {
"type": "string"
},
"networkASForRd": {
"type": "boolean"
},
"networkASForRt": {
"type": "boolean"
},
"networkASForRtExtranet": {
"type": "boolean"
},
"objectDescription": {
"type": "string"
},
"policyType": {
"type": "string"
},
"rdAS": {
"type": "number"
},
"rdType": {
"type": "number"
},
"rtAS": {
"type": "number"
},
"rtExtranetAS": {
"type": "number"
},
"rtExtranetType": {
"type": "number"
},
"rtType": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"maxAssignedForRd": 5,
"maxAssignedForRt": 2,
"maxAssignedForRtExtranet": 5,
"minAssignedForRd": 2,
"minAssignedForRt": 8,
"minAssignedForRtExtranet": 10,
"name": "string",
"networkASForRd": true,
"networkASForRt": false,
"networkASForRtExtranet": true,
"objectDescription": "string",
"policyType": "RT_EXTRANET_ONLY",
"rdAS": 3,
"rdType": 7,
"rtAS": 4,
"rtExtranetAS": 10,
"rtExtranetType": 8,
"rtType": 10
},
"endRow": 7,
"startRow": 4,
"status": 2,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/policy/rd-rt-ranges/{policyId}": {
"put": {
"tags": [
"SdnPolicy"
],
"operationId": "updateRdRtRanges",
"description": "The parameters and request body are for method: updateRdRtRanges. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 5,
"startRow": 8,
"status": 10,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnPolicy"
],
"operationId": "deleteRdRtRanges",
"description": "The parameters and request body are for method: deleteRdRtRanges. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 8,
"startRow": 2,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/router-port-protection-group-policy": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getAllRouterPortProtectionGroupPolicy",
"description": "The parameters and request body are for method: getAllRouterPortProtectionGroupPolicy. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"reversionPolicy": {
"type": "object",
"properties": {
"reversionMode": {
"type": "string"
},
"waitToRevertTime": {
"type": "object",
"properties": {
"time": {
"type": "object"
}
}
}
}
},
"switchPolicy": {
"type": "object",
"properties": {
"waitToSwitchTime": {
"type": "object",
"properties": {
"time": {
"type": "object"
}
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"reversionPolicy": {
"reversionMode": "non_revertive",
"waitToRevertTime": {
"time": {}
}
},
"switchPolicy": {
"waitToSwitchTime": {
"time": {}
}
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"reversionPolicy": {
"reversionMode": "revertive",
"waitToRevertTime": {
"time": {}
}
},
"switchPolicy": {
"waitToSwitchTime": {
"time": {}
}
}
}
],
"endRow": 3,
"startRow": 8,
"status": 1,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnPolicy"
],
"operationId": "createRouterPortProtectionGroupPolicy",
"description": "The parameters and request body are for method: createRouterPortProtectionGroupPolicy. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"reversionPolicy": {
"type": "object",
"properties": {
"reversionMode": {
"type": "string"
},
"waitToRevertTime": {
"type": "object",
"properties": {
"time": {
"type": "object"
}
}
}
}
},
"switchPolicy": {
"type": "object",
"properties": {
"waitToSwitchTime": {
"type": "object",
"properties": {
"time": {
"type": "object"
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"reversionPolicy": {
"reversionMode": "non_revertive",
"waitToRevertTime": {
"time": {}
}
},
"switchPolicy": {
"waitToSwitchTime": {
"time": {}
}
}
},
"endRow": 4,
"startRow": 8,
"status": 5,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/policy/router-port-protection-group-policy/{policyId}": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getRouterPortProtectionGroupPolicy",
"description": "The parameters and request body are for method: getRouterPortProtectionGroupPolicy. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"reversionPolicy": {
"type": "object",
"properties": {
"reversionMode": {
"type": "string"
},
"waitToRevertTime": {
"type": "object",
"properties": {
"time": {
"type": "object"
}
}
}
}
},
"switchPolicy": {
"type": "object",
"properties": {
"waitToSwitchTime": {
"type": "object",
"properties": {
"time": {
"type": "object"
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"reversionPolicy": {
"reversionMode": "non_revertive",
"waitToRevertTime": {
"time": {}
}
},
"switchPolicy": {
"waitToSwitchTime": {
"time": {}
}
}
},
"endRow": 3,
"startRow": 8,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnPolicy"
],
"operationId": "updateRouterPortProtectionGroupPolicy",
"description": "The parameters and request body are for method: updateRouterPortProtectionGroupPolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 7,
"startRow": 4,
"status": 9,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnPolicy"
],
"operationId": "deleteRouterPortProtectionGroupPolicy",
"description": "The parameters and request body are for method: deleteRouterPortProtectionGroupPolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 10,
"startRow": 7,
"status": 10,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/steering-parameter": {
"post": {
"tags": [
"SdnPolicy"
],
"operationId": "createSteeringParameter",
"description": "The parameters and request body are for method: createSteeringParameter. 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": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"name": {
"string": "string"
}
},
"endRow": 1,
"startRow": 10,
"status": 6,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/policy/steering-parameter/{steeringParameterName}": {
"delete": {
"tags": [
"SdnPolicy"
],
"operationId": "deleteSteeringParameter",
"description": "The parameters and request body are for method: deleteSteeringParameter. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 4,
"startRow": 4,
"status": 5,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "steeringParameterName",
"in": "path",
"required": true,
"schema": {
"title": "steeringParameterName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/steering-parameters": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getSteeringParameters",
"description": "The parameters and request body are for method: getSteeringParameters. 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": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"endRow": 3,
"startRow": 6,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/tunnel-selections": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getAllTunnelSelections",
"description": "The parameters and request body are for method: getAllTunnelSelections. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"bgpPriority": {
"type": "number"
},
"canBookBwInCoreForEline": {
"type": "boolean"
},
"canCreateNewTunnel": {
"type": "boolean"
},
"canRebindTunnel": {
"type": "boolean"
},
"canResizeExistingTunnel": {
"type": "boolean"
},
"canUseExistingTunnel": {
"type": "boolean"
},
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"erpPriority": {
"type": "number"
},
"frrEnabled": {
"type": "boolean"
},
"grePriority": {
"type": "number"
},
"id": {
"type": "string"
},
"igpConnectivityRequiredDuringPathSelection": {
"type": "boolean"
},
"ldpPriority": {
"type": "number"
},
"looseRsvpPriority": {
"type": "number"
},
"looseSrTePriority": {
"type": "number"
},
"modifiable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"oduPriority": {
"type": "number"
},
"pccInitiatedLspEnabled": {
"type": "boolean"
},
"pccInitiatedRsvpPriority": {
"type": "number"
},
"pccInitiatedSrTePriority": {
"type": "number"
},
"protection": {
"type": "boolean"
},
"protectionType": {
"type": "string"
},
"shouldAvoidOperStateDown": {
"type": "boolean"
},
"srIsisPriority": {
"type": "number"
},
"srOspfPriority": {
"type": "number"
},
"steeringParametersExcluded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"steeringParametersIncluded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"strictRsvpPriority": {
"type": "number"
},
"strictSrTePriority": {
"type": "number"
},
"targetIpAddressInfoList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"associatedTunnelType": {
"type": "string"
},
"primaryAddress": {
"type": "object",
"properties": {
"ipv4Prefix": {
"type": "object"
},
"ipv6Prefix": {
"type": "object"
}
}
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"bgpPriority": 2,
"canBookBwInCoreForEline": true,
"canCreateNewTunnel": false,
"canRebindTunnel": true,
"canResizeExistingTunnel": true,
"canUseExistingTunnel": false,
"consumable": true,
"deletable": false,
"erpPriority": 5,
"frrEnabled": false,
"grePriority": 7,
"id": "string",
"igpConnectivityRequiredDuringPathSelection": false,
"ldpPriority": 4,
"looseRsvpPriority": 4,
"looseSrTePriority": 2,
"modifiable": false,
"name": "string",
"objectDescription": "string",
"oduPriority": 3,
"pccInitiatedLspEnabled": true,
"pccInitiatedRsvpPriority": 4,
"pccInitiatedSrTePriority": 3,
"protection": false,
"protectionType": "STANDBY",
"shouldAvoidOperStateDown": false,
"srIsisPriority": 5,
"srOspfPriority": 4,
"steeringParametersExcluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"steeringParametersIncluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"strictRsvpPriority": 8,
"strictSrTePriority": 4,
"targetIpAddressInfoList": [
{
"associatedTunnelType": "sr_te_loose",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_te_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "bgp",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_te_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "rsvp_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
}
]
},
{
"appId": "string",
"bgpPriority": 2,
"canBookBwInCoreForEline": false,
"canCreateNewTunnel": false,
"canRebindTunnel": true,
"canResizeExistingTunnel": true,
"canUseExistingTunnel": false,
"consumable": false,
"deletable": false,
"erpPriority": 8,
"frrEnabled": false,
"grePriority": 1,
"id": "string",
"igpConnectivityRequiredDuringPathSelection": false,
"ldpPriority": 8,
"looseRsvpPriority": 7,
"looseSrTePriority": 7,
"modifiable": true,
"name": "string",
"objectDescription": "string",
"oduPriority": 8,
"pccInitiatedLspEnabled": false,
"pccInitiatedRsvpPriority": 6,
"pccInitiatedSrTePriority": 8,
"protection": false,
"protectionType": "UNKNOWN",
"shouldAvoidOperStateDown": false,
"srIsisPriority": 10,
"srOspfPriority": 7,
"steeringParametersExcluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"steeringParametersIncluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"strictRsvpPriority": 7,
"strictSrTePriority": 5,
"targetIpAddressInfoList": [
{
"associatedTunnelType": "sr_te_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_isis",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_te_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_isis",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "rsvp_loose",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_ospf",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
}
]
},
{
"appId": "string",
"bgpPriority": 3,
"canBookBwInCoreForEline": true,
"canCreateNewTunnel": false,
"canRebindTunnel": false,
"canResizeExistingTunnel": false,
"canUseExistingTunnel": true,
"consumable": false,
"deletable": true,
"erpPriority": 2,
"frrEnabled": false,
"grePriority": 4,
"id": "string",
"igpConnectivityRequiredDuringPathSelection": true,
"ldpPriority": 1,
"looseRsvpPriority": 8,
"looseSrTePriority": 6,
"modifiable": true,
"name": "string",
"objectDescription": "string",
"oduPriority": 3,
"pccInitiatedLspEnabled": false,
"pccInitiatedRsvpPriority": 7,
"pccInitiatedSrTePriority": 6,
"protection": false,
"protectionType": "PRIMARY",
"shouldAvoidOperStateDown": false,
"srIsisPriority": 6,
"srOspfPriority": 9,
"steeringParametersExcluded": [
{
"name": {
"string": "string"
}
}
],
"steeringParametersIncluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"strictRsvpPriority": 1,
"strictSrTePriority": 5,
"targetIpAddressInfoList": [
{
"associatedTunnelType": "gre",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_te_loose",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "rsvp_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
}
]
},
{
"appId": "string",
"bgpPriority": 7,
"canBookBwInCoreForEline": false,
"canCreateNewTunnel": true,
"canRebindTunnel": true,
"canResizeExistingTunnel": true,
"canUseExistingTunnel": false,
"consumable": true,
"deletable": false,
"erpPriority": 10,
"frrEnabled": false,
"grePriority": 3,
"id": "string",
"igpConnectivityRequiredDuringPathSelection": false,
"ldpPriority": 7,
"looseRsvpPriority": 6,
"looseSrTePriority": 1,
"modifiable": true,
"name": "string",
"objectDescription": "string",
"oduPriority": 5,
"pccInitiatedLspEnabled": false,
"pccInitiatedRsvpPriority": 1,
"pccInitiatedSrTePriority": 7,
"protection": true,
"protectionType": "STANDBY",
"shouldAvoidOperStateDown": false,
"srIsisPriority": 1,
"srOspfPriority": 10,
"steeringParametersExcluded": [
{
"name": {
"string": "string"
}
}
],
"steeringParametersIncluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"strictRsvpPriority": 1,
"strictSrTePriority": 4,
"targetIpAddressInfoList": [
{
"associatedTunnelType": "bgp",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
}
]
}
],
"endRow": 8,
"startRow": 9,
"status": 8,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnPolicy"
],
"operationId": "createTunnelSelections",
"description": "The parameters and request body are for method: createTunnelSelections. 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": {
"appId": {
"type": "string"
},
"bgpPriority": {
"type": "number"
},
"canBookBwInCoreForEline": {
"type": "boolean"
},
"canCreateNewTunnel": {
"type": "boolean"
},
"canRebindTunnel": {
"type": "boolean"
},
"canResizeExistingTunnel": {
"type": "boolean"
},
"canUseExistingTunnel": {
"type": "boolean"
},
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"erpPriority": {
"type": "number"
},
"frrEnabled": {
"type": "boolean"
},
"grePriority": {
"type": "number"
},
"id": {
"type": "string"
},
"igpConnectivityRequiredDuringPathSelection": {
"type": "boolean"
},
"ldpPriority": {
"type": "number"
},
"looseRsvpPriority": {
"type": "number"
},
"looseSrTePriority": {
"type": "number"
},
"modifiable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"oduPriority": {
"type": "number"
},
"pccInitiatedLspEnabled": {
"type": "boolean"
},
"pccInitiatedRsvpPriority": {
"type": "number"
},
"pccInitiatedSrTePriority": {
"type": "number"
},
"protection": {
"type": "boolean"
},
"protectionType": {
"type": "string"
},
"shouldAvoidOperStateDown": {
"type": "boolean"
},
"srIsisPriority": {
"type": "number"
},
"srOspfPriority": {
"type": "number"
},
"steeringParametersExcluded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"steeringParametersIncluded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"strictRsvpPriority": {
"type": "number"
},
"strictSrTePriority": {
"type": "number"
},
"targetIpAddressInfoList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"associatedTunnelType": {
"type": "string"
},
"primaryAddress": {
"type": "object",
"properties": {
"ipv4Prefix": {
"type": "object"
},
"ipv6Prefix": {
"type": "object"
}
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bgpPriority": 8,
"canBookBwInCoreForEline": true,
"canCreateNewTunnel": false,
"canRebindTunnel": false,
"canResizeExistingTunnel": true,
"canUseExistingTunnel": true,
"consumable": false,
"deletable": true,
"erpPriority": 4,
"frrEnabled": true,
"grePriority": 5,
"id": "string",
"igpConnectivityRequiredDuringPathSelection": false,
"ldpPriority": 9,
"looseRsvpPriority": 1,
"looseSrTePriority": 5,
"modifiable": false,
"name": "string",
"objectDescription": "string",
"oduPriority": 10,
"pccInitiatedLspEnabled": false,
"pccInitiatedRsvpPriority": 10,
"pccInitiatedSrTePriority": 5,
"protection": true,
"protectionType": "SECONDARY",
"shouldAvoidOperStateDown": false,
"srIsisPriority": 5,
"srOspfPriority": 5,
"steeringParametersExcluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"steeringParametersIncluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"strictRsvpPriority": 6,
"strictSrTePriority": 3,
"targetIpAddressInfoList": [
{
"associatedTunnelType": "sr_isis",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_isis",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_pcc_initiated",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "gre",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "gre",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "bgp",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "pcc_initiated",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "bgp",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "gre",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "sr_te_loose",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
}
]
},
"endRow": 2,
"startRow": 10,
"status": 3,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/policy/tunnel-selections/{policyId}": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getTunnelSelections",
"description": "The parameters and request body are for method: getTunnelSelections. 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": {
"appId": {
"type": "string"
},
"bgpPriority": {
"type": "number"
},
"canBookBwInCoreForEline": {
"type": "boolean"
},
"canCreateNewTunnel": {
"type": "boolean"
},
"canRebindTunnel": {
"type": "boolean"
},
"canResizeExistingTunnel": {
"type": "boolean"
},
"canUseExistingTunnel": {
"type": "boolean"
},
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"erpPriority": {
"type": "number"
},
"frrEnabled": {
"type": "boolean"
},
"grePriority": {
"type": "number"
},
"id": {
"type": "string"
},
"igpConnectivityRequiredDuringPathSelection": {
"type": "boolean"
},
"ldpPriority": {
"type": "number"
},
"looseRsvpPriority": {
"type": "number"
},
"looseSrTePriority": {
"type": "number"
},
"modifiable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"oduPriority": {
"type": "number"
},
"pccInitiatedLspEnabled": {
"type": "boolean"
},
"pccInitiatedRsvpPriority": {
"type": "number"
},
"pccInitiatedSrTePriority": {
"type": "number"
},
"protection": {
"type": "boolean"
},
"protectionType": {
"type": "string"
},
"shouldAvoidOperStateDown": {
"type": "boolean"
},
"srIsisPriority": {
"type": "number"
},
"srOspfPriority": {
"type": "number"
},
"steeringParametersExcluded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"steeringParametersIncluded": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"strictRsvpPriority": {
"type": "number"
},
"strictSrTePriority": {
"type": "number"
},
"targetIpAddressInfoList": {
"type": "array",
"items": {
"type": "object",
"properties": {
"associatedTunnelType": {
"type": "string"
},
"primaryAddress": {
"type": "object",
"properties": {
"ipv4Prefix": {
"type": "object"
},
"ipv6Prefix": {
"type": "object"
}
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bgpPriority": 8,
"canBookBwInCoreForEline": true,
"canCreateNewTunnel": false,
"canRebindTunnel": false,
"canResizeExistingTunnel": true,
"canUseExistingTunnel": true,
"consumable": true,
"deletable": false,
"erpPriority": 2,
"frrEnabled": true,
"grePriority": 2,
"id": "string",
"igpConnectivityRequiredDuringPathSelection": true,
"ldpPriority": 5,
"looseRsvpPriority": 8,
"looseSrTePriority": 3,
"modifiable": false,
"name": "string",
"objectDescription": "string",
"oduPriority": 6,
"pccInitiatedLspEnabled": true,
"pccInitiatedRsvpPriority": 3,
"pccInitiatedSrTePriority": 10,
"protection": true,
"protectionType": "PRIMARY",
"shouldAvoidOperStateDown": true,
"srIsisPriority": 4,
"srOspfPriority": 1,
"steeringParametersExcluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"steeringParametersIncluded": [
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
},
{
"name": {
"string": "string"
}
}
],
"strictRsvpPriority": 6,
"strictSrTePriority": 2,
"targetIpAddressInfoList": [
{
"associatedTunnelType": "gre",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "ldp",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
},
{
"associatedTunnelType": "rsvp_strict",
"primaryAddress": {
"ipv4Prefix": {},
"ipv6Prefix": {}
}
}
]
},
"endRow": 2,
"startRow": 7,
"status": 6,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnPolicy"
],
"operationId": "updateTunnelSelections",
"description": "The parameters and request body are for method: updateTunnelSelections. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 6,
"startRow": 9,
"status": 2,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnPolicy"
],
"operationId": "deleteTunnelSelections",
"description": "The parameters and request body are for method: deleteTunnelSelections. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 7,
"startRow": 10,
"status": 2,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getV4Ports",
"description": "The parameters and request body are for method: getV4Ports. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 7,
"availableIngressBandwidth": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "HYBRID"
},
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": true,
"l2dci": true,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 6,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 4,
"availableIngressBandwidth": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 8,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UP",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": true,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": true,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 1,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 6,
"availableIngressBandwidth": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "QinQ",
"lag": {},
"lldpConfiguration": [
{},
{},
{}
],
"lldpRemotePeers": [
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 10,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": true,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": true,
"opsa": true,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 5,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 7,
"availableIngressBandwidth": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 5,
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": true,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": true,
"l2dci": true,
"l3dci": true,
"l3vpn": true,
"lag": true,
"och": true,
"odu": false,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 9,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 5,
"availableIngressBandwidth": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"interfaceId": 8,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": false,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": true,
"odu": true,
"opsa": true,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 8,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
}
],
"endRow": 2,
"startRow": 2,
"status": 3,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/ne-all-by-tenant/{neId}/tenant/{tenantUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getNeAllByTenant",
"description": "The parameters and request body are for method: getNeAllByTenant. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 1,
"availableIngressBandwidth": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"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",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 1,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": false,
"odu": false,
"opsa": false,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 9,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 7,
"availableIngressBandwidth": 3,
"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",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{}
],
"portMode": "HYBRID"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UP",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": false,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 3,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
}
],
"endRow": 8,
"startRow": 9,
"status": 10,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
},
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/ne-all/{neId}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getNeAll",
"description": "The parameters and request body are for method: getNeAll. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 2,
"availableIngressBandwidth": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"interfaceId": 9,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": false,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": true,
"odu": false,
"opsa": true,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 5,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 5,
"availableIngressBandwidth": 2,
"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",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 1,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": true,
"l3dci": true,
"l3vpn": true,
"lag": true,
"och": true,
"odu": false,
"opsa": true,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 6,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 7,
"availableIngressBandwidth": 9,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 6,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": false,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": true,
"opsa": false,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 2,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 3,
"availableIngressBandwidth": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": false,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": true,
"l3vpn": false,
"lag": true,
"och": false,
"odu": true,
"opsa": true,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 3,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 5,
"availableIngressBandwidth": 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",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"interfaceId": 3,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": false,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": true,
"l3dci": false,
"l3vpn": false,
"lag": true,
"och": false,
"odu": false,
"opsa": true,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 5,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 2,
"availableIngressBandwidth": 8,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 10,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": false,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": true,
"och": true,
"odu": false,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": true,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 4,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 8,
"availableIngressBandwidth": 7,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 3,
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UP",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": true,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": true,
"l3dci": true,
"l3vpn": false,
"lag": true,
"och": false,
"odu": false,
"opsa": true,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 10,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
}
],
"endRow": 6,
"startRow": 7,
"status": 9,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/ne-by-tenant/{neId}/servicetype/{serviceType}/tenant/{tenantUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getNeByTenant",
"description": "The parameters and request body are for method: getNeByTenant. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 9,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "QinQ",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 8,
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": true,
"l3dci": false,
"l3vpn": false,
"lag": false,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 8,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 4,
"availableIngressBandwidth": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "QinQ",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 7,
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": false,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": true,
"och": true,
"odu": true,
"opsa": true,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 2,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 10,
"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",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": true,
"opsa": false,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 3,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 1,
"availableIngressBandwidth": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 3,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": false,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": false,
"opsa": true,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 4,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 5,
"availableIngressBandwidth": 3,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": true,
"l3dci": true,
"l3vpn": true,
"lag": true,
"och": true,
"odu": true,
"opsa": false,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 9,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 4,
"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",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 1,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": false,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": true,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": true,
"opsa": true,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 9,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 4,
"availableIngressBandwidth": 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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": true,
"l2dci": true,
"l3dci": true,
"l3vpn": true,
"lag": true,
"och": false,
"odu": false,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 1,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 4,
"availableIngressBandwidth": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{}
]
},
"description": "string",
"ethernet": {
"encapType": "QinQ",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": true,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": true,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": true,
"odu": true,
"opsa": false,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 1,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 8,
"availableIngressBandwidth": 9,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"interfaceId": 9,
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": false,
"och": false,
"odu": true,
"opsa": true,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 5,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 7,
"availableIngressBandwidth": 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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 1,
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": false,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": true,
"l3dci": true,
"l3vpn": true,
"lag": true,
"och": false,
"odu": false,
"opsa": false,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 2,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
}
],
"endRow": 6,
"startRow": 8,
"status": 1,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
},
{
"name": "serviceType",
"in": "path",
"required": true,
"schema": {
"title": "serviceType",
"type": "string"
}
},
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/ne/{neUuid}/servicetype/{serviceType}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getNe",
"description": "The parameters and request body are for method: getNe. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 10,
"availableIngressBandwidth": 2,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "HYBRID"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": true,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": false,
"och": false,
"odu": false,
"opsa": false,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 7,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 9,
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": true,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": true,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 7,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
}
],
"endRow": 7,
"startRow": 2,
"status": 1,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "neUuid",
"in": "path",
"required": true,
"schema": {
"title": "neUuid",
"type": "string"
}
},
{
"name": "serviceType",
"in": "path",
"required": true,
"schema": {
"title": "serviceType",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/service-count-on-port/{portUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getServiceCountOnPort",
"description": "The parameters and request body are for method: getServiceCountOnPort. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "number"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": 6,
"endRow": 7,
"startRow": 9,
"status": 6,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "portUuid",
"in": "path",
"required": true,
"schema": {
"title": "portUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/services-on-port/{portUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getServicesOnPort",
"description": "The parameters and request body are for method: getServicesOnPort. 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": "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": "DOWN",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"bw": 10,
"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": 7,
"description": "string",
"endpointExtensions": [
{
"connectedInner": 8,
"connectedOuter": 2,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 7,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 5,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 4,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 5,
"connectedOuter": 9,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 8,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 10,
"connectedOuter": 4,
"connectedPortId": "string",
"customAttributes": [
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 1,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 6,
"connectedOuter": 8,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
},
{
"connectedInner": 2,
"connectedOuter": 6,
"connectedPortId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"nniPort": {},
"uniPort": {}
}
],
"endpoints": [
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "UP",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 8,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "PARTIALLY_DOWN",
"portSpeed": 9,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "UP",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "UP",
"portId": "string",
"portName": "string",
"portOperationalState": "DOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "DOWN",
"appId": "string",
"customAttributes": [
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "UNKNOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 1,
"serviceId": "string"
},
{
"actualEndState": "Deployed",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"operationalState": "TRANSITION",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UNKNOWN",
"portSpeed": 3,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "DEPLOYED",
"neId": "string",
"neName": "string",
"operationalState": "PARTIALLY_DOWN",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 6,
"serviceId": "string"
},
{
"actualEndState": "Saved",
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"customAttributesTemplateId": "string",
"description": "string",
"externalIds": [
{},
{},
{}
],
"id": "string",
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"operationalState": "DEGRADED",
"portAdminState": "DOWN",
"portId": "string",
"portName": "string",
"portOperationalState": "UP",
"portSpeed": 7,
"serviceId": "string"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"groupId": "string",
"id": "string",
"lifeCycle": {
"phase": "Creation",
"reason": "string",
"state": "WaitingForDeployment"
},
"maxCost": 8,
"maxHops": 5,
"maxLatency": 1,
"name": "string",
"neDeploymentState": "PENDING",
"nodeServiceId": 5,
"objective": "HOPS",
"operationalState": "DOWN",
"pathProfileId": "string",
"requestedEndState": "Saved",
"reverseBW": 5,
"serviceType": "L2_EXTENSION_UNI",
"templateId": "string",
"tunnelSelectionId": "string"
}
],
"endRow": 8,
"startRow": 10,
"status": 3,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "portUuid",
"in": "path",
"required": true,
"schema": {
"title": "portUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/servicetype/{serviceType}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getServicetype",
"description": "The parameters and request body are for method: getServicetype. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 5,
"name": "string",
"neDeploymentState": "PENDING",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UP",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 10,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 10,
"availableIngressBandwidth": 1,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "QinQ",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 2,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": true,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": true,
"och": false,
"odu": false,
"opsa": true,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": true,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 1,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 8,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"interfaceId": 6,
"name": "string",
"neDeploymentState": "FAILED",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": true,
"l3dci": true,
"l3vpn": true,
"lag": false,
"och": true,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 1,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
}
],
"endRow": 1,
"startRow": 4,
"status": 8,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceType",
"in": "path",
"required": true,
"schema": {
"title": "serviceType",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/servicetype/{serviceType}/tenant/{tenantUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getServicetypeByTenant",
"description": "The parameters and request body are for method: getServicetypeByTenant. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 5,
"availableIngressBandwidth": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 9,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": false,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": true,
"l3dci": false,
"l3vpn": true,
"lag": false,
"och": false,
"odu": true,
"opsa": true,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 2,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 8,
"availableIngressBandwidth": 10,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{}
],
"portMode": "NETWORK"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 10,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": false,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": true,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": true,
"odu": false,
"opsa": true,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": true,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 7,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 9,
"availableIngressBandwidth": 5,
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{}
],
"portMode": "HYBRID"
},
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 2,
"name": "string",
"neDeploymentState": "NA",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "PARTIALLY_DOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": true,
"eline": true,
"ies": true,
"l2ExtensionNni": true,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 2,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 2,
"availableIngressBandwidth": 2,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Dot1Q",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 1,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": true,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": false,
"och": true,
"odu": false,
"opsa": true,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": true,
"vctypeSatopT1": true,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 10,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
}
],
"endRow": 3,
"startRow": 1,
"status": 6,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "serviceType",
"in": "path",
"required": true,
"schema": {
"title": "serviceType",
"type": "string"
}
},
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/tenant/{tenantUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getTenant",
"description": "The parameters and request body are for method: getTenant. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 2,
"availableIngressBandwidth": 6,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "QinQ",
"lag": {},
"lldpConfiguration": [
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 4,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": false,
"ies": false,
"l2ExtensionNni": true,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": false,
"l3dci": true,
"l3vpn": false,
"lag": false,
"och": true,
"odu": true,
"opsa": false,
"opsb": true,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": true,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": true
},
"portSpeed": 4,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"availableEgressBandwidth": 10,
"availableIngressBandwidth": 10,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{}
],
"portMode": "HYBRID"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "UNKNOWN",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": true,
"l2backhaul": false,
"l2dci": true,
"l3dci": false,
"l3vpn": true,
"lag": false,
"och": true,
"odu": true,
"opsa": true,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": true
},
"portSpeed": 2,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
{
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 1,
"availableIngressBandwidth": 5,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "ACCESS"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 10,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": true,
"elan": false,
"eline": true,
"ies": false,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": false,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": false,
"vctypeCesopsn": false,
"vctypeCesopsnCas": true,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 4,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
}
],
"endRow": 10,
"startRow": 5,
"status": 5,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/ports/{id}": {
"put": {
"tags": [
"SdnPorts"
],
"operationId": "putV4PortsId",
"description": "The parameters and request body are for method: putV4PortsId. 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"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"availableEgressBandwidth": 8,
"availableIngressBandwidth": 4,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Null",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "DEGRADED",
"optics": {
"protectionType": "protection"
},
"portCapability": {
"cline": false,
"elan": true,
"eline": true,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": false,
"l2dci": false,
"l3dci": false,
"l3vpn": true,
"lag": true,
"och": false,
"odu": false,
"opsa": true,
"opsb": true,
"physicalLink": true,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": false,
"vctypeSatopT3": false,
"ycable": false
},
"portSpeed": 1,
"portType": "string",
"role": "UNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"signalMode": "SIGNAL_MODE_CAS"
}
},
"endRow": 10,
"startRow": 1,
"status": 1,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/ports/{portUuid}": {
"get": {
"tags": [
"SdnPorts"
],
"operationId": "getV4PortsPortUuid",
"description": "The parameters and request body are for method: getV4PortsPortUuid. 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"
},
"availableEgressBandwidth": {
"type": "number"
},
"availableIngressBandwidth": {
"type": "number"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"customAttributesTemplateId": {
"type": "string"
},
"dc": {
"type": "object",
"properties": {
"l3DomainTemplates": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"description": {
"type": "string"
},
"ethernet": {
"type": "object",
"properties": {
"encapType": {
"type": "string"
},
"lag": {
"type": "object"
},
"lldpConfiguration": {
"type": "array",
"items": {
"type": "object"
}
},
"lldpRemotePeers": {
"type": "array",
"items": {
"type": "object"
}
},
"portMode": {
"type": "string"
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"interfaceId": {
"type": "number"
},
"name": {
"type": "string"
},
"neDeploymentState": {
"type": "string"
},
"neId": {
"type": "string"
},
"neName": {
"type": "string"
},
"nspDbFdn": {
"type": "string"
},
"operationalState": {
"type": "string"
},
"optics": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
}
}
},
"portCapability": {
"type": "object",
"properties": {
"cline": {
"type": "boolean"
},
"elan": {
"type": "boolean"
},
"eline": {
"type": "boolean"
},
"ies": {
"type": "boolean"
},
"l2ExtensionNni": {
"type": "boolean"
},
"l2ExtensionUni": {
"type": "boolean"
},
"l2backhaul": {
"type": "boolean"
},
"l2dci": {
"type": "boolean"
},
"l3dci": {
"type": "boolean"
},
"l3vpn": {
"type": "boolean"
},
"lag": {
"type": "boolean"
},
"och": {
"type": "boolean"
},
"odu": {
"type": "boolean"
},
"opsa": {
"type": "boolean"
},
"opsb": {
"type": "boolean"
},
"physicalLink": {
"type": "boolean"
},
"vctypeCesopsn": {
"type": "boolean"
},
"vctypeCesopsnCas": {
"type": "boolean"
},
"vctypeSatopE1": {
"type": "boolean"
},
"vctypeSatopT1": {
"type": "boolean"
},
"vctypeSatopT3": {
"type": "boolean"
},
"ycable": {
"type": "boolean"
}
}
},
"portSpeed": {
"type": "number"
},
"portType": {
"type": "string"
},
"role": {
"type": "string"
},
"tdm": {
"type": "object",
"properties": {
"channelFraming": {
"type": "string"
},
"ds0ChannelGroups": {
"type": "array",
"items": {
"type": "object"
}
},
"signalMode": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "UP",
"appId": "string",
"availableEgressBandwidth": 5,
"availableIngressBandwidth": 7,
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"dc": {
"l3DomainTemplates": [
{},
{},
{},
{},
{},
{}
]
},
"description": "string",
"ethernet": {
"encapType": "Unknown",
"lag": {},
"lldpConfiguration": [
{},
{},
{},
{},
{},
{},
{}
],
"lldpRemotePeers": [
{},
{},
{},
{},
{},
{},
{},
{},
{}
],
"portMode": "UNDEFINED"
},
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"interfaceId": 5,
"name": "string",
"neDeploymentState": "UNKNOWN",
"neId": "string",
"neName": "string",
"nspDbFdn": "string",
"operationalState": "TRANSITION",
"optics": {
"protectionType": "working"
},
"portCapability": {
"cline": false,
"elan": false,
"eline": false,
"ies": true,
"l2ExtensionNni": false,
"l2ExtensionUni": false,
"l2backhaul": true,
"l2dci": false,
"l3dci": false,
"l3vpn": false,
"lag": true,
"och": false,
"odu": true,
"opsa": false,
"opsb": false,
"physicalLink": true,
"vctypeCesopsn": true,
"vctypeCesopsnCas": false,
"vctypeSatopE1": false,
"vctypeSatopT1": true,
"vctypeSatopT3": true,
"ycable": false
},
"portSpeed": 6,
"portType": "string",
"role": "NNI",
"tdm": {
"channelFraming": "string",
"ds0ChannelGroups": [
{},
{}
],
"signalMode": "SIGNAL_MODE_NONE"
}
},
"endRow": 6,
"startRow": 2,
"status": 9,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "portUuid",
"in": "path",
"required": true,
"schema": {
"title": "portUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/security/authentication": {
"get": {
"tags": [
"SdnSecurity"
],
"operationId": "getAuthentication",
"description": "The parameters and request body are for method: getAuthentication. 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": {
"expires": {
"type": "number"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"tenant": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"contactName": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"tenantName": {
"type": "string"
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"expires": 6,
"roles": [
"OPERATOR",
"ADMIN",
"OPERATOR",
"OPERATOR",
"ADMIN",
"OPERATOR",
"ADMIN",
"OPERATOR"
],
"tenant": {
"address": "string",
"contactName": "string",
"customerId": 2,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
"user": {
"id": "string",
"name": "string"
}
},
"endRow": 6,
"startRow": 5,
"status": 5,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/servicedebug/constraint-test/{serviceUuid}": {
"post": {
"tags": [
"SdnServiceDebug"
],
"operationId": "createConstraintTest",
"description": "The parameters and request body are for method: createConstraintTest. 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": {
"fileName": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"fileName": "string",
"success": true
},
"endRow": 5,
"startRow": 6,
"status": 6,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/servicedebug/dci-recompute/{serviceUuid}": {
"post": {
"tags": [
"SdnServiceDebug"
],
"operationId": "createDciRecompute",
"description": "The parameters and request body are for method: createDciRecompute. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 9,
"startRow": 2,
"status": 8,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/system/isMaster": {
"get": {
"tags": [
"SdnSystem"
],
"operationId": "isMaster",
"description": "The parameters and request body are for method: isMaster. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 4,
"startRow": 8,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/system/plugin-connect/{pluginName}/{pluginVId}/{pluginKey}": {
"put": {
"tags": [
"SdnSystem"
],
"operationId": "setPluginConnect",
"description": "The parameters and request body are for method: setPluginConnect. 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": 1,
"startRow": 8,
"status": 4,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "pluginName",
"in": "path",
"required": true,
"schema": {
"title": "pluginName",
"type": "string"
}
},
{
"name": "pluginVId",
"in": "path",
"required": true,
"schema": {
"title": "pluginVId",
"type": "number"
}
},
{
"name": "pluginKey",
"in": "path",
"required": true,
"schema": {
"title": "pluginKey",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/system/resync-nms": {
"get": {
"tags": [
"SdnSystem"
],
"operationId": "resyncNms",
"description": "The parameters and request body are for method: resyncNms. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 3,
"startRow": 7,
"status": 6,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/system/resync-object/{uuid}": {
"get": {
"tags": [
"SdnSystem"
],
"operationId": "resyncObject",
"description": "The parameters and request body are for method: resyncObject. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 4,
"startRow": 8,
"status": 10,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"title": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/system/state": {
"get": {
"tags": [
"SdnSystem"
],
"operationId": "getState",
"description": "The parameters and request body are for method: getState. 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": 10,
"startRow": 7,
"status": 9,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/system/version": {
"get": {
"tags": [
"SdnSystem"
],
"operationId": "getVersion",
"description": "The parameters and request body are for method: getVersion. 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": "INIT",
"endRow": 4,
"startRow": 8,
"status": 9,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/cline-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllClineServices",
"description": "The parameters and request body are for method: getAllClineServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"cemUseRtpHeader": {
"type": "boolean"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"cemUseRtpHeader": true,
"customerId": 10,
"id": "string",
"maxCost": 9,
"maxHops": 10,
"maxLatency": 5,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"cemUseRtpHeader": true,
"customerId": 9,
"id": "string",
"maxCost": 8,
"maxHops": 3,
"maxLatency": 9,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 5,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"cemUseRtpHeader": false,
"customerId": 8,
"id": "string",
"maxCost": 8,
"maxHops": 3,
"maxLatency": 1,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 8,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET_TAGGED_MODE",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"cemUseRtpHeader": false,
"customerId": 6,
"id": "string",
"maxCost": 10,
"maxHops": 3,
"maxLatency": 7,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 10,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T3",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"cemUseRtpHeader": true,
"customerId": 5,
"id": "string",
"maxCost": 9,
"maxHops": 8,
"maxLatency": 4,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 10,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"cemUseRtpHeader": true,
"customerId": 9,
"id": "string",
"maxCost": 8,
"maxHops": 6,
"maxLatency": 5,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 2,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"cemUseRtpHeader": true,
"customerId": 2,
"id": "string",
"maxCost": 1,
"maxHops": 5,
"maxLatency": 10,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": "NO",
"cemUseRtpHeader": false,
"customerId": 9,
"id": "string",
"maxCost": 8,
"maxHops": 9,
"maxLatency": 5,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 9,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_E3",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"cemUseRtpHeader": true,
"customerId": 8,
"id": "string",
"maxCost": 10,
"maxHops": 8,
"maxLatency": 1,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T1",
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 2,
"startRow": 9,
"status": 2,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createClineServices",
"description": "The parameters and request body are for method: createClineServices. 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"
},
"bidirectional": {
"type": "string"
},
"cemUseRtpHeader": {
"type": "boolean"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"cemUseRtpHeader": true,
"customerId": 5,
"id": "string",
"maxCost": 7,
"maxHops": 8,
"maxLatency": 7,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 10,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 2,
"startRow": 9,
"status": 8,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/cline-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getClineServices",
"description": "The parameters and request body are for method: getClineServices. 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"
},
"bidirectional": {
"type": "string"
},
"cemUseRtpHeader": {
"type": "boolean"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"cemUseRtpHeader": true,
"customerId": 4,
"id": "string",
"maxCost": 5,
"maxHops": 1,
"maxLatency": 1,
"mediationProfileId": "string",
"meta": [
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 9,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "CESOPSN_CAS",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 8,
"startRow": 8,
"status": 10,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateClineServices",
"description": "The parameters and request body are for method: updateClineServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 9,
"startRow": 5,
"status": 1,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteClineServices",
"description": "The parameters and request body are for method: deleteClineServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 5,
"startRow": 6,
"status": 6,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/custom-attributes": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllCustomAttributes",
"description": "The parameters and request body are for method: getAllCustomAttributes. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"id": "string",
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"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"
}
],
"id": "string",
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"id": "string",
"name": "string",
"objectDescription": "string"
}
],
"endRow": 5,
"startRow": 4,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createCustomAttributes",
"description": "The parameters and request body are for method: createCustomAttributes. 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": {
"appId": {
"type": "string"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"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"
}
],
"id": "string",
"name": "string",
"objectDescription": "string"
},
"endRow": 6,
"startRow": 1,
"status": 7,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/custom-attributes/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getCustomAttributes",
"description": "The parameters and request body are for method: getCustomAttributes. 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": {
"appId": {
"type": "string"
},
"customAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"attributeValue": {
"type": "string"
}
}
}
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"id": "string",
"name": "string",
"objectDescription": "string"
},
"endRow": 8,
"startRow": 6,
"status": 4,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateCustomAttributes",
"description": "The parameters and request body are for method: updateCustomAttributes. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 7,
"startRow": 3,
"status": 3,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteCustomAttributes",
"description": "The parameters and request body are for method: deleteCustomAttributes. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 1,
"startRow": 5,
"status": 7,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/elan-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllElanServices",
"description": "The parameters and request body are for method: getAllElanServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"autoBindType": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"extensionTemplate": {
"type": "object",
"properties": {
"allowL2ExtensionConfiguration": {
"type": "boolean"
},
"enableL2ExtensionAugmentation": {
"type": "boolean"
},
"nni": {
"type": "object",
"properties": {
"autosetTagsToMatchServiceEndpoint": {
"type": "boolean"
},
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
},
"uni": {
"type": "object",
"properties": {
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
}
}
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "DOWN",
"appId": "string",
"autoBindType": "rsvp_te",
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 3,
"extensionTemplate": {
"allowL2ExtensionConfiguration": false,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": false,
"innerTag": 1,
"outerTag": 4
},
"uni": {
"innerTag": 2,
"outerTag": 4
}
},
"id": "string",
"innerTag": 9,
"maxCost": 8,
"maxHops": 7,
"maxLatency": 9,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 9,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"outerTag": 3,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"tunnelSelectionId": "string",
"vcType": "SATOP_E1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"autoBindType": "bgp",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 2,
"extensionTemplate": {
"allowL2ExtensionConfiguration": true,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": false,
"innerTag": 4,
"outerTag": 3
},
"uni": {
"innerTag": 3,
"outerTag": 6
}
},
"id": "string",
"innerTag": 3,
"maxCost": 8,
"maxHops": 9,
"maxLatency": 10,
"mediationProfileId": "string",
"meta": [
"string"
],
"monitorBandwidth": false,
"mtu": 2,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"outerTag": 9,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": false,
"tunnelSelectionId": "string",
"vcType": "SATOP_T3",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"autoBindType": "gre",
"bidirectional": "NO",
"customerId": 3,
"extensionTemplate": {
"allowL2ExtensionConfiguration": true,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": true,
"innerTag": 8,
"outerTag": 6
},
"uni": {
"innerTag": 7,
"outerTag": 5
}
},
"id": "string",
"innerTag": 2,
"maxCost": 8,
"maxHops": 2,
"maxLatency": 8,
"mediationProfileId": "string",
"meta": [
"string"
],
"monitorBandwidth": true,
"mtu": 5,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 4,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"tunnelSelectionId": "string",
"vcType": "SATOP_E1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"autoBindType": "ldp",
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 10,
"extensionTemplate": {
"allowL2ExtensionConfiguration": false,
"enableL2ExtensionAugmentation": false,
"nni": {
"autosetTagsToMatchServiceEndpoint": true,
"innerTag": 9,
"outerTag": 4
},
"uni": {
"innerTag": 2,
"outerTag": 1
}
},
"id": "string",
"innerTag": 4,
"maxCost": 5,
"maxHops": 8,
"maxLatency": 4,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 9,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"outerTag": 8,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": false,
"tunnelSelectionId": "string",
"vcType": "SATOP_E3",
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 9,
"startRow": 9,
"status": 4,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createElanServices",
"description": "The parameters and request body are for method: createElanServices. 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"
},
"autoBindType": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"extensionTemplate": {
"type": "object",
"properties": {
"allowL2ExtensionConfiguration": {
"type": "boolean"
},
"enableL2ExtensionAugmentation": {
"type": "boolean"
},
"nni": {
"type": "object",
"properties": {
"autosetTagsToMatchServiceEndpoint": {
"type": "boolean"
},
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
},
"uni": {
"type": "object",
"properties": {
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
}
}
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "MAINTENANCE",
"appId": "string",
"autoBindType": "gre",
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 8,
"extensionTemplate": {
"allowL2ExtensionConfiguration": false,
"enableL2ExtensionAugmentation": false,
"nni": {
"autosetTagsToMatchServiceEndpoint": false,
"innerTag": 10,
"outerTag": 1
},
"uni": {
"innerTag": 7,
"outerTag": 10
}
},
"id": "string",
"innerTag": 8,
"maxCost": 2,
"maxHops": 4,
"maxLatency": 7,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 7,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"outerTag": 10,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"tunnelSelectionId": "string",
"vcType": "ETHERNET_TAGGED_MODE",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 10,
"startRow": 3,
"status": 4,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/elan-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getElanServices",
"description": "The parameters and request body are for method: getElanServices. 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"
},
"autoBindType": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"extensionTemplate": {
"type": "object",
"properties": {
"allowL2ExtensionConfiguration": {
"type": "boolean"
},
"enableL2ExtensionAugmentation": {
"type": "boolean"
},
"nni": {
"type": "object",
"properties": {
"autosetTagsToMatchServiceEndpoint": {
"type": "boolean"
},
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
},
"uni": {
"type": "object",
"properties": {
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
}
}
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "UP",
"appId": "string",
"autoBindType": "none",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 5,
"extensionTemplate": {
"allowL2ExtensionConfiguration": true,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": true,
"innerTag": 8,
"outerTag": 7
},
"uni": {
"innerTag": 1,
"outerTag": 9
}
},
"id": "string",
"innerTag": 2,
"maxCost": 8,
"maxHops": 7,
"maxLatency": 5,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 7,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"outerTag": 9,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"tunnelSelectionId": "string",
"vcType": "SATOP_E1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 5,
"startRow": 8,
"status": 9,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateElanServices",
"description": "The parameters and request body are for method: updateElanServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 8,
"startRow": 4,
"status": 8,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteElanServices",
"description": "The parameters and request body are for method: deleteElanServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 5,
"startRow": 8,
"status": 7,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/eline-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllElineServices",
"description": "The parameters and request body are for method: getAllElineServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"autoBindType": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"extensionTemplate": {
"type": "object",
"properties": {
"allowL2ExtensionConfiguration": {
"type": "boolean"
},
"enableL2ExtensionAugmentation": {
"type": "boolean"
},
"nni": {
"type": "object",
"properties": {
"autosetTagsToMatchServiceEndpoint": {
"type": "boolean"
},
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
},
"uni": {
"type": "object",
"properties": {
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
}
}
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "DOWN",
"appId": "string",
"autoBindType": "bgp",
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 6,
"extensionTemplate": {
"allowL2ExtensionConfiguration": false,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": true,
"innerTag": 3,
"outerTag": 8
},
"uni": {
"innerTag": 10,
"outerTag": 1
}
},
"id": "string",
"innerTag": 5,
"maxCost": 6,
"maxHops": 7,
"maxLatency": 8,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 4,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"outerTag": 4,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": false,
"tunnelSelectionId": "string",
"vcType": "SATOP_T3",
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 4,
"startRow": 8,
"status": 7,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createElineServices",
"description": "The parameters and request body are for method: createElineServices. 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"
},
"autoBindType": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"extensionTemplate": {
"type": "object",
"properties": {
"allowL2ExtensionConfiguration": {
"type": "boolean"
},
"enableL2ExtensionAugmentation": {
"type": "boolean"
},
"nni": {
"type": "object",
"properties": {
"autosetTagsToMatchServiceEndpoint": {
"type": "boolean"
},
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
},
"uni": {
"type": "object",
"properties": {
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
}
}
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "MAINTENANCE",
"appId": "string",
"autoBindType": "any",
"bidirectional": "NO",
"customerId": 10,
"extensionTemplate": {
"allowL2ExtensionConfiguration": true,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": true,
"innerTag": 9,
"outerTag": 10
},
"uni": {
"innerTag": 5,
"outerTag": 7
}
},
"id": "string",
"innerTag": 6,
"maxCost": 6,
"maxHops": 8,
"maxLatency": 3,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 6,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"outerTag": 2,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"tunnelSelectionId": "string",
"vcType": "SATOP_T3",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 7,
"startRow": 5,
"status": 4,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/eline-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getElineServices",
"description": "The parameters and request body are for method: getElineServices. 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"
},
"autoBindType": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"extensionTemplate": {
"type": "object",
"properties": {
"allowL2ExtensionConfiguration": {
"type": "boolean"
},
"enableL2ExtensionAugmentation": {
"type": "boolean"
},
"nni": {
"type": "object",
"properties": {
"autosetTagsToMatchServiceEndpoint": {
"type": "boolean"
},
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
},
"uni": {
"type": "object",
"properties": {
"innerTag": {
"type": "number"
},
"outerTag": {
"type": "number"
}
}
}
}
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "UP",
"appId": "string",
"autoBindType": "ldp",
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 2,
"extensionTemplate": {
"allowL2ExtensionConfiguration": false,
"enableL2ExtensionAugmentation": true,
"nni": {
"autosetTagsToMatchServiceEndpoint": false,
"innerTag": 3,
"outerTag": 5
},
"uni": {
"innerTag": 3,
"outerTag": 5
}
},
"id": "string",
"innerTag": 9,
"maxCost": 9,
"maxHops": 9,
"maxLatency": 8,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 10,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"outerTag": 1,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"tunnelSelectionId": "string",
"vcType": "CESOPSN",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 3,
"startRow": 5,
"status": 3,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateElineServices",
"description": "The parameters and request body are for method: updateElineServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 1,
"startRow": 2,
"status": 3,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteElineServices",
"description": "The parameters and request body are for method: deleteElineServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 6,
"startRow": 7,
"status": 5,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/generic-qos": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllGenericQos",
"description": "The parameters and request body are for method: getAllGenericQos. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"egressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"egressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"ingressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"ingressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 2
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 3,
"cir": 4,
"id": 4,
"mbs": 9,
"pir": 2,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 9,
"id": 6,
"mbs": 5,
"pir": 6,
"queueType": "Policer",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 2
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 3,
"cir": 6,
"id": 8,
"mbs": 1,
"pir": 8,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 4,
"id": 9,
"mbs": 7,
"pir": 6,
"queueType": "Policer",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 4
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string",
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 8,
"cir": 1,
"id": 8,
"mbs": 1,
"pir": 6,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 9,
"id": 10,
"mbs": 9,
"pir": 9,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 8,
"id": 10,
"mbs": 3,
"pir": 5,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 3,
"id": 1,
"mbs": 1,
"pir": 5,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 7,
"id": 3,
"mbs": 9,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 7,
"id": 8,
"mbs": 5,
"pir": 3,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 4,
"id": 10,
"mbs": 9,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 2,
"id": 3,
"mbs": 3,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 2,
"id": 8,
"mbs": 9,
"pir": 7,
"queueType": "Queue",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 5
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 5,
"cir": 6,
"id": 9,
"mbs": 1,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 6,
"id": 10,
"mbs": 8,
"pir": 5,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 10,
"id": 5,
"mbs": 6,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 4,
"cir": 3,
"id": 10,
"mbs": 1,
"pir": 2,
"queueType": "Policer",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 9
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 5,
"cir": 1,
"id": 6,
"mbs": 4,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 4,
"cir": 5,
"id": 9,
"mbs": 5,
"pir": 5,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 7,
"id": 8,
"mbs": 1,
"pir": 3,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 7,
"id": 4,
"mbs": 4,
"pir": 7,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 2,
"cir": 1,
"id": 3,
"mbs": 1,
"pir": 7,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 8,
"id": 2,
"mbs": 10,
"pir": 7,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 4,
"id": 8,
"mbs": 8,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 2,
"id": 5,
"mbs": 8,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 1,
"id": 3,
"mbs": 1,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
}
],
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 8
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 5,
"cir": 2,
"id": 1,
"mbs": 10,
"pir": 5,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 9,
"id": 7,
"mbs": 4,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 3,
"id": 2,
"mbs": 4,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 4,
"id": 3,
"mbs": 9,
"pir": 10,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 3,
"id": 6,
"mbs": 2,
"pir": 3,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 9,
"id": 10,
"mbs": 6,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 4,
"id": 5,
"mbs": 3,
"pir": 9,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 7,
"cir": 2,
"id": 1,
"mbs": 8,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 5,
"id": 6,
"mbs": 8,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 6
},
{
"cos": "string",
"queueId": 1
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 2,
"cir": 6,
"id": 4,
"mbs": 3,
"pir": 4,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 8,
"id": 1,
"mbs": 7,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 1,
"id": 6,
"mbs": 7,
"pir": 10,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 8,
"id": 4,
"mbs": 7,
"pir": 6,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 4,
"id": 7,
"mbs": 6,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 8,
"id": 6,
"mbs": 9,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 10,
"id": 4,
"mbs": 5,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 10,
"id": 5,
"mbs": 3,
"pir": 3,
"queueType": "Policer",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 6
},
{
"cos": "string",
"queueId": 9
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 3,
"cir": 8,
"id": 6,
"mbs": 2,
"pir": 3,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 5,
"id": 10,
"mbs": 1,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 9,
"id": 7,
"mbs": 3,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 6,
"id": 2,
"mbs": 3,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 9,
"id": 3,
"mbs": 5,
"pir": 6,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 10,
"id": 7,
"mbs": 4,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 10,
"id": 10,
"mbs": 7,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 4,
"id": 10,
"mbs": 3,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 4,
"cir": 8,
"id": 6,
"mbs": 9,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 3,
"id": 3,
"mbs": 9,
"pir": 2,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 10
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 1,
"cir": 8,
"id": 5,
"mbs": 10,
"pir": 7,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 10,
"id": 10,
"mbs": 4,
"pir": 6,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 7,
"id": 10,
"mbs": 5,
"pir": 5,
"queueType": "Policer",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 10
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 9,
"cir": 5,
"id": 8,
"mbs": 10,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 6,
"id": 2,
"mbs": 3,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 8,
"id": 7,
"mbs": 5,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string"
}
],
"endRow": 4,
"startRow": 6,
"status": 6,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createGenericQos",
"description": "The parameters and request body are for method: createGenericQos. 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": {
"appId": {
"type": "string"
},
"egressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"egressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"ingressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"ingressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 6
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 7
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 2,
"cir": 6,
"id": 10,
"mbs": 10,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 4,
"id": 4,
"mbs": 4,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 9,
"id": 4,
"mbs": 2,
"pir": 1,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 1,
"id": 6,
"mbs": 1,
"pir": 8,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 2,
"id": 8,
"mbs": 7,
"pir": 2,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 6,
"id": 9,
"mbs": 1,
"pir": 8,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 2,
"id": 3,
"mbs": 2,
"pir": 8,
"queueType": "Queue",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 8
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 8,
"cir": 4,
"id": 6,
"mbs": 2,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 4,
"cir": 5,
"id": 7,
"mbs": 6,
"pir": 1,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 8,
"id": 9,
"mbs": 3,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 2,
"id": 2,
"mbs": 5,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 3,
"id": 5,
"mbs": 9,
"pir": 3,
"queueType": "Policer",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string"
},
"endRow": 10,
"startRow": 9,
"status": 5,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/generic-qos-profiles/{neId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getGenericQosProfiles",
"description": "The parameters and request body are for method: getGenericQosProfiles. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"egressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"egressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"ingressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"ingressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 2
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 6,
"cir": 6,
"id": 7,
"mbs": 7,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 5,
"id": 2,
"mbs": 2,
"pir": 3,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 2,
"cir": 7,
"id": 4,
"mbs": 9,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
}
],
"externalIds": [
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 7
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 4,
"cir": 3,
"id": 3,
"mbs": 1,
"pir": 5,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 5,
"id": 5,
"mbs": 9,
"pir": 6,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 4,
"id": 2,
"mbs": 1,
"pir": 9,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 1,
"id": 9,
"mbs": 1,
"pir": 10,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 7,
"id": 7,
"mbs": 7,
"pir": 3,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 2,
"id": 8,
"mbs": 10,
"pir": 5,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 5,
"id": 8,
"mbs": 5,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 5,
"id": 9,
"mbs": 7,
"pir": 10,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 9,
"id": 2,
"mbs": 1,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 5,
"id": 4,
"mbs": 3,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 8
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 7,
"cir": 1,
"id": 2,
"mbs": 10,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 5,
"id": 9,
"mbs": 7,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 3,
"id": 2,
"mbs": 7,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 9,
"id": 10,
"mbs": 8,
"pir": 3,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 2,
"id": 9,
"mbs": 1,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 6
},
{
"cos": "string",
"queueId": 9
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 6,
"cir": 9,
"id": 4,
"mbs": 3,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 3,
"id": 4,
"mbs": 6,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 5,
"id": 6,
"mbs": 9,
"pir": 10,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 9,
"id": 4,
"mbs": 3,
"pir": 4,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 6,
"id": 4,
"mbs": 1,
"pir": 8,
"queueType": "Queue",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string"
},
{
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 10
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 2
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 9,
"cir": 6,
"id": 9,
"mbs": 9,
"pir": 8,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 2,
"id": 2,
"mbs": 1,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 2,
"id": 1,
"mbs": 3,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 2,
"id": 7,
"mbs": 6,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 3,
"cir": 6,
"id": 10,
"mbs": 9,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 5
},
{
"cos": "string",
"queueId": 9
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 6,
"cir": 9,
"id": 8,
"mbs": 3,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 8,
"id": 9,
"mbs": 6,
"pir": 8,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 8,
"id": 2,
"mbs": 8,
"pir": 6,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 1,
"id": 10,
"mbs": 2,
"pir": 9,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 7,
"id": 2,
"mbs": 4,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 7,
"id": 4,
"mbs": 4,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 3,
"id": 6,
"mbs": 7,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string"
}
],
"endRow": 4,
"startRow": 7,
"status": 1,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/generic-qos/{gqpId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getGenericQos",
"description": "The parameters and request body are for method: getGenericQos. 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": {
"appId": {
"type": "string"
},
"egressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"egressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"externalIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"context": {
"type": "string"
},
"id": {
"type": "string"
},
"location": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"id": {
"type": "string"
},
"ingressCosMappingTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cos": {
"type": "string"
},
"queueId": {
"type": "number"
}
}
}
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressPolicyList": {
"type": "array",
"items": {
"type": "string"
}
},
"ingressQueueConfigurationTable": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"egressCosMappingTable": [
{
"cos": "string",
"queueId": 1
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 4
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 1
}
],
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressPolicyList": [
"string",
"string"
],
"egressQueueConfigurationTable": [
{
"cbs": 2,
"cir": 6,
"id": 1,
"mbs": 4,
"pir": 10,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 3,
"id": 9,
"mbs": 2,
"pir": 5,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 8,
"id": 10,
"mbs": 2,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 5,
"id": 8,
"mbs": 2,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 10,
"cir": 9,
"id": 7,
"mbs": 3,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
}
],
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"ingressCosMappingTable": [
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 8
},
{
"cos": "string",
"queueId": 6
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 7
},
{
"cos": "string",
"queueId": 9
},
{
"cos": "string",
"queueId": 3
},
{
"cos": "string",
"queueId": 2
},
{
"cos": "string",
"queueId": 9
}
],
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressPolicyList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"ingressQueueConfigurationTable": [
{
"cbs": 8,
"cir": 2,
"id": 8,
"mbs": 9,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string"
},
"endRow": 10,
"startRow": 10,
"status": 10,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "gqpId",
"in": "path",
"required": true,
"schema": {
"title": "gqpId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateGenericQos",
"description": "The parameters and request body are for method: updateGenericQos. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 6,
"startRow": 8,
"status": 6,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "gqpId",
"in": "path",
"required": true,
"schema": {
"title": "gqpId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteGenericQos",
"description": "The parameters and request body are for method: deleteGenericQos. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 9,
"status": 7,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "gqpId",
"in": "path",
"required": true,
"schema": {
"title": "gqpId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/ies-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllIesServices",
"description": "The parameters and request body are for method: getAllIesServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 2,
"id": "string",
"innerTag": 5,
"maxCost": 10,
"maxHops": 10,
"maxLatency": 4,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 3,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"outerTag": 7,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "SYMMETRIC_STRICT",
"customerId": 7,
"id": "string",
"innerTag": 10,
"maxCost": 9,
"maxHops": 5,
"maxLatency": 8,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 4,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"outerTag": 5,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": false,
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"customerId": 3,
"id": "string",
"innerTag": 5,
"maxCost": 7,
"maxHops": 3,
"maxLatency": 4,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string"
],
"mtu": 5,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"outerTag": 10,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": false,
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 10,
"startRow": 9,
"status": 5,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createIesServices",
"description": "The parameters and request body are for method: createIesServices. 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"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 10,
"id": "string",
"innerTag": 6,
"maxCost": 10,
"maxHops": 9,
"maxLatency": 2,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 3,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"outerTag": 7,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": false,
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 3,
"startRow": 5,
"status": 4,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/ies-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getIesServices",
"description": "The parameters and request body are for method: getIesServices. 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"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "NO",
"customerId": 10,
"id": "string",
"innerTag": 4,
"maxCost": 5,
"maxHops": 10,
"maxLatency": 7,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 2,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"outerTag": 10,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"relaxEndpointValidation": true,
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 1,
"startRow": 8,
"status": 1,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateIesServices",
"description": "The parameters and request body are for method: updateIesServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 1,
"startRow": 9,
"status": 5,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteIesServices",
"description": "The parameters and request body are for method: deleteIesServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 3,
"startRow": 5,
"status": 4,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/l2-dci-vpn-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllL2DciVpnServices",
"description": "The parameters and request body are for method: getAllL2DciVpnServices. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"autobind": {
"type": "string"
},
"descriptionGenerationTemplate": {
"type": "string"
},
"dualHomed": {
"type": "boolean"
},
"ecmp": {
"type": "number"
},
"id": {
"type": "string"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"nameGenerationMaxLength": {
"type": "number"
},
"nameGenerationTemplate": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"autobind": "sr_isis",
"descriptionGenerationTemplate": "string",
"dualHomed": true,
"ecmp": 2,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string"
],
"mtu": 5,
"name": "string",
"nameGenerationMaxLength": 3,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
{
"appId": "string",
"autobind": "sr_ospf",
"descriptionGenerationTemplate": "string",
"dualHomed": false,
"ecmp": 9,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 6,
"name": "string",
"nameGenerationMaxLength": 5,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
{
"appId": "string",
"autobind": "sr_ospf",
"descriptionGenerationTemplate": "string",
"dualHomed": false,
"ecmp": 4,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 6,
"name": "string",
"nameGenerationMaxLength": 4,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
{
"appId": "string",
"autobind": "sr_ospf",
"descriptionGenerationTemplate": "string",
"dualHomed": false,
"ecmp": 5,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string"
],
"mtu": 10,
"name": "string",
"nameGenerationMaxLength": 9,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
{
"appId": "string",
"autobind": "sr_isis",
"descriptionGenerationTemplate": "string",
"dualHomed": true,
"ecmp": 5,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string",
"string"
],
"mtu": 8,
"name": "string",
"nameGenerationMaxLength": 8,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
{
"appId": "string",
"autobind": "sr_ospf",
"descriptionGenerationTemplate": "string",
"dualHomed": true,
"ecmp": 6,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string"
],
"mtu": 8,
"name": "string",
"nameGenerationMaxLength": 6,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
{
"appId": "string",
"autobind": "rsvp_te",
"descriptionGenerationTemplate": "string",
"dualHomed": true,
"ecmp": 9,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 4,
"name": "string",
"nameGenerationMaxLength": 7,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
}
],
"endRow": 1,
"startRow": 8,
"status": 2,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/l2-dci-vpn-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getL2DciVpnServices",
"description": "The parameters and request body are for method: getL2DciVpnServices. 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": {
"appId": {
"type": "string"
},
"autobind": {
"type": "string"
},
"descriptionGenerationTemplate": {
"type": "string"
},
"dualHomed": {
"type": "boolean"
},
"ecmp": {
"type": "number"
},
"id": {
"type": "string"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"nameGenerationMaxLength": {
"type": "number"
},
"nameGenerationTemplate": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"autobind": "ldp",
"descriptionGenerationTemplate": "string",
"dualHomed": false,
"ecmp": 3,
"id": "string",
"mediationProfileId": "string",
"meta": [
"string"
],
"mtu": 5,
"name": "string",
"nameGenerationMaxLength": 1,
"nameGenerationTemplate": "string",
"objectDescription": "string",
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"tunnelSelectionId": "string",
"workflowProfileId": "string"
},
"endRow": 8,
"startRow": 1,
"status": 10,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateL2DciVpnServices",
"description": "The parameters and request body are for method: updateL2DciVpnServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 1,
"startRow": 6,
"status": 10,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/l2backhaul-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllL2backhaulServices",
"description": "The parameters and request body are for method: getAllL2backhaulServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 7,
"id": "string",
"innerTag": 2,
"maxCost": 1,
"maxHops": 6,
"maxLatency": 3,
"meta": [
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 3,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"outerTag": 8,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "DOWN",
"appId": "string",
"bidirectional": "NO",
"customerId": 3,
"id": "string",
"innerTag": 2,
"maxCost": 9,
"maxHops": 1,
"maxLatency": 1,
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 10,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 10,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": "NO",
"customerId": 5,
"id": "string",
"innerTag": 1,
"maxCost": 4,
"maxHops": 8,
"maxLatency": 2,
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"outerTag": 10,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "CESOPSN_CAS",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": "NO",
"customerId": 7,
"id": "string",
"innerTag": 6,
"maxCost": 3,
"maxHops": 7,
"maxLatency": 2,
"meta": [
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 4,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"outerTag": 6,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_E1",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 5,
"id": "string",
"innerTag": 5,
"maxCost": 8,
"maxHops": 5,
"maxLatency": 10,
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 5,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"outerTag": 4,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_E3",
"workflowProfileId": "string",
"workflowValidate": "string"
},
{
"adminState": "UP",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 7,
"id": "string",
"innerTag": 3,
"maxCost": 6,
"maxHops": 2,
"maxLatency": 9,
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 3,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T1",
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 3,
"startRow": 5,
"status": 2,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createL2backhaulServices",
"description": "The parameters and request body are for method: createL2backhaulServices. 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"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 4,
"id": "string",
"innerTag": 2,
"maxCost": 6,
"maxHops": 7,
"maxLatency": 10,
"meta": [
"string",
"string",
"string"
],
"monitorBandwidth": false,
"mtu": 2,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 3,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "ETHERNET",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 7,
"startRow": 5,
"status": 6,
"totalRows": 2
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/l2backhaul-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getL2backhaulServices",
"description": "The parameters and request body are for method: getL2backhaulServices. 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"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"monitorBandwidth": {
"type": "boolean"
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vcType": {
"type": "string"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 5,
"id": "string",
"innerTag": 4,
"maxCost": 4,
"maxHops": 10,
"maxLatency": 8,
"meta": [
"string",
"string",
"string"
],
"monitorBandwidth": true,
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 4,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"tunnelSelectionId": "string",
"vcType": "SATOP_T3",
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 2,
"startRow": 4,
"status": 10,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateL2backhaulServices",
"description": "The parameters and request body are for method: updateL2backhaulServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 9,
"startRow": 10,
"status": 3,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteL2backhaulServices",
"description": "The parameters and request body are for method: deleteL2backhaulServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 2,
"startRow": 5,
"status": 5,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/l3-dci-vpn-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllL3DciVpnServices",
"description": "The parameters and request body are for method: getAllL3DciVpnServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"autobind": {
"type": "string"
},
"backhaulMtu": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"connectivity": {
"type": "string"
},
"customerId": {
"type": "number"
},
"dualHomed": {
"type": "boolean"
},
"ecmp": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"transportSliceName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vrfPerEndpoint": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "DOWN",
"appId": "string",
"autobind": "sr_isis",
"backhaulMtu": 1,
"bidirectional": "ANY_REVERSE_ROUTE",
"connectivity": "VXLAN_STITCHED",
"customerId": 8,
"dualHomed": false,
"ecmp": 4,
"id": "string",
"innerTag": 9,
"maxCost": 3,
"maxHops": 7,
"maxLatency": 1,
"mediationProfileId": "string",
"meta": [
"string"
],
"mtu": 10,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"outerTag": 4,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"relaxEndpointValidation": false,
"transportSliceName": "string",
"tunnelSelectionId": "string",
"vrfPerEndpoint": true,
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 8,
"startRow": 4,
"status": 4,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createL3DciVpnServices",
"description": "The parameters and request body are for method: createL3DciVpnServices. 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"
},
"autobind": {
"type": "string"
},
"backhaulMtu": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"connectivity": {
"type": "string"
},
"customerId": {
"type": "number"
},
"dualHomed": {
"type": "boolean"
},
"ecmp": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"transportSliceName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vrfPerEndpoint": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "MAINTENANCE",
"appId": "string",
"autobind": "sr_ospf",
"backhaulMtu": 9,
"bidirectional": "SYMMETRIC_STRICT",
"connectivity": "VXLAN_STITCHED",
"customerId": 1,
"dualHomed": false,
"ecmp": 9,
"id": "string",
"innerTag": 9,
"maxCost": 2,
"maxHops": 10,
"maxLatency": 6,
"mediationProfileId": "string",
"meta": [
"string"
],
"mtu": 1,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 1,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"relaxEndpointValidation": false,
"transportSliceName": "string",
"tunnelSelectionId": "string",
"vrfPerEndpoint": false,
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 7,
"startRow": 3,
"status": 7,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/l3-dci-vpn-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getL3DciVpnServices",
"description": "The parameters and request body are for method: getL3DciVpnServices. 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"
},
"autobind": {
"type": "string"
},
"backhaulMtu": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"connectivity": {
"type": "string"
},
"customerId": {
"type": "number"
},
"dualHomed": {
"type": "boolean"
},
"ecmp": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"transportSliceName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vrfPerEndpoint": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"autobind": "bgp",
"backhaulMtu": 6,
"bidirectional": "ANY_REVERSE_ROUTE",
"connectivity": "MPLS_E2E",
"customerId": 8,
"dualHomed": false,
"ecmp": 10,
"id": "string",
"innerTag": 6,
"maxCost": 4,
"maxHops": 5,
"maxLatency": 10,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string"
],
"mtu": 5,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"outerTag": 5,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 1,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"relaxEndpointValidation": false,
"transportSliceName": "string",
"tunnelSelectionId": "string",
"vrfPerEndpoint": false,
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 3,
"startRow": 8,
"status": 9,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateL3DciVpnServices",
"description": "The parameters and request body are for method: updateL3DciVpnServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 4,
"startRow": 9,
"status": 9,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteL3DciVpnServices",
"description": "The parameters and request body are for method: deleteL3DciVpnServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 3,
"startRow": 1,
"status": 7,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/l3-vpn-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllL3VpnServices",
"description": "The parameters and request body are for method: getAllL3VpnServices. 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": "object",
"properties": {
"adminState": {
"type": "string"
},
"appId": {
"type": "string"
},
"autobind": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"transportSliceName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vrfPerEndpoint": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"adminState": "MAINTENANCE",
"appId": "string",
"autobind": "any",
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 7,
"id": "string",
"innerTag": 10,
"maxCost": 5,
"maxHops": 9,
"maxLatency": 3,
"mediationProfileId": "string",
"meta": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"mtu": 9,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"outerTag": 4,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"relaxEndpointValidation": true,
"transportSliceName": "string",
"tunnelSelectionId": "string",
"vrfPerEndpoint": false,
"workflowProfileId": "string",
"workflowValidate": "string"
}
],
"endRow": 5,
"startRow": 10,
"status": 5,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createL3VpnServices",
"description": "The parameters and request body are for method: createL3VpnServices. 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"
},
"autobind": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"transportSliceName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vrfPerEndpoint": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "DOWN",
"appId": "string",
"autobind": "rsvp_te",
"bidirectional": "SYMMETRIC_STRICT",
"customerId": 5,
"id": "string",
"innerTag": 1,
"maxCost": 6,
"maxHops": 7,
"maxLatency": 4,
"mediationProfileId": "string",
"meta": [
"string"
],
"mtu": 4,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"outerTag": 3,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 9,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"relaxEndpointValidation": true,
"transportSliceName": "string",
"tunnelSelectionId": "string",
"vrfPerEndpoint": true,
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 5,
"startRow": 5,
"status": 2,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/l3-vpn-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getL3VpnServices",
"description": "The parameters and request body are for method: getL3VpnServices. 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"
},
"autobind": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"innerTag": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"mediationProfileId": {
"type": "string"
},
"meta": {
"type": "array",
"items": {
"type": "string"
}
},
"mtu": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"outerTag": {
"type": "number"
},
"portFilter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"condition1": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"condition2": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"connector": {
"type": "string"
},
"groupNum": {
"type": "number"
},
"name": {
"type": "string"
},
"operator": {
"type": "string"
}
}
}
},
"qosId": {
"type": "string"
},
"qosName": {
"type": "string"
},
"rdRtRangePolicyId": {
"type": "string"
},
"relaxEndpointValidation": {
"type": "boolean"
},
"transportSliceName": {
"type": "string"
},
"tunnelSelectionId": {
"type": "string"
},
"vrfPerEndpoint": {
"type": "boolean"
},
"workflowProfileId": {
"type": "string"
},
"workflowValidate": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"adminState": "UP",
"appId": "string",
"autobind": "any",
"bidirectional": "SYMMETRIC_STRICT",
"customerId": 6,
"id": "string",
"innerTag": 6,
"maxCost": 1,
"maxHops": 2,
"maxLatency": 6,
"mediationProfileId": "string",
"meta": [
"string",
"string"
],
"mtu": 7,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"outerTag": 8,
"portFilter": [
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 3,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 7,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 2,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 5,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 8,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 4,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 6,
"name": "string",
"operator": "string"
},
{
"condition1": {
"operator": "string",
"value": "string"
},
"condition2": {
"operator": "string",
"value": "string"
},
"connector": "string",
"groupNum": 10,
"name": "string",
"operator": "string"
}
],
"qosId": "string",
"qosName": "string",
"rdRtRangePolicyId": "string",
"relaxEndpointValidation": true,
"transportSliceName": "string",
"tunnelSelectionId": "string",
"vrfPerEndpoint": true,
"workflowProfileId": "string",
"workflowValidate": "string"
},
"endRow": 4,
"startRow": 4,
"status": 3,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateL3VpnServices",
"description": "The parameters and request body are for method: updateL3VpnServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 8,
"startRow": 8,
"status": 10,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteL3VpnServices",
"description": "The parameters and request body are for method: deleteL3VpnServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 4,
"startRow": 9,
"status": 10,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/lag-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllLagServices",
"description": "The parameters and request body are for method: getAllLagServices. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"bandwidth": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"monitorBandwidth": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"reverseBandwidth": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"bandwidth": 1,
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 9,
"id": "string",
"maxCost": 6,
"maxHops": 6,
"maxLatency": 6,
"monitorBandwidth": true,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"reverseBandwidth": 7
},
{
"appId": "string",
"bandwidth": 2,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 4,
"id": "string",
"maxCost": 3,
"maxHops": 1,
"maxLatency": 4,
"monitorBandwidth": true,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"reverseBandwidth": 8
},
{
"appId": "string",
"bandwidth": 3,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 5,
"id": "string",
"maxCost": 4,
"maxHops": 6,
"maxLatency": 4,
"monitorBandwidth": false,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"reverseBandwidth": 2
},
{
"appId": "string",
"bandwidth": 3,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 10,
"id": "string",
"maxCost": 7,
"maxHops": 9,
"maxLatency": 5,
"monitorBandwidth": false,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"reverseBandwidth": 7
},
{
"appId": "string",
"bandwidth": 9,
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 6,
"id": "string",
"maxCost": 10,
"maxHops": 2,
"maxLatency": 1,
"monitorBandwidth": true,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"reverseBandwidth": 4
},
{
"appId": "string",
"bandwidth": 4,
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 2,
"id": "string",
"maxCost": 10,
"maxHops": 10,
"maxLatency": 9,
"monitorBandwidth": true,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"reverseBandwidth": 7
}
],
"endRow": 1,
"startRow": 4,
"status": 7,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createLagServices",
"description": "The parameters and request body are for method: createLagServices. 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": {
"appId": {
"type": "string"
},
"bandwidth": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"monitorBandwidth": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"reverseBandwidth": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bandwidth": 8,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 3,
"id": "string",
"maxCost": 9,
"maxHops": 3,
"maxLatency": 6,
"monitorBandwidth": true,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"reverseBandwidth": 2
},
"endRow": 9,
"startRow": 2,
"status": 9,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/lag-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getLagServices",
"description": "The parameters and request body are for method: getLagServices. 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": {
"appId": {
"type": "string"
},
"bandwidth": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"monitorBandwidth": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"reverseBandwidth": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bandwidth": 8,
"bidirectional": "SYMMETRIC_STRICT",
"customerId": 4,
"id": "string",
"maxCost": 6,
"maxHops": 6,
"maxLatency": 3,
"monitorBandwidth": false,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"reverseBandwidth": 7
},
"endRow": 10,
"startRow": 9,
"status": 7,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateLagServices",
"description": "The parameters and request body are for method: updateLagServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 8,
"startRow": 10,
"status": 2,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteLagServices",
"description": "The parameters and request body are for method: deleteLagServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 4,
"startRow": 7,
"status": 4,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/mediation-profile-mapping": {
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createMediationProfileMapping",
"description": "The parameters and request body are for method: createMediationProfileMapping. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"mediationInfos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediationName": {
"type": "string"
},
"mediationVersion": {
"type": "string"
},
"templateGlobalName": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"profileType": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "IES"
},
"endRow": 8,
"startRow": 1,
"status": 6,
"totalRows": 4
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/mediation-profile-mapping/{profileId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getMediationProfileMapping",
"description": "The parameters and request body are for method: getMediationProfileMapping. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"mediationInfos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediationName": {
"type": "string"
},
"mediationVersion": {
"type": "string"
},
"templateGlobalName": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"profileType": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "CLINE"
},
"endRow": 5,
"startRow": 4,
"status": 5,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateMediationProfileMapping",
"description": "The parameters and request body are for method: updateMediationProfileMapping. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 10,
"startRow": 8,
"status": 2,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteMediationProfileMapping",
"description": "The parameters and request body are for method: deleteMediationProfileMapping. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 6,
"startRow": 5,
"status": 10,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/mediation-profile-mappings": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllMediationProfileMappings",
"description": "The parameters and request body are for method: getAllMediationProfileMappings. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"mediationInfos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"mediationName": {
"type": "string"
},
"mediationVersion": {
"type": "string"
},
"templateGlobalName": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"profileType": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "L3VPN"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "IES"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "IES"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "L3VPN"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "IES"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "CLINE"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "CLINE"
},
{
"appId": "string",
"id": "string",
"mediationInfos": [
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
},
{
"mediationName": "string",
"mediationVersion": "string",
"templateGlobalName": "string"
}
],
"name": "string",
"objectDescription": "string",
"profileType": "IES"
}
],
"endRow": 6,
"startRow": 9,
"status": 5,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/nfmp-template": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getNfmpTemplate",
"description": "The parameters and request body are for method: getNfmpTemplate. 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": [
"ADMIN",
"USER",
"ADMIN",
"OPERATOR",
"USER",
"ADMIN",
"ADMIN",
"ADMIN",
"ADMIN",
"OPERATOR"
],
"endRow": 4,
"startRow": 5,
"status": 7,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/och-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllOchServices",
"description": "The parameters and request body are for method: getAllOchServices. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"restoration": {
"type": "string"
},
"reversionMode": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 10,
"id": "string",
"maxCost": 3,
"maxHops": 10,
"maxLatency": 6,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"restoration": "GR",
"reversionMode": "softauto"
},
{
"appId": "string",
"bidirectional": "NO",
"customerId": 9,
"id": "string",
"maxCost": 2,
"maxHops": 7,
"maxLatency": 2,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"restoration": "None",
"reversionMode": "softauto"
},
{
"appId": "string",
"bidirectional": "SYMMETRIC_LOOSE",
"customerId": 4,
"id": "string",
"maxCost": 3,
"maxHops": 10,
"maxLatency": 10,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"restoration": "SBR",
"reversionMode": "manual"
},
{
"appId": "string",
"bidirectional": "NO",
"customerId": 8,
"id": "string",
"maxCost": 9,
"maxHops": 8,
"maxLatency": 9,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"restoration": "SBR",
"reversionMode": "manual"
}
],
"endRow": 4,
"startRow": 6,
"status": 5,
"totalRows": 8
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createOchServices",
"description": "The parameters and request body are for method: createOchServices. 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": {
"appId": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"restoration": {
"type": "string"
},
"reversionMode": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bidirectional": "NO",
"customerId": 9,
"id": "string",
"maxCost": 2,
"maxHops": 9,
"maxLatency": 9,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"restoration": "None",
"reversionMode": "manual"
},
"endRow": 2,
"startRow": 5,
"status": 2,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/och-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getOchServices",
"description": "The parameters and request body are for method: getOchServices. 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": {
"appId": {
"type": "string"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"restoration": {
"type": "string"
},
"reversionMode": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 5,
"id": "string",
"maxCost": 6,
"maxHops": 7,
"maxLatency": 6,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"restoration": "GR",
"reversionMode": "auto"
},
"endRow": 9,
"startRow": 9,
"status": 2,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateOchServices",
"description": "The parameters and request body are for method: updateOchServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 6,
"startRow": 5,
"status": 8,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteOchServices",
"description": "The parameters and request body are for method: deleteOchServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 8,
"startRow": 8,
"status": 7,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/odu-services": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllOduServices",
"description": "The parameters and request body are for method: getAllOduServices. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"bandwidth": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"reverseBandwidth": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"bandwidth": 8,
"bidirectional": "ASYMMETRIC_STRICT",
"customerId": 2,
"id": "string",
"maxCost": 1,
"maxHops": 4,
"maxLatency": 2,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"reverseBandwidth": 2
},
{
"appId": "string",
"bandwidth": 9,
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 3,
"id": "string",
"maxCost": 3,
"maxHops": 7,
"maxLatency": 3,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"reverseBandwidth": 1
},
{
"appId": "string",
"bandwidth": 5,
"bidirectional": "ANY_REVERSE_ROUTE",
"customerId": 3,
"id": "string",
"maxCost": 5,
"maxHops": 7,
"maxLatency": 3,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"reverseBandwidth": 5
},
{
"appId": "string",
"bandwidth": 6,
"bidirectional": "NO",
"customerId": 3,
"id": "string",
"maxCost": 4,
"maxHops": 7,
"maxLatency": 2,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"reverseBandwidth": 3
},
{
"appId": "string",
"bandwidth": 9,
"bidirectional": "NO",
"customerId": 9,
"id": "string",
"maxCost": 1,
"maxHops": 10,
"maxLatency": 4,
"name": "string",
"objectDescription": "string",
"objective": "DISTANCE",
"reverseBandwidth": 9
},
{
"appId": "string",
"bandwidth": 2,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 7,
"id": "string",
"maxCost": 4,
"maxHops": 6,
"maxLatency": 6,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"reverseBandwidth": 9
},
{
"appId": "string",
"bandwidth": 6,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 9,
"id": "string",
"maxCost": 6,
"maxHops": 1,
"maxLatency": 6,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"reverseBandwidth": 6
},
{
"appId": "string",
"bandwidth": 3,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 2,
"id": "string",
"maxCost": 7,
"maxHops": 9,
"maxLatency": 2,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"reverseBandwidth": 7
}
],
"endRow": 8,
"startRow": 3,
"status": 9,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createOduServices",
"description": "The parameters and request body are for method: createOduServices. 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": {
"appId": {
"type": "string"
},
"bandwidth": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"reverseBandwidth": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bandwidth": 7,
"bidirectional": "ASYMMETRIC_LOOSE",
"customerId": 8,
"id": "string",
"maxCost": 5,
"maxHops": 2,
"maxLatency": 6,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"reverseBandwidth": 3
},
"endRow": 7,
"startRow": 6,
"status": 7,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/odu-services/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getOduServices",
"description": "The parameters and request body are for method: getOduServices. 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": {
"appId": {
"type": "string"
},
"bandwidth": {
"type": "number"
},
"bidirectional": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"reverseBandwidth": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bandwidth": 9,
"bidirectional": "SYMMETRIC_STRICT",
"customerId": 6,
"id": "string",
"maxCost": 7,
"maxHops": 9,
"maxLatency": 7,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"reverseBandwidth": 2
},
"endRow": 6,
"startRow": 5,
"status": 1,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateOduServices",
"description": "The parameters and request body are for method: updateOduServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 7,
"startRow": 9,
"status": 8,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteOduServices",
"description": "The parameters and request body are for method: deleteOduServices. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 5,
"status": 1,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/optical-connectivity-constraint": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllOpticalConnectivityConstraint",
"description": "The parameters and request body are for method: getAllOpticalConnectivityConstraint. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"connectivityConstraint": {
"type": "object",
"properties": {
"capacity": {
"type": "object",
"properties": {
"capacityValue": {
"type": "object"
}
}
},
"connectivityDirection": {
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"timeRange": {
"type": "object"
}
}
},
"serviceLevel": {
"type": "string"
},
"serviceType": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"connectivityConstraint": {
"capacity": {
"capacityValue": {}
},
"connectivityDirection": "BIDIRECTIONAL",
"schedule": {
"timeRange": {}
},
"serviceLevel": "string",
"serviceType": "MULTIPOINT_CONNECTIVITY"
},
"id": "string",
"name": "string",
"objectDescription": "string"
}
],
"endRow": 7,
"startRow": 3,
"status": 6,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createOpticalConnectivityConstraint",
"description": "The parameters and request body are for method: createOpticalConnectivityConstraint. 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": {
"appId": {
"type": "string"
},
"connectivityConstraint": {
"type": "object",
"properties": {
"capacity": {
"type": "object",
"properties": {
"capacityValue": {
"type": "object"
}
}
},
"connectivityDirection": {
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"timeRange": {
"type": "object"
}
}
},
"serviceLevel": {
"type": "string"
},
"serviceType": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"connectivityConstraint": {
"capacity": {
"capacityValue": {}
},
"connectivityDirection": "BIDIRECTIONAL",
"schedule": {
"timeRange": {}
},
"serviceLevel": "string",
"serviceType": "POINT_TO_POINT_CONNECTIVITY"
},
"id": "string",
"name": "string",
"objectDescription": "string"
},
"endRow": 5,
"startRow": 5,
"status": 2,
"totalRows": 2
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/optical-connectivity-constraint/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getOpticalConnectivityConstraint",
"description": "The parameters and request body are for method: getOpticalConnectivityConstraint. 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": {
"appId": {
"type": "string"
},
"connectivityConstraint": {
"type": "object",
"properties": {
"capacity": {
"type": "object",
"properties": {
"capacityValue": {
"type": "object"
}
}
},
"connectivityDirection": {
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"timeRange": {
"type": "object"
}
}
},
"serviceLevel": {
"type": "string"
},
"serviceType": {
"type": "string"
}
}
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"connectivityConstraint": {
"capacity": {
"capacityValue": {}
},
"connectivityDirection": "UNDEFINED_OR_UNKNOWN",
"schedule": {
"timeRange": {}
},
"serviceLevel": "string",
"serviceType": "MULTIPOINT_CONNECTIVITY"
},
"id": "string",
"name": "string",
"objectDescription": "string"
},
"endRow": 9,
"startRow": 4,
"status": 7,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateOpticalConnectivityConstraint",
"description": "The parameters and request body are for method: updateOpticalConnectivityConstraint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 6,
"startRow": 5,
"status": 3,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteOpticalConnectivityConstraint",
"description": "The parameters and request body are for method: deleteOpticalConnectivityConstraint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 9,
"status": 9,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/optical-connectivity-service": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllOpticalConnectivityService",
"description": "The parameters and request body are for method: getAllOpticalConnectivityService. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"connectivityConstraintTemplateId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"resilienceConstraintTemplateIds": {
"type": "array",
"items": {
"type": "string"
}
},
"routingConstraintTemplateId": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
{
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
}
],
"endRow": 4,
"startRow": 10,
"status": 9,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createOpticalConnectivityService",
"description": "The parameters and request body are for method: createOpticalConnectivityService. 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": {
"appId": {
"type": "string"
},
"connectivityConstraintTemplateId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"resilienceConstraintTemplateIds": {
"type": "array",
"items": {
"type": "string"
}
},
"routingConstraintTemplateId": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
"endRow": 3,
"startRow": 10,
"status": 10,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/optical-connectivity-service/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getOpticalConnectivityService",
"description": "The parameters and request body are for method: getOpticalConnectivityService. 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": {
"appId": {
"type": "string"
},
"connectivityConstraintTemplateId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"resilienceConstraintTemplateIds": {
"type": "array",
"items": {
"type": "string"
}
},
"routingConstraintTemplateId": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"connectivityConstraintTemplateId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraintTemplateIds": [
"string",
"string"
],
"routingConstraintTemplateId": "string"
},
"endRow": 3,
"startRow": 2,
"status": 5,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateOpticalConnectivityService",
"description": "The parameters and request body are for method: updateOpticalConnectivityService. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 4,
"startRow": 6,
"status": 2,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteOpticalConnectivityService",
"description": "The parameters and request body are for method: deleteOpticalConnectivityService. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 1,
"startRow": 3,
"status": 10,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/optical-resilience-constraint": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllOpticalResilienceConstraint",
"description": "The parameters and request body are for method: getAllOpticalResilienceConstraint. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"resilienceConstraint": {
"type": "object",
"properties": {
"holdOffTime": {
"type": "number"
},
"isCoordinatedSwitchingBothEnds": {
"type": "boolean"
},
"isFrozen": {
"type": "boolean"
},
"isLockOut": {
"type": "boolean"
},
"maxSwitchTimes": {
"type": "number"
},
"resilienceType": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
},
"restorationPolicy": {
"type": "string"
}
}
},
"restorationCoordinateType": {
"type": "string"
},
"restorePriority": {
"type": "number"
},
"reversionMode": {
"type": "string"
},
"waitToRevertTime": {
"type": "number"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 1,
"isCoordinatedSwitchingBothEnds": false,
"isFrozen": true,
"isLockOut": false,
"maxSwitchTimes": 8,
"resilienceType": {
"protectionType": "NO_PROTECTON",
"restorationPolicy": "NA"
},
"restorationCoordinateType": "NO_COORDINATE",
"restorePriority": 9,
"reversionMode": "REVERTIVE",
"waitToRevertTime": 8
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 6,
"isCoordinatedSwitchingBothEnds": true,
"isFrozen": false,
"isLockOut": true,
"maxSwitchTimes": 2,
"resilienceType": {
"protectionType": "PERMANENT_ONE_PLUS_ONE_PROTECTION",
"restorationPolicy": "PER_DOMAIN_RESTORATION"
},
"restorationCoordinateType": "WAIT_FOR_NOTIFICATION",
"restorePriority": 5,
"reversionMode": "REVERTIVE",
"waitToRevertTime": 6
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 10,
"isCoordinatedSwitchingBothEnds": false,
"isFrozen": false,
"isLockOut": false,
"maxSwitchTimes": 2,
"resilienceType": {
"protectionType": "DYNAMIC_RESTORATION",
"restorationPolicy": "END_TO_END_RESTORATION"
},
"restorationCoordinateType": "NO_COORDINATE",
"restorePriority": 1,
"reversionMode": "NON_REVERTIVE",
"waitToRevertTime": 8
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 5,
"isCoordinatedSwitchingBothEnds": false,
"isFrozen": false,
"isLockOut": false,
"maxSwitchTimes": 8,
"resilienceType": {
"protectionType": "DYNAMIC_RESTORATION",
"restorationPolicy": "END_TO_END_RESTORATION"
},
"restorationCoordinateType": "HOLD_OFF_TIME",
"restorePriority": 4,
"reversionMode": "REVERTIVE",
"waitToRevertTime": 1
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 10,
"isCoordinatedSwitchingBothEnds": false,
"isFrozen": false,
"isLockOut": false,
"maxSwitchTimes": 9,
"resilienceType": {
"protectionType": "DYNAMIC_RESTORATION",
"restorationPolicy": "NA"
},
"restorationCoordinateType": "NO_COORDINATE",
"restorePriority": 2,
"reversionMode": "REVERTIVE",
"waitToRevertTime": 3
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 10,
"isCoordinatedSwitchingBothEnds": false,
"isFrozen": false,
"isLockOut": false,
"maxSwitchTimes": 1,
"resilienceType": {
"protectionType": "NO_PROTECTON",
"restorationPolicy": "END_TO_END_RESTORATION"
},
"restorationCoordinateType": "HOLD_OFF_TIME",
"restorePriority": 10,
"reversionMode": "REVERTIVE",
"waitToRevertTime": 6
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 4,
"isCoordinatedSwitchingBothEnds": true,
"isFrozen": false,
"isLockOut": true,
"maxSwitchTimes": 2,
"resilienceType": {
"protectionType": "NO_PROTECTON",
"restorationPolicy": "NA"
},
"restorationCoordinateType": "WAIT_FOR_NOTIFICATION",
"restorePriority": 2,
"reversionMode": "REVERTIVE",
"waitToRevertTime": 2
}
}
],
"endRow": 10,
"startRow": 4,
"status": 1,
"totalRows": 10
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createOpticalResilienceConstraint",
"description": "The parameters and request body are for method: createOpticalResilienceConstraint. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"resilienceConstraint": {
"type": "object",
"properties": {
"holdOffTime": {
"type": "number"
},
"isCoordinatedSwitchingBothEnds": {
"type": "boolean"
},
"isFrozen": {
"type": "boolean"
},
"isLockOut": {
"type": "boolean"
},
"maxSwitchTimes": {
"type": "number"
},
"resilienceType": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
},
"restorationPolicy": {
"type": "string"
}
}
},
"restorationCoordinateType": {
"type": "string"
},
"restorePriority": {
"type": "number"
},
"reversionMode": {
"type": "string"
},
"waitToRevertTime": {
"type": "number"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 8,
"isCoordinatedSwitchingBothEnds": false,
"isFrozen": false,
"isLockOut": false,
"maxSwitchTimes": 10,
"resilienceType": {
"protectionType": "PERMANENT_ONE_PLUS_ONE_PROTECTION",
"restorationPolicy": "END_TO_END_RESTORATION"
},
"restorationCoordinateType": "NO_COORDINATE",
"restorePriority": 10,
"reversionMode": "NON_REVERTIVE",
"waitToRevertTime": 6
}
},
"endRow": 1,
"startRow": 2,
"status": 5,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/optical-resilience-constraint/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getOpticalResilienceConstraint",
"description": "The parameters and request body are for method: getOpticalResilienceConstraint. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"resilienceConstraint": {
"type": "object",
"properties": {
"holdOffTime": {
"type": "number"
},
"isCoordinatedSwitchingBothEnds": {
"type": "boolean"
},
"isFrozen": {
"type": "boolean"
},
"isLockOut": {
"type": "boolean"
},
"maxSwitchTimes": {
"type": "number"
},
"resilienceType": {
"type": "object",
"properties": {
"protectionType": {
"type": "string"
},
"restorationPolicy": {
"type": "string"
}
}
},
"restorationCoordinateType": {
"type": "string"
},
"restorePriority": {
"type": "number"
},
"reversionMode": {
"type": "string"
},
"waitToRevertTime": {
"type": "number"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"resilienceConstraint": {
"holdOffTime": 8,
"isCoordinatedSwitchingBothEnds": true,
"isFrozen": true,
"isLockOut": false,
"maxSwitchTimes": 1,
"resilienceType": {
"protectionType": "PRE_COMPUTED_RESTORATION",
"restorationPolicy": "PER_DOMAIN_RESTORATION"
},
"restorationCoordinateType": "WAIT_FOR_NOTIFICATION",
"restorePriority": 1,
"reversionMode": "NON_REVERTIVE",
"waitToRevertTime": 6
}
},
"endRow": 6,
"startRow": 3,
"status": 2,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateOpticalResilienceConstraint",
"description": "The parameters and request body are for method: updateOpticalResilienceConstraint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 2,
"startRow": 7,
"status": 8,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteOpticalResilienceConstraint",
"description": "The parameters and request body are for method: deleteOpticalResilienceConstraint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 9,
"startRow": 1,
"status": 2,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/optical-routing-constraint": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllOpticalRoutingConstraint",
"description": "The parameters and request body are for method: getAllOpticalRoutingConstraint. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"routingConstraint": {
"type": "object",
"properties": {
"costCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"costAlgorithm": {
"type": "string"
},
"costName": {
"type": "string"
},
"costValue": {
"type": "string"
}
}
}
},
"diversityPolicy": {
"type": "string"
},
"isExclusive": {
"type": "boolean"
},
"latencyCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fixedLatencyCharacteristic": {
"type": "string"
},
"jitterCharacteristic": {
"type": "string"
},
"queingLatencyCharacteristic": {
"type": "string"
},
"trafficPropertyName": {
"type": "string"
},
"wanderCharacteristic": {
"type": "string"
}
}
}
},
"riskDiversityCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"riskCharacteristicName": {
"type": "string"
},
"riskIdentifierList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"routeDirection": {
"type": "string"
},
"routeObjectiveFunction": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SNG",
"isExclusive": true,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string"
]
}
],
"routeDirection": "UNDEFINED_OR_UNKNOWN",
"routeObjectiveFunction": "MIN_WORK_ROUTE_COST"
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "NODE",
"isExclusive": false,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"routeDirection": "UNDEFINED_OR_UNKNOWN",
"routeObjectiveFunction": "MIN_WORK_ROUTE_COST"
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SRNG",
"isExclusive": false,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"routeDirection": "UNIDIRECTIONAL",
"routeObjectiveFunction": "MIN_WORK_ROUTE_COST"
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SNG",
"isExclusive": true,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"routeDirection": "BIDIRECTIONAL",
"routeObjectiveFunction": "MIN_SUM_OF_WORK_AND_PROTECTION_ROUTE_HOP"
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SNG",
"isExclusive": false,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string"
]
}
],
"routeDirection": "UNDEFINED_OR_UNKNOWN",
"routeObjectiveFunction": "LOAD_BALANCE_MAX_UNUSED_CAPACITY"
}
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SRLG",
"isExclusive": true,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string"
]
}
],
"routeDirection": "UNIDIRECTIONAL",
"routeObjectiveFunction": "MIN_WORK_ROUTE_HOP"
}
}
],
"endRow": 3,
"startRow": 9,
"status": 1,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createOpticalRoutingConstraint",
"description": "The parameters and request body are for method: createOpticalRoutingConstraint. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"routingConstraint": {
"type": "object",
"properties": {
"costCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"costAlgorithm": {
"type": "string"
},
"costName": {
"type": "string"
},
"costValue": {
"type": "string"
}
}
}
},
"diversityPolicy": {
"type": "string"
},
"isExclusive": {
"type": "boolean"
},
"latencyCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fixedLatencyCharacteristic": {
"type": "string"
},
"jitterCharacteristic": {
"type": "string"
},
"queingLatencyCharacteristic": {
"type": "string"
},
"trafficPropertyName": {
"type": "string"
},
"wanderCharacteristic": {
"type": "string"
}
}
}
},
"riskDiversityCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"riskCharacteristicName": {
"type": "string"
},
"riskIdentifierList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"routeDirection": {
"type": "string"
},
"routeObjectiveFunction": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SRNG",
"isExclusive": true,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string"
]
}
],
"routeDirection": "UNDEFINED_OR_UNKNOWN",
"routeObjectiveFunction": "MIN_WORK_ROUTE_HOP"
}
},
"endRow": 2,
"startRow": 5,
"status": 1,
"totalRows": 8
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/optical-routing-constraint/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getOpticalRoutingConstraint",
"description": "The parameters and request body are for method: getOpticalRoutingConstraint. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"routingConstraint": {
"type": "object",
"properties": {
"costCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"costAlgorithm": {
"type": "string"
},
"costName": {
"type": "string"
},
"costValue": {
"type": "string"
}
}
}
},
"diversityPolicy": {
"type": "string"
},
"isExclusive": {
"type": "boolean"
},
"latencyCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fixedLatencyCharacteristic": {
"type": "string"
},
"jitterCharacteristic": {
"type": "string"
},
"queingLatencyCharacteristic": {
"type": "string"
},
"trafficPropertyName": {
"type": "string"
},
"wanderCharacteristic": {
"type": "string"
}
}
}
},
"riskDiversityCharacteristic": {
"type": "array",
"items": {
"type": "object",
"properties": {
"riskCharacteristicName": {
"type": "string"
},
"riskIdentifierList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"routeDirection": {
"type": "string"
},
"routeObjectiveFunction": {
"type": "string"
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"routingConstraint": {
"costCharacteristic": [
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
},
{
"costAlgorithm": "string",
"costName": "string",
"costValue": "string"
}
],
"diversityPolicy": "SNG",
"isExclusive": false,
"latencyCharacteristic": [
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
},
{
"fixedLatencyCharacteristic": "string",
"jitterCharacteristic": "string",
"queingLatencyCharacteristic": "string",
"trafficPropertyName": "string",
"wanderCharacteristic": "string"
}
],
"riskDiversityCharacteristic": [
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"riskCharacteristicName": "string",
"riskIdentifierList": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"routeDirection": "UNIDIRECTIONAL",
"routeObjectiveFunction": "MIN_WORK_ROUTE_LATENCY"
}
},
"endRow": 3,
"startRow": 2,
"status": 2,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateOpticalRoutingConstraint",
"description": "The parameters and request body are for method: updateOpticalRoutingConstraint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 5,
"startRow": 5,
"status": 10,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteOpticalRoutingConstraint",
"description": "The parameters and request body are for method: deleteOpticalRoutingConstraint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 7,
"startRow": 4,
"status": 2,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/path-profiles": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllPathProfiles",
"description": "The parameters and request body are for method: getAllPathProfiles. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"bandwidthStrategy": {
"type": "string"
},
"bidirection": {
"type": "string"
},
"bwSplitMonitoringTime": {
"type": "number"
},
"bwSplitSupported": {
"type": "boolean"
},
"bwSplitThreshold": {
"type": "number"
},
"bwSplitWorkflowName": {
"type": "string"
},
"controlRerouteStrategy": {
"type": "string"
},
"disjoint": {
"type": "string"
},
"excludeRouteObjects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
}
},
"explicitRouteStrategy": {
"type": "string"
},
"explicitRouteStrategyEcmpPreference": {
"type": "string"
},
"id": {
"type": "string"
},
"includeRouteObjects": {
"type": "object"
},
"latencyThreshold": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"maxTeMetric": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"profileId": {
"type": "number"
},
"sidProtectionStrategy": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"bandwidthStrategy": "STANDARD",
"bidirection": "SYMMETRIC_LOOSE",
"bwSplitMonitoringTime": 4,
"bwSplitSupported": true,
"bwSplitThreshold": 5,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "STRICT",
"disjoint": "NODE_LOOSE",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "LOOSE_HOP_ANYCAST_PREFERRED",
"explicitRouteStrategyEcmpPreference": "ADJACENCY_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 5,
"maxCost": 10,
"maxHops": 10,
"maxLatency": 10,
"maxTeMetric": 5,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"profileId": 5,
"sidProtectionStrategy": "PROTECTED_ONLY"
},
{
"appId": "string",
"bandwidthStrategy": "TELEMETRY",
"bidirection": "NO",
"bwSplitMonitoringTime": 8,
"bwSplitSupported": true,
"bwSplitThreshold": 9,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "LOOSE",
"disjoint": "LINK_STRICT",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "STANDARD_BSID_PREFERRED",
"explicitRouteStrategyEcmpPreference": "NODE_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 4,
"maxCost": 6,
"maxHops": 9,
"maxLatency": 7,
"maxTeMetric": 5,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"profileId": 7,
"sidProtectionStrategy": "UNPROTECTED_ONLY"
},
{
"appId": "string",
"bandwidthStrategy": "STANDARD",
"bidirection": "SYMMETRIC_LOOSE",
"bwSplitMonitoringTime": 3,
"bwSplitSupported": true,
"bwSplitThreshold": 6,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "STRICT",
"disjoint": "LINK_LOOSE",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "LOOSE_HOP",
"explicitRouteStrategyEcmpPreference": "ADJACENCY_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 1,
"maxCost": 1,
"maxHops": 9,
"maxLatency": 3,
"maxTeMetric": 9,
"name": "string",
"objectDescription": "string",
"objective": "STAR_WEIGHT",
"profileId": 4,
"sidProtectionStrategy": "PROTECTED_ONLY"
},
{
"appId": "string",
"bandwidthStrategy": "TELEMETRY",
"bidirection": "ANY_REVERSE_ROUTE",
"bwSplitMonitoringTime": 1,
"bwSplitSupported": true,
"bwSplitThreshold": 2,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "STRICT",
"disjoint": "LINK_STRICT_AND_SRLG",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "ECMP",
"explicitRouteStrategyEcmpPreference": "NODE_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 5,
"maxCost": 7,
"maxHops": 1,
"maxLatency": 1,
"maxTeMetric": 2,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"profileId": 2,
"sidProtectionStrategy": "STANDARD"
},
{
"appId": "string",
"bandwidthStrategy": "STANDARD",
"bidirection": "ASYMMETRIC_LOOSE",
"bwSplitMonitoringTime": 3,
"bwSplitSupported": false,
"bwSplitThreshold": 7,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "LOOSE",
"disjoint": "NODE_STRICT_AND_SRLG",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "LOOSE_HOP_ANYCAST_PREFERRED",
"explicitRouteStrategyEcmpPreference": "NODE_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 5,
"maxCost": 1,
"maxHops": 7,
"maxLatency": 2,
"maxTeMetric": 9,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"profileId": 2,
"sidProtectionStrategy": "UNPROTECTED_PREFERRED"
},
{
"appId": "string",
"bandwidthStrategy": "STANDARD",
"bidirection": "ASYMMETRIC_LOOSE",
"bwSplitMonitoringTime": 3,
"bwSplitSupported": true,
"bwSplitThreshold": 7,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "STANDARD",
"disjoint": "NODE_STRICT_AND_SRLG",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "STANDARD",
"explicitRouteStrategyEcmpPreference": "ADJACENCY_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 10,
"maxCost": 9,
"maxHops": 7,
"maxLatency": 7,
"maxTeMetric": 1,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"profileId": 4,
"sidProtectionStrategy": "UNPROTECTED_ONLY"
},
{
"appId": "string",
"bandwidthStrategy": "TELEMETRY",
"bidirection": "SYMMETRIC_STRICT",
"bwSplitMonitoringTime": 5,
"bwSplitSupported": true,
"bwSplitThreshold": 7,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "STRICT",
"disjoint": "LINK_LOOSE",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "STANDARD_BSID_PREFERRED",
"explicitRouteStrategyEcmpPreference": "NODE_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 9,
"maxCost": 7,
"maxHops": 9,
"maxLatency": 10,
"maxTeMetric": 2,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"profileId": 7,
"sidProtectionStrategy": "UNPROTECTED_ONLY"
},
{
"appId": "string",
"bandwidthStrategy": "TELEMETRY",
"bidirection": "ANY_REVERSE_ROUTE",
"bwSplitMonitoringTime": 10,
"bwSplitSupported": true,
"bwSplitThreshold": 6,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "STRICT",
"disjoint": "NO",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "STANDARD",
"explicitRouteStrategyEcmpPreference": "ADJACENCY_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 6,
"maxCost": 9,
"maxHops": 5,
"maxLatency": 3,
"maxTeMetric": 8,
"name": "string",
"objectDescription": "string",
"objective": "HOPS",
"profileId": 3,
"sidProtectionStrategy": "UNPROTECTED_PREFERRED"
},
{
"appId": "string",
"bandwidthStrategy": "STANDARD",
"bidirection": "ASYMMETRIC_LOOSE",
"bwSplitMonitoringTime": 6,
"bwSplitSupported": true,
"bwSplitThreshold": 4,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "LOOSE",
"disjoint": "NODE_LOOSE",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "STANDARD",
"explicitRouteStrategyEcmpPreference": "NODE_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 7,
"maxCost": 8,
"maxHops": 4,
"maxLatency": 6,
"maxTeMetric": 5,
"name": "string",
"objectDescription": "string",
"objective": "TE_METRIC",
"profileId": 6,
"sidProtectionStrategy": "UNPROTECTED_ONLY"
}
],
"endRow": 8,
"startRow": 7,
"status": 4,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createPathProfiles",
"description": "The parameters and request body are for method: createPathProfiles. 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": {
"appId": {
"type": "string"
},
"bandwidthStrategy": {
"type": "string"
},
"bidirection": {
"type": "string"
},
"bwSplitMonitoringTime": {
"type": "number"
},
"bwSplitSupported": {
"type": "boolean"
},
"bwSplitThreshold": {
"type": "number"
},
"bwSplitWorkflowName": {
"type": "string"
},
"controlRerouteStrategy": {
"type": "string"
},
"disjoint": {
"type": "string"
},
"excludeRouteObjects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
}
},
"explicitRouteStrategy": {
"type": "string"
},
"explicitRouteStrategyEcmpPreference": {
"type": "string"
},
"id": {
"type": "string"
},
"includeRouteObjects": {
"type": "object"
},
"latencyThreshold": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"maxTeMetric": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"profileId": {
"type": "number"
},
"sidProtectionStrategy": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bandwidthStrategy": "TELEMETRY",
"bidirection": "ANY_REVERSE_ROUTE",
"bwSplitMonitoringTime": 4,
"bwSplitSupported": false,
"bwSplitThreshold": 8,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "LOOSE",
"disjoint": "NODE_STRICT_AND_SRLG",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "STANDARD_BSID_PREFERRED",
"explicitRouteStrategyEcmpPreference": "ADJACENCY_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 6,
"maxCost": 7,
"maxHops": 5,
"maxLatency": 1,
"maxTeMetric": 4,
"name": "string",
"objectDescription": "string",
"objective": "COST",
"profileId": 1,
"sidProtectionStrategy": "STANDARD"
},
"endRow": 8,
"startRow": 8,
"status": 8,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/path-profiles/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getPathProfiles",
"description": "The parameters and request body are for method: getPathProfiles. 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": {
"appId": {
"type": "string"
},
"bandwidthStrategy": {
"type": "string"
},
"bidirection": {
"type": "string"
},
"bwSplitMonitoringTime": {
"type": "number"
},
"bwSplitSupported": {
"type": "boolean"
},
"bwSplitThreshold": {
"type": "number"
},
"bwSplitWorkflowName": {
"type": "string"
},
"controlRerouteStrategy": {
"type": "string"
},
"disjoint": {
"type": "string"
},
"excludeRouteObjects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
}
},
"explicitRouteStrategy": {
"type": "string"
},
"explicitRouteStrategyEcmpPreference": {
"type": "string"
},
"id": {
"type": "string"
},
"includeRouteObjects": {
"type": "object"
},
"latencyThreshold": {
"type": "number"
},
"maxCost": {
"type": "number"
},
"maxHops": {
"type": "number"
},
"maxLatency": {
"type": "number"
},
"maxTeMetric": {
"type": "number"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"objective": {
"type": "string"
},
"profileId": {
"type": "number"
},
"sidProtectionStrategy": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"bandwidthStrategy": "STANDARD",
"bidirection": "ASYMMETRIC_STRICT",
"bwSplitMonitoringTime": 7,
"bwSplitSupported": false,
"bwSplitThreshold": 2,
"bwSplitWorkflowName": "string",
"controlRerouteStrategy": "LOOSE",
"disjoint": "NODE_LOOSE",
"excludeRouteObjects": [
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
},
{
"ipv4Address": {},
"ipv6Address": {}
}
],
"explicitRouteStrategy": "COMPRESSED",
"explicitRouteStrategyEcmpPreference": "ADJACENCY_SID",
"id": "string",
"includeRouteObjects": {},
"latencyThreshold": 2,
"maxCost": 10,
"maxHops": 8,
"maxLatency": 5,
"maxTeMetric": 7,
"name": "string",
"objectDescription": "string",
"objective": "LATENCY",
"profileId": 9,
"sidProtectionStrategy": "UNPROTECTED_PREFERRED"
},
"endRow": 10,
"startRow": 6,
"status": 1,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updatePathProfiles",
"description": "The parameters and request body are for method: updatePathProfiles. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 8,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deletePathProfiles",
"description": "The parameters and request body are for method: deletePathProfiles. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 4,
"startRow": 2,
"status": 8,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/qos": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllQos",
"description": "The parameters and request body are for method: getAllQos. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressQueueOverride": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"id": {
"type": "string"
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressQueueOverride": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"qosProfile": {
"type": "number"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 6,
"cir": 9,
"id": 10,
"mbs": 2,
"pir": 9,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 2,
"cir": 5,
"id": 9,
"mbs": 2,
"pir": 5,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 3,
"id": 3,
"mbs": 1,
"pir": 4,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 3,
"cir": 3,
"id": 4,
"mbs": 4,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 9,
"id": 6,
"mbs": 5,
"pir": 1,
"queueType": "Queue",
"rateType": "kbps"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 3,
"cir": 10,
"id": 4,
"mbs": 7,
"pir": 10,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 10,
"id": 9,
"mbs": 9,
"pir": 7,
"queueType": "Policer",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 2
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 3,
"cir": 6,
"id": 8,
"mbs": 3,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 4,
"id": 5,
"mbs": 6,
"pir": 8,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 2,
"id": 4,
"mbs": 10,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 7,
"cir": 7,
"id": 1,
"mbs": 9,
"pir": 3,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 1,
"id": 7,
"mbs": 7,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 5,
"cir": 5,
"id": 9,
"mbs": 5,
"pir": 7,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 5,
"id": 9,
"mbs": 6,
"pir": 7,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 2,
"id": 10,
"mbs": 5,
"pir": 3,
"queueType": "Queue",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 10
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 5,
"cir": 2,
"id": 4,
"mbs": 3,
"pir": 1,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 1,
"id": 10,
"mbs": 7,
"pir": 1,
"queueType": "Policer",
"rateType": "kbps"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 5,
"cir": 2,
"id": 10,
"mbs": 5,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 6,
"id": 10,
"mbs": 8,
"pir": 6,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 10
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 2,
"cir": 6,
"id": 2,
"mbs": 10,
"pir": 9,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 10,
"cir": 5,
"id": 6,
"mbs": 3,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 7,
"id": 5,
"mbs": 4,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 5,
"id": 1,
"mbs": 6,
"pir": 1,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 4,
"cir": 6,
"id": 4,
"mbs": 8,
"pir": 5,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 10,
"id": 6,
"mbs": 10,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 10,
"cir": 4,
"id": 7,
"mbs": 5,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 6,
"id": 5,
"mbs": 2,
"pir": 9,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 4,
"id": 8,
"mbs": 5,
"pir": 7,
"queueType": "Queue",
"rateType": "kbps"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 2,
"cir": 3,
"id": 3,
"mbs": 1,
"pir": 10,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 7,
"id": 5,
"mbs": 10,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 10,
"id": 3,
"mbs": 3,
"pir": 5,
"queueType": "Policer",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 4
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 6,
"cir": 9,
"id": 1,
"mbs": 4,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 10,
"cir": 9,
"id": 7,
"mbs": 6,
"pir": 7,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 6,
"id": 2,
"mbs": 9,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 10,
"cir": 1,
"id": 9,
"mbs": 4,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 7
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 2,
"cir": 5,
"id": 6,
"mbs": 4,
"pir": 6,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 5,
"id": 8,
"mbs": 1,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 5,
"id": 6,
"mbs": 10,
"pir": 4,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 10,
"id": 1,
"mbs": 8,
"pir": 10,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 3,
"id": 4,
"mbs": 10,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 10,
"cir": 6,
"id": 8,
"mbs": 1,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 6,
"id": 9,
"mbs": 8,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 2,
"id": 8,
"mbs": 4,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 8,
"id": 10,
"mbs": 10,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 4,
"cir": 2,
"id": 3,
"mbs": 9,
"pir": 8,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 5,
"id": 2,
"mbs": 7,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 10,
"id": 8,
"mbs": 1,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 4,
"id": 8,
"mbs": 3,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 7
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 8,
"cir": 1,
"id": 7,
"mbs": 9,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 3,
"id": 5,
"mbs": 3,
"pir": 4,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 9,
"id": 4,
"mbs": 4,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 4,
"cir": 8,
"id": 4,
"mbs": 9,
"pir": 2,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 10,
"cir": 2,
"id": 9,
"mbs": 5,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 2,
"id": 7,
"mbs": 6,
"pir": 3,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 1,
"cir": 6,
"id": 3,
"mbs": 3,
"pir": 2,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 1,
"id": 5,
"mbs": 10,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 7,
"id": 8,
"mbs": 10,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 3,
"id": 6,
"mbs": 3,
"pir": 10,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 9,
"id": 5,
"mbs": 4,
"pir": 3,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 5,
"id": 10,
"mbs": 4,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 7,
"id": 1,
"mbs": 8,
"pir": 10,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 8
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 1,
"cir": 8,
"id": 2,
"mbs": 4,
"pir": 3,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 3,
"id": 10,
"mbs": 5,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 5,
"cir": 5,
"id": 10,
"mbs": 2,
"pir": 4,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 6,
"id": 7,
"mbs": 3,
"pir": 8,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 2,
"id": 7,
"mbs": 4,
"pir": 4,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 3,
"id": 8,
"mbs": 3,
"pir": 2,
"queueType": "Policer",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 6,
"cir": 6,
"id": 9,
"mbs": 5,
"pir": 9,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 2,
"id": 9,
"mbs": 5,
"pir": 1,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 6,
"id": 1,
"mbs": 9,
"pir": 6,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 7,
"id": 2,
"mbs": 8,
"pir": 5,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 6,
"id": 3,
"mbs": 4,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 7,
"id": 10,
"mbs": 10,
"pir": 9,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 8,
"id": 1,
"mbs": 2,
"pir": 8,
"queueType": "Queue",
"rateType": "percent"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 7
},
{
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 8,
"cir": 5,
"id": 7,
"mbs": 5,
"pir": 4,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 5,
"id": 3,
"mbs": 2,
"pir": 8,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 2,
"id": 6,
"mbs": 3,
"pir": 6,
"queueType": "Policer",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 3,
"cir": 4,
"id": 2,
"mbs": 7,
"pir": 7,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 10,
"id": 3,
"mbs": 3,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 6,
"id": 8,
"mbs": 9,
"pir": 7,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 3,
"id": 6,
"mbs": 10,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 5,
"cir": 6,
"id": 10,
"mbs": 4,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 6,
"id": 1,
"mbs": 2,
"pir": 4,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 3,
"cir": 4,
"id": 6,
"mbs": 10,
"pir": 3,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 4
}
],
"endRow": 6,
"startRow": 6,
"status": 3,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createQos",
"description": "The parameters and request body are for method: createQos. 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": {
"appId": {
"type": "string"
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressQueueOverride": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"id": {
"type": "string"
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressQueueOverride": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"qosProfile": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 6,
"cir": 1,
"id": 7,
"mbs": 2,
"pir": 3,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 8,
"cir": 7,
"id": 6,
"mbs": 5,
"pir": 7,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 8,
"id": 7,
"mbs": 1,
"pir": 9,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 2,
"cir": 3,
"id": 7,
"mbs": 4,
"pir": 8,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 5,
"id": 10,
"mbs": 2,
"pir": 4,
"queueType": "Queue",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 10,
"id": 8,
"mbs": 8,
"pir": 9,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 8,
"id": 7,
"mbs": 6,
"pir": 8,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 4,
"cir": 2,
"id": 8,
"mbs": 10,
"pir": 5,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 9,
"cir": 8,
"id": 3,
"mbs": 2,
"pir": 1,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 4,
"cir": 10,
"id": 2,
"mbs": 1,
"pir": 10,
"queueType": "Queue",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 4,
"cir": 3,
"id": 5,
"mbs": 10,
"pir": 2,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 4
},
"endRow": 2,
"startRow": 7,
"status": 9,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/qos-policies": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllQosPolicies",
"description": "The parameters and request body are for method: getAllQosPolicies. 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": "object",
"properties": {
"ipAddress": {
"type": "string"
},
"policyIdentifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"identifier": {
"type": "string"
},
"policyType": {
"type": "string"
}
}
}
},
"siteName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
},
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
},
{
"ipAddress": "string",
"policyIdentifiers": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"siteName": "string"
}
],
"endRow": 1,
"startRow": 4,
"status": 10,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/qos-policies/{neId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getQosPolicies",
"description": "The parameters and request body are for method: getQosPolicies. 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": "object",
"properties": {
"description": {
"type": "string"
},
"identifier": {
"type": "string"
},
"policyType": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"description": "string",
"identifier": "string",
"policyType": "string"
}
],
"endRow": 3,
"startRow": 1,
"status": 10,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/qos/{templateId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getQos",
"description": "The parameters and request body are for method: getQos. 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": {
"appId": {
"type": "string"
},
"egressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"egressQueueOverride": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"id": {
"type": "string"
},
"ingressParam": {
"type": "object",
"properties": {
"tier1Scheduler": {
"type": "object",
"properties": {
"scheduler": {
"type": "object"
}
}
}
}
},
"ingressQueueOverride": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cbs": {
"type": "number"
},
"cir": {
"type": "number"
},
"id": {
"type": "number"
},
"mbs": {
"type": "number"
},
"pir": {
"type": "number"
},
"queueType": {
"type": "string"
},
"rateType": {
"type": "string"
}
}
}
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"qosProfile": {
"type": "number"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"egressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"egressQueueOverride": [
{
"cbs": 5,
"cir": 3,
"id": 2,
"mbs": 10,
"pir": 4,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 8,
"cir": 1,
"id": 6,
"mbs": 8,
"pir": 6,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 2,
"cir": 3,
"id": 10,
"mbs": 7,
"pir": 9,
"queueType": "Policer",
"rateType": "percent"
},
{
"cbs": 6,
"cir": 9,
"id": 9,
"mbs": 5,
"pir": 2,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 1,
"cir": 8,
"id": 5,
"mbs": 1,
"pir": 6,
"queueType": "Queue",
"rateType": "kbps"
},
{
"cbs": 6,
"cir": 2,
"id": 1,
"mbs": 4,
"pir": 6,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 7,
"id": 1,
"mbs": 7,
"pir": 2,
"queueType": "Policer",
"rateType": "kbps"
},
{
"cbs": 9,
"cir": 8,
"id": 4,
"mbs": 4,
"pir": 2,
"queueType": "Queue",
"rateType": "percent"
}
],
"id": "string",
"ingressParam": {
"tier1Scheduler": {
"scheduler": {}
}
},
"ingressQueueOverride": [
{
"cbs": 8,
"cir": 1,
"id": 5,
"mbs": 9,
"pir": 7,
"queueType": "Queue",
"rateType": "kbps"
}
],
"name": "string",
"objectDescription": "string",
"qosProfile": 6
},
"endRow": 6,
"startRow": 3,
"status": 5,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateQos",
"description": "The parameters and request body are for method: updateQos. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 6,
"startRow": 7,
"status": 5,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteQos",
"description": "The parameters and request body are for method: deleteQos. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 6,
"startRow": 7,
"status": 7,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/router-id-system-id-mapping": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllRouterIdSystemIdMappings",
"description": "The parameters and request body are for method: getAllRouterIdSystemIdMappings. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"pccAddress": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"routerInfos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asNumber": {
"type": "object",
"properties": {
"uint32": {
"type": "number"
}
}
},
"bgpLsId": {
"type": "number"
},
"dcIdentifier": {
"type": "number"
},
"networkIdentifier": {
"type": "object",
"properties": {
"uint32": {
"type": "number"
}
}
},
"protocol": {
"type": "string"
},
"routerId": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"systemId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"systemName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 9
},
"bgpLsId": 10,
"dcIdentifier": 4,
"networkIdentifier": {
"uint32": 7
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 6,
"dcIdentifier": 2,
"networkIdentifier": {
"uint32": 1
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 9
},
"bgpLsId": 9,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 1
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 4,
"dcIdentifier": 3,
"networkIdentifier": {
"uint32": 3
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 2
},
"bgpLsId": 7,
"dcIdentifier": 4,
"networkIdentifier": {
"uint32": 2
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 1,
"dcIdentifier": 1,
"networkIdentifier": {
"uint32": 7
},
"protocol": "BGP",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 8
},
"bgpLsId": 2,
"dcIdentifier": 5,
"networkIdentifier": {
"uint32": 6
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 7,
"dcIdentifier": 2,
"networkIdentifier": {
"uint32": 6
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 5,
"dcIdentifier": 7,
"networkIdentifier": {
"uint32": 5
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 5,
"dcIdentifier": 9,
"networkIdentifier": {
"uint32": 6
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 8
},
"bgpLsId": 4,
"dcIdentifier": 7,
"networkIdentifier": {
"uint32": 4
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 2,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 1
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 5
},
"bgpLsId": 6,
"dcIdentifier": 9,
"networkIdentifier": {
"uint32": 5
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 4
},
"bgpLsId": 3,
"dcIdentifier": 4,
"networkIdentifier": {
"uint32": 10
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 7
},
"bgpLsId": 2,
"dcIdentifier": 8,
"networkIdentifier": {
"uint32": 3
},
"protocol": "BGP",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 7
},
"bgpLsId": 1,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 9
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 3
},
"bgpLsId": 5,
"dcIdentifier": 4,
"networkIdentifier": {
"uint32": 2
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 9
},
"bgpLsId": 7,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 10
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 9
},
"bgpLsId": 9,
"dcIdentifier": 6,
"networkIdentifier": {
"uint32": 10
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 10,
"dcIdentifier": 7,
"networkIdentifier": {
"uint32": 2
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 3,
"dcIdentifier": 3,
"networkIdentifier": {
"uint32": 6
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 4
},
"bgpLsId": 6,
"dcIdentifier": 5,
"networkIdentifier": {
"uint32": 8
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 9
},
"bgpLsId": 7,
"dcIdentifier": 8,
"networkIdentifier": {
"uint32": 7
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 5,
"dcIdentifier": 1,
"networkIdentifier": {
"uint32": 8
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 10,
"dcIdentifier": 9,
"networkIdentifier": {
"uint32": 9
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 2,
"dcIdentifier": 8,
"networkIdentifier": {
"uint32": 3
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 8
},
"bgpLsId": 2,
"dcIdentifier": 5,
"networkIdentifier": {
"uint32": 10
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 2
},
"bgpLsId": 6,
"dcIdentifier": 9,
"networkIdentifier": {
"uint32": 3
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 9,
"dcIdentifier": 8,
"networkIdentifier": {
"uint32": 9
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 2,
"dcIdentifier": 9,
"networkIdentifier": {
"uint32": 7
},
"protocol": "BGP",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 8
},
"bgpLsId": 3,
"dcIdentifier": 1,
"networkIdentifier": {
"uint32": 6
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 9,
"dcIdentifier": 3,
"networkIdentifier": {
"uint32": 1
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 8
},
"bgpLsId": 1,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 8
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 2,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 6
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 4
},
"bgpLsId": 8,
"dcIdentifier": 6,
"networkIdentifier": {
"uint32": 5
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 2
},
"bgpLsId": 1,
"dcIdentifier": 7,
"networkIdentifier": {
"uint32": 4
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 10,
"dcIdentifier": 10,
"networkIdentifier": {
"uint32": 5
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 4
},
"bgpLsId": 10,
"dcIdentifier": 6,
"networkIdentifier": {
"uint32": 7
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 2
},
"bgpLsId": 2,
"dcIdentifier": 1,
"networkIdentifier": {
"uint32": 5
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 7,
"dcIdentifier": 5,
"networkIdentifier": {
"uint32": 3
},
"protocol": "ISIS",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
}
],
"endRow": 2,
"startRow": 3,
"status": 7,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createRouterIdSystemIdMapping",
"description": "The parameters and request body are for method: createRouterIdSystemIdMapping. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"pccAddress": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"routerInfos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asNumber": {
"type": "object",
"properties": {
"uint32": {
"type": "number"
}
}
},
"bgpLsId": {
"type": "number"
},
"dcIdentifier": {
"type": "number"
},
"networkIdentifier": {
"type": "object",
"properties": {
"uint32": {
"type": "number"
}
}
},
"protocol": {
"type": "string"
},
"routerId": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"systemId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"systemName": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 3,
"dcIdentifier": 8,
"networkIdentifier": {
"uint32": 2
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 1
},
"bgpLsId": 7,
"dcIdentifier": 2,
"networkIdentifier": {
"uint32": 6
},
"protocol": "ANY",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 8
},
"bgpLsId": 2,
"dcIdentifier": 4,
"networkIdentifier": {
"uint32": 4
},
"protocol": "BGP",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 7,
"dcIdentifier": 5,
"networkIdentifier": {
"uint32": 2
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
"endRow": 4,
"startRow": 9,
"status": 6,
"totalRows": 7
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/router-id-system-id-mapping/{policyId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getRouterIdSystemIdMapping",
"description": "The parameters and request body are for method: getRouterIdSystemIdMapping. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"pccAddress": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"routerInfos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asNumber": {
"type": "object",
"properties": {
"uint32": {
"type": "number"
}
}
},
"bgpLsId": {
"type": "number"
},
"dcIdentifier": {
"type": "number"
},
"networkIdentifier": {
"type": "object",
"properties": {
"uint32": {
"type": "number"
}
}
},
"protocol": {
"type": "string"
},
"routerId": {
"type": "object",
"properties": {
"string": {
"type": "string"
}
}
}
}
}
},
"systemId": {
"type": "object",
"properties": {
"ipv4Address": {
"type": "object"
},
"ipv6Address": {
"type": "object"
}
}
},
"systemName": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"pccAddress": {
"ipv4Address": {},
"ipv6Address": {}
},
"routerInfos": [
{
"asNumber": {
"uint32": 3
},
"bgpLsId": 7,
"dcIdentifier": 8,
"networkIdentifier": {
"uint32": 1
},
"protocol": "BGP",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 6
},
"bgpLsId": 10,
"dcIdentifier": 6,
"networkIdentifier": {
"uint32": 1
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 10
},
"bgpLsId": 5,
"dcIdentifier": 5,
"networkIdentifier": {
"uint32": 2
},
"protocol": "BGP",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 4
},
"bgpLsId": 2,
"dcIdentifier": 3,
"networkIdentifier": {
"uint32": 5
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 3
},
"bgpLsId": 8,
"dcIdentifier": 4,
"networkIdentifier": {
"uint32": 2
},
"protocol": "STATIC",
"routerId": {
"string": "string"
}
},
{
"asNumber": {
"uint32": 4
},
"bgpLsId": 8,
"dcIdentifier": 6,
"networkIdentifier": {
"uint32": 3
},
"protocol": "OSPFv2",
"routerId": {
"string": "string"
}
}
],
"systemId": {
"ipv4Address": {},
"ipv6Address": {}
},
"systemName": "string"
},
"endRow": 6,
"startRow": 10,
"status": 1,
"totalRows": 4
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateRouterIdSystemIdMapping",
"description": "The parameters and request body are for method: updateRouterIdSystemIdMapping. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 5,
"startRow": 1,
"status": 6,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteRouterIdSystemIdMapping",
"description": "The parameters and request body are for method: deleteRouterIdSystemIdMapping. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 1,
"startRow": 6,
"status": 8,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "policyId",
"in": "path",
"required": true,
"schema": {
"title": "policyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/system-ip-mpls-config": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllSystemIpMplsConfig",
"description": "The parameters and request body are for method: getAllSystemIpMplsConfig. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"maintenanceMode": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"maintenanceMode": "MANUAL",
"name": "string",
"objectDescription": "string"
}
],
"endRow": 6,
"startRow": 3,
"status": 8,
"totalRows": 9
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/system-ip-mpls-config/{templateId}": {
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateSystemIpMplsConfig",
"description": "The parameters and request body are for method: updateSystemIpMplsConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 3,
"startRow": 5,
"status": 7,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/tunnel-creations": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllTunnelCreations",
"description": "The parameters and request body are for method: getAllTunnelCreations. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"consumable": {
"type": "boolean"
},
"deletable": {
"type": "boolean"
},
"id": {
"type": "string"
},
"modifiable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"protection": {
"type": "boolean"
},
"protectionType": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"consumable": true,
"deletable": false,
"id": "string",
"modifiable": false,
"name": "string",
"objectDescription": "string",
"protection": false,
"protectionType": "STANDBY"
},
{
"appId": "string",
"consumable": true,
"deletable": true,
"id": "string",
"modifiable": false,
"name": "string",
"objectDescription": "string",
"protection": false,
"protectionType": "UNKNOWN"
},
{
"appId": "string",
"consumable": false,
"deletable": true,
"id": "string",
"modifiable": true,
"name": "string",
"objectDescription": "string",
"protection": true,
"protectionType": "PRIMARY"
},
{
"appId": "string",
"consumable": true,
"deletable": false,
"id": "string",
"modifiable": false,
"name": "string",
"objectDescription": "string",
"protection": true,
"protectionType": "STANDBY"
}
],
"endRow": 10,
"startRow": 3,
"status": 4,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/template/tunnel-creations/{templateId}": {
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateTunnelCreations",
"description": "The parameters and request body are for method: updateTunnelCreations. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 4,
"status": 1,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"title": "templateId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/workflow-profile": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getAllWorkflowProfileMappings",
"description": "The parameters and request body are for method: getAllWorkflowProfileMappings. 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": "object",
"properties": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"workflowProfileInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockServiceDeployment": {
"type": "boolean"
},
"continueServiceDeploymentOnError": {
"type": "boolean"
},
"serviceStep": {
"type": "string"
},
"workflowExecutionTimeout": {
"type": "number"
},
"workflowId": {
"type": "string"
},
"workflowInputs": {
"type": "string"
},
"workflowParams": {
"type": "string"
}
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_success",
"workflowExecutionTimeout": 7,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 8,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postdelete_success",
"workflowExecutionTimeout": 6,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "predelete",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "postcreate_success",
"workflowExecutionTimeout": 3,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postupdate_success",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_success",
"workflowExecutionTimeout": 9,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "precreate",
"workflowExecutionTimeout": 5,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postdelete_success",
"workflowExecutionTimeout": 10,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postcreate_success",
"workflowExecutionTimeout": 9,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_success",
"workflowExecutionTimeout": 3,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "preupdate",
"workflowExecutionTimeout": 3,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "postcreate_success",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postdelete_failure",
"workflowExecutionTimeout": 10,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postcreate_success",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "postdelete_failure",
"workflowExecutionTimeout": 6,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "precreate",
"workflowExecutionTimeout": 1,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 10,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 5,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postcreate_success",
"workflowExecutionTimeout": 7,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "precreate",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "preupdate",
"workflowExecutionTimeout": 1,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "precreate",
"workflowExecutionTimeout": 6,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "postdelete_failure",
"workflowExecutionTimeout": 1,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
},
{
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "postcreate_failure",
"workflowExecutionTimeout": 8,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "precreate",
"workflowExecutionTimeout": 5,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
}
],
"endRow": 5,
"startRow": 3,
"status": 3,
"totalRows": 5
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTemplate"
],
"operationId": "createWorkflowProfile",
"description": "The parameters and request body are for method: createWorkflowProfile. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"workflowProfileInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockServiceDeployment": {
"type": "boolean"
},
"continueServiceDeploymentOnError": {
"type": "boolean"
},
"serviceStep": {
"type": "string"
},
"workflowExecutionTimeout": {
"type": "number"
},
"workflowId": {
"type": "string"
},
"workflowInputs": {
"type": "string"
},
"workflowParams": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "postdelete_failure",
"workflowExecutionTimeout": 10,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postcreate_failure",
"workflowExecutionTimeout": 6,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "precreate",
"workflowExecutionTimeout": 7,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 9,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "preupdate",
"workflowExecutionTimeout": 2,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "preupdate",
"workflowExecutionTimeout": 8,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 9,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "precreate",
"workflowExecutionTimeout": 6,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": false,
"serviceStep": "postcreate_failure",
"workflowExecutionTimeout": 8,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 6,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
},
"endRow": 2,
"startRow": 5,
"status": 7,
"totalRows": 1
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/template/workflow-profile/{profileId}": {
"get": {
"tags": [
"SdnTemplate"
],
"operationId": "getWorkflowProfile",
"description": "The parameters and request body are for method: getWorkflowProfile. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"workflowProfileInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockServiceDeployment": {
"type": "boolean"
},
"continueServiceDeploymentOnError": {
"type": "boolean"
},
"serviceStep": {
"type": "string"
},
"workflowExecutionTimeout": {
"type": "number"
},
"workflowId": {
"type": "string"
},
"workflowInputs": {
"type": "string"
},
"workflowParams": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": false,
"continueServiceDeploymentOnError": true,
"serviceStep": "postcreate_success",
"workflowExecutionTimeout": 1,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
},
"endRow": 5,
"startRow": 4,
"status": 6,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTemplate"
],
"operationId": "updateWorkflowProfile",
"description": "The parameters and request body are for method: updateWorkflowProfile. 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": {
"appId": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"objectDescription": {
"type": "string"
},
"workflowProfileInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockServiceDeployment": {
"type": "boolean"
},
"continueServiceDeploymentOnError": {
"type": "boolean"
},
"serviceStep": {
"type": "string"
},
"workflowExecutionTimeout": {
"type": "number"
},
"workflowId": {
"type": "string"
},
"workflowInputs": {
"type": "string"
},
"workflowParams": {
"type": "string"
}
}
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"appId": "string",
"id": "string",
"name": "string",
"objectDescription": "string",
"workflowProfileInfo": [
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "preupdate",
"workflowExecutionTimeout": 9,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "postdelete_success",
"workflowExecutionTimeout": 9,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": false,
"serviceStep": "precreate",
"workflowExecutionTimeout": 3,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
},
{
"blockServiceDeployment": true,
"continueServiceDeploymentOnError": true,
"serviceStep": "postupdate_failure",
"workflowExecutionTimeout": 4,
"workflowId": "string",
"workflowInputs": "string",
"workflowParams": "string"
}
]
},
"endRow": 5,
"startRow": 3,
"status": 5,
"totalRows": 3
}
}
}
}
}
},
"parameters": [
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTemplate"
],
"operationId": "deleteWorkflowProfile",
"description": "The parameters and request body are for method: deleteWorkflowProfile. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 9,
"startRow": 2,
"status": 2,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/tenants": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "getV4Tenants",
"description": "The parameters and request body are for method: getV4Tenants. 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": "object",
"properties": {
"address": {
"type": "string"
},
"contactName": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"tenantName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"address": "string",
"contactName": "string",
"customerId": 2,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 10,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 6,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 9,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 3,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 2,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 3,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
}
],
"endRow": 5,
"startRow": 5,
"status": 10,
"totalRows": 8
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTenants"
],
"operationId": "postV4Tenants",
"description": "The parameters and request body are for method: postV4Tenants. 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": {
"address": {
"type": "string"
},
"contactName": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"tenantName": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"address": "string",
"contactName": "string",
"customerId": 1,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
"endRow": 10,
"startRow": 5,
"status": 5,
"totalRows": 6
}
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/tenants/customer-all": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "getCustomerAll",
"description": "The parameters and request body are for method: getCustomerAll. 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": "object",
"properties": {
"address": {
"type": "string"
},
"contactPerson": {
"type": "string"
},
"customerName": {
"type": "string"
},
"description": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "number"
},
"phoneNumber": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 3,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 10,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 2,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 7,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 8,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 8,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 1,
"phoneNumber": "string"
},
{
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 9,
"phoneNumber": "string"
}
],
"endRow": 4,
"startRow": 9,
"status": 7,
"totalRows": 2
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/tenants/customer/{customerId}": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "getCustomer",
"description": "The parameters and request body are for method: getCustomer. 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": {
"address": {
"type": "string"
},
"contactPerson": {
"type": "string"
},
"customerName": {
"type": "string"
},
"description": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "number"
},
"phoneNumber": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"address": "string",
"contactPerson": "string",
"customerName": "string",
"description": "string",
"email": "string",
"id": 5,
"phoneNumber": "string"
},
"endRow": 8,
"startRow": 6,
"status": 6,
"totalRows": 7
}
}
}
}
}
},
"parameters": [
{
"name": "customerId",
"in": "path",
"required": true,
"schema": {
"title": "customerId",
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/tenants/resync/{provider}": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "resync",
"description": "The parameters and request body are for method: resync. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 9,
"status": 6,
"totalRows": 2
}
}
}
}
}
},
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"schema": {
"title": "provider",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/tenants/{tenantUuid}": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "getV4TenantsTenantUuid",
"description": "The parameters and request body are for method: getV4TenantsTenantUuid. 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": {
"address": {
"type": "string"
},
"contactName": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"tenantName": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"address": "string",
"contactName": "string",
"customerId": 5,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
"endRow": 9,
"startRow": 6,
"status": 3,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"put": {
"tags": [
"SdnTenants"
],
"operationId": "putV4TenantsTenantUuid",
"description": "The parameters and request body are for method: putV4TenantsTenantUuid. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 9,
"status": 2,
"totalRows": 6
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTenants"
],
"operationId": "deleteV4TenantsTenantUuid",
"description": "The parameters and request body are for method: deleteV4TenantsTenantUuid. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 10,
"status": 10,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/tenants/{tenantUuid}/resources": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "getResources",
"description": "The parameters and request body are for method: getResources. 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": "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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"neDeploymentState": "UNKNOWN",
"operationalState": "UP"
},
{
"adminState": "UP",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"neDeploymentState": "PENDING",
"operationalState": "UNKNOWN"
},
{
"adminState": "UP",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "FAILED",
"operationalState": "TRANSITION"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "FAILED",
"operationalState": "TRANSITION"
},
{
"adminState": "UP",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "FAILED",
"operationalState": "DOWN"
},
{
"adminState": "MAINTENANCE",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DOWN"
},
{
"adminState": "UP",
"appId": "string",
"customAttributes": [
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "PARTIALLY_DOWN"
},
{
"adminState": "UP",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string"
]
}
],
"id": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DOWN"
},
{
"adminState": "DOWN",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "NA",
"operationalState": "PARTIALLY_DOWN"
},
{
"adminState": "UP",
"appId": "string",
"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"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
},
{
"attributeName": "string",
"attributeValue": "string"
}
],
"customAttributesTemplateId": "string",
"externalIds": [
{
"context": "NFM_T",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string"
]
},
{
"context": "NSP",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "MDM",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NFM_P",
"id": "string",
"location": [
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
},
{
"context": "NODE",
"id": "string",
"location": [
"string",
"string",
"string",
"string"
]
}
],
"id": "string",
"neDeploymentState": "DEPLOYED",
"operationalState": "DOWN"
}
],
"endRow": 4,
"startRow": 4,
"status": 4,
"totalRows": 10
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnTenants"
],
"operationId": "addResources",
"description": "The parameters and request body are for method: addResources. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 3,
"startRow": 2,
"status": 10,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"delete": {
"tags": [
"SdnTenants"
],
"operationId": "deleteResources",
"description": "The parameters and request body are for method: deleteResources. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 2,
"startRow": 5,
"status": 6,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/tenants/{tenantUuid}/usergroup/{groupName}": {
"get": {
"tags": [
"SdnTenants"
],
"operationId": "getUsergroup",
"description": "The parameters and request body are for method: getUsergroup. 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": [
"OPERATOR",
"ADMIN",
"OPERATOR",
"OPERATOR",
"OPERATOR",
"ADMIN",
"OPERATOR",
"ADMIN",
"ADMIN",
"ADMIN"
],
"endRow": 6,
"startRow": 1,
"status": 9,
"totalRows": 9
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
},
{
"name": "groupName",
"in": "path",
"required": true,
"schema": {
"title": "groupName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"delete": {
"tags": [
"SdnTenants"
],
"operationId": "deleteUsergroup",
"description": "The parameters and request body are for method: deleteUsergroup. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": true,
"endRow": 5,
"startRow": 10,
"status": 9,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
},
{
"name": "groupName",
"in": "path",
"required": true,
"schema": {
"title": "groupName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/tenants/{tenantUuid}/usergroup/{groupName}/role/{roleType}": {
"post": {
"tags": [
"SdnTenants"
],
"operationId": "createUsergroup",
"description": "The parameters and request body are for method: createUsergroup. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"data": {
"type": "boolean"
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": false,
"endRow": 2,
"startRow": 3,
"status": 7,
"totalRows": 8
}
}
}
}
}
},
"parameters": [
{
"name": "tenantUuid",
"in": "path",
"required": true,
"schema": {
"title": "tenantUuid",
"type": "string"
}
},
{
"name": "groupName",
"in": "path",
"required": true,
"schema": {
"title": "groupName",
"type": "string"
}
},
{
"name": "roleType",
"in": "path",
"required": true,
"schema": {
"title": "roleType",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/usergroups": {
"get": {
"tags": [
"SdnUsergroups"
],
"operationId": "getV4Usergroups",
"description": "The parameters and request body are for method: getV4Usergroups. 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": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
},
{
"name": "string"
}
],
"endRow": 2,
"startRow": 10,
"status": 10,
"totalRows": 3
}
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/usergroups/{groupName}": {
"get": {
"tags": [
"SdnUsergroups"
],
"operationId": "getV4UsergroupsGroupName",
"description": "The parameters and request body are for method: getV4UsergroupsGroupName. 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": {
"name": {
"type": "string"
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": {
"name": "string"
},
"endRow": 3,
"startRow": 4,
"status": 2,
"totalRows": 1
}
}
}
}
}
},
"parameters": [
{
"name": "groupName",
"in": "path",
"required": true,
"schema": {
"title": "groupName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/usergroups/{groupName}/tenants": {
"get": {
"tags": [
"SdnUsergroups"
],
"operationId": "getV4UsergroupsGroupNameTenants",
"description": "The parameters and request body are for method: getV4UsergroupsGroupNameTenants. 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": "object",
"properties": {
"address": {
"type": "string"
},
"contactName": {
"type": "string"
},
"customerId": {
"type": "number"
},
"id": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"tenantName": {
"type": "string"
}
}
}
},
"endRow": {
"type": "number"
},
"startRow": {
"type": "number"
},
"status": {
"type": "number"
},
"totalRows": {
"type": "number"
}
}
}
}
},
"example": {
"response": {
"data": [
{
"address": "string",
"contactName": "string",
"customerId": 8,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 2,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 9,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 1,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 9,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 3,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 8,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 3,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
},
{
"address": "string",
"contactName": "string",
"customerId": 4,
"id": "string",
"phoneNumber": "string",
"tenantName": "string"
}
],
"endRow": 3,
"startRow": 5,
"status": 7,
"totalRows": 5
}
}
}
}
}
},
"parameters": [
{
"name": "groupName",
"in": "path",
"required": true,
"schema": {
"title": "groupName",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/configuration/nrcp-historical": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getNrcpHistorical",
"description": "The parameters and request body are for method: getNrcpHistorical. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchNrcpHistorical",
"description": "The parameters and request body are for method: patchNrcpHistorical. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/sr-policy-config": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getSrPolicyConfig",
"description": "The parameters and request body are for method: getSrPolicyConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchSrPolicyConfig",
"description": "The parameters and request body are for method: patchSrPolicyConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/elines/{serviceUuid}/endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addElineEndpoint",
"description": "The parameters and request body are for method: addElineEndpoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-dcis/{serviceUuid}/endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addL3DciL3Endpoint",
"description": "The parameters and request body are for method: addL3DciL3Endpoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-dcis/{serviceUuid}/loopback-endpoint": {
"post": {
"tags": [
"SdnServices"
],
"operationId": "addL3DciL3LoopbackEndpoint",
"description": "The parameters and request body are for method: addL3DciL3LoopbackEndpoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/l3-dcis/{endpointUuid}/loopback-endpoint/{serviceUuid}": {
"patch": {
"tags": [
"SdnServices"
],
"operationId": "patchL3DciL3LoopbackEndpoint",
"description": "The parameters and request body are for method: patchL3DciL3LoopbackEndpoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "endpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "endpointUuid",
"type": "string"
}
},
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/services/stitch-l2-ext/{l2extServiceUuid}/{serviceEndpointUuid}/{serviceUuid}": {
"put": {
"tags": [
"SdnServices"
],
"operationId": "updateStitchL2Ext",
"description": "The parameters and request body are for method: updateStitchL2Ext. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "l2extServiceUuid",
"in": "path",
"required": true,
"schema": {
"title": "l2extServiceUuid",
"type": "string"
}
},
{
"name": "serviceEndpointUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceEndpointUuid",
"type": "string"
}
},
{
"name": "serviceUuid",
"in": "path",
"required": true,
"schema": {
"title": "serviceUuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/topology-references/domain/{networkId}": {
"delete": {
"tags": [
"SdnNsp"
],
"operationId": "deleteTopologyReferencesByDomain",
"description": "The parameters and request body are for method: deleteTopologyReferencesByDomain. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "networkId",
"in": "path",
"required": true,
"schema": {
"title": "networkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/topology-references/link/{linkId}": {
"delete": {
"tags": [
"SdnNsp"
],
"operationId": "deleteTopologyReferencesByLink",
"description": "The parameters and request body are for method: deleteTopologyReferencesByLink. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/pathtool/diagnose-lsp/{lspPathId}": {
"post": {
"tags": [
"SdnPathTool"
],
"operationId": "diagnoseLsp",
"description": "The parameters and request body are for method: diagnoseLsp. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "lspPathId",
"in": "path",
"required": true,
"schema": {
"title": "lspPathId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/pathtool/diagnose-path": {
"post": {
"tags": [
"SdnPathTool"
],
"operationId": "diagnosePath",
"description": "The parameters and request body are for method: diagnosePath. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/physicallinks/multipoint-port/{multipointLinkId}/{portId}": {
"post": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "addMultipointPort",
"description": "The parameters and request body are for method: addMultipointPort. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipointLinkId",
"in": "path",
"required": true,
"schema": {
"title": "multipointLinkId",
"type": "string"
}
},
{
"name": "portId",
"in": "path",
"required": true,
"schema": {
"title": "portId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"delete": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "removeMultipointPort",
"description": "The parameters and request body are for method: removeMultipointPort. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipointLinkId",
"in": "path",
"required": true,
"schema": {
"title": "multipointLinkId",
"type": "string"
}
},
{
"name": "portId",
"in": "path",
"required": true,
"schema": {
"title": "portId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/physicallinks/multipoint/{linkId}": {
"delete": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "deleteMultipoint",
"description": "The parameters and request body are for method: deleteMultipoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "createMultipoint",
"description": "The parameters and request body are for method: createMultipoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"get": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "getMultipoint",
"description": "The parameters and request body are for method: getMultipoint. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/physicallinks/multipoints": {
"get": {
"tags": [
"SdnPhysicallinks"
],
"operationId": "getMultipoints",
"description": "The parameters and request body are for method: getMultipoints. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/policy/all-connection-profile/{neId}": {
"get": {
"tags": [
"SdnPolicy"
],
"operationId": "getAllConnectionProfile",
"description": "The parameters and request body are for method: getAllConnectionProfile. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "neId",
"in": "path",
"required": true,
"schema": {
"title": "neId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/servicedebug/trigger-ttz-algorithm": {
"post": {
"tags": [
"SdnServiceDebug"
],
"operationId": "createTriggerTtzAlgorithm",
"description": "The parameters and request body are for method: createTriggerTtzAlgorithm. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies": {
"get": {
"tags": [
"SdnSrPolicies"
],
"operationId": "getSRPolicies",
"description": "The parameters and request body are for method: getSRPolicies. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"post": {
"tags": [
"SdnSrPolicies"
],
"operationId": "createSRPolicy",
"description": "The parameters and request body are for method: createSRPolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/srpolicies/candidate-path-resignal/{id}": {
"post": {
"tags": [
"SdnSrPolicies"
],
"operationId": "createCandidatePathResignal",
"description": "The parameters and request body are for method: createCandidatePathResignal. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/candidate-path/{adminState}/admin/{candidatePathId}": {
"patch": {
"tags": [
"SdnSrPolicies"
],
"operationId": "patchCandidatePathAdmin",
"description": "The parameters and request body are for method: patchCandidatePathAdmin. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "adminState",
"in": "path",
"required": true,
"schema": {
"title": "adminState",
"type": "string"
}
},
{
"name": "candidatePathId",
"in": "path",
"required": true,
"schema": {
"title": "candidatePathId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/candidate-paths/{id}": {
"put": {
"tags": [
"SdnSrPolicies"
],
"operationId": "updateCandidatePaths",
"description": "The parameters and request body are for method: updateCandidatePaths. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/srpolicies/on-link/{linkId}/{requestType}": {
"get": {
"tags": [
"SdnSrPolicies"
],
"operationId": "getSRPoliciesOnLink",
"description": "The parameters and request body are for method: getSRPoliciesOnLink. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "linkId",
"in": "path",
"required": true,
"schema": {
"title": "linkId",
"type": "string"
}
},
{
"name": "requestType",
"in": "path",
"required": true,
"schema": {
"title": "requestType",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/policies": {
"delete": {
"tags": [
"SdnSrPolicies"
],
"operationId": "deletePolicies",
"description": "The parameters and request body are for method: deletePolicies. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/policies/{id}": {
"put": {
"tags": [
"SdnSrPolicies"
],
"operationId": "updatePolicies",
"description": "The parameters and request body are for method: updatePolicies. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/srpolicies/policy-list": {
"post": {
"tags": [
"SdnSrPolicies"
],
"operationId": "fetchPolicyList",
"description": "The parameters and request body are for method: fetchPolicyList. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/srpolicies/policy/{id}": {
"delete": {
"tags": [
"SdnSrPolicies"
],
"operationId": "deletePolicy",
"description": "The parameters and request body are for method: deletePolicy. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/policy/{adminState}/admin/{srPolicyId}": {
"patch": {
"tags": [
"SdnSrPolicies"
],
"operationId": "patchPolicyAdmin",
"description": "The parameters and request body are for method: patchPolicyAdmin. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "adminState",
"in": "path",
"required": true,
"schema": {
"title": "adminState",
"type": "string"
}
},
{
"name": "srPolicyId",
"in": "path",
"required": true,
"schema": {
"title": "srPolicyId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/resignal": {
"post": {
"tags": [
"SdnSrPolicies"
],
"operationId": "createSRPoliciesResignal",
"description": "The parameters and request body are for method: createSRPoliciesResignal. Same endpoint also used in methods:
createResignalSRPolicies (body : object)",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/pathtool/find-path": {
"post": {
"tags": [
"SdnPathTool"
],
"operationId": "findSdnPath",
"description": "The parameters and request body are for method: findSdnPath. Same endpoint also used in methods:
findPath (body : object)",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/assoc-group-config": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getAssocGroupConfig",
"description": "The parameters and request body are for method: getAssocGroupConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchAssocGroupConfig",
"description": "The parameters and request body are for method: patchAssocGroupConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/bsid-generation-config": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getBsidGenerationConfig",
"description": "The parameters and request body are for method: getBsidGenerationConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchBsidGenerationConfig",
"description": "The parameters and request body are for method: patchBsidGenerationConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/device-name-ip-service": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getDeviceNameIpService",
"description": "The parameters and request body are for method: getDeviceNameIpService. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchDeviceNameIpService",
"description": "The parameters and request body are for method: patchDeviceNameIpService. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/nsp/configuration/lsp-bsid-generation-config": {
"get": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "getLspBsidGenerationConfig",
"description": "The parameters and request body are for method: getLspBsidGenerationConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
},
"patch": {
"tags": [
"SdnNrcpConfiguration"
],
"operationId": "patchLspBsidGenerationConfig",
"description": "The parameters and request body are for method: patchLspBsidGenerationConfig. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/assoc-groups": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getAssocGroups",
"description": "The parameters and request body are for method: getAssocGroups. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/assoc-groups-by-type/{associationGroupType}": {
"get": {
"tags": [
"SdnMpls"
],
"operationId": "getAssocGroupsByType",
"description": "The parameters and request body are for method: getAssocGroupsByType. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "associationGroupType",
"in": "path",
"required": true,
"schema": {
"title": "associationGroupType",
"type": "string",
"enum": [
"POLICY",
"PROTECTION",
"DISJOINT"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/lsp-path-profile-override": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "lspPathProfileOverride",
"description": "The parameters and request body are for method: lspPathProfileOverride. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp-paths-by-tunnel-id": {
"post": {
"tags": [
"SdnMpls"
],
"operationId": "fetchLspPathsByTunnelId",
"description": "The parameters and request body are for method: fetchLspPathsByTunnelId. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/mpls/lsp/paths/on-assoc-group/{associationGroupId}/{associationGroupSource}/{associationGroupType}": {
"get": {
"tags": [
"SdnMplsLspPath"
],
"operationId": "getOnAssocGroup",
"description": "The parameters and request body are for method: getOnAssocGroup. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "associationGroupId",
"in": "path",
"required": true,
"schema": {
"title": "associationGroupId",
"type": "number"
}
},
{
"name": "associationGroupSource",
"in": "path",
"required": true,
"schema": {
"title": "associationGroupSource",
"type": "string"
}
},
{
"name": "associationGroupType",
"in": "path",
"required": true,
"schema": {
"title": "associationGroupType",
"type": "string",
"enum": [
"POLICY",
"PROTECTION",
"DISJOINT"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/lsp/paths/on-bsid/{bsidId}": {
"get": {
"tags": [
"SdnMplsLspPath"
],
"operationId": "getOnBsid",
"description": "The parameters and request body are for method: getOnBsid. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "bsidId",
"in": "path",
"required": true,
"schema": {
"title": "bsidId",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/mpls/lsp/paths/profile-group/{extendedId}/{profileId}": {
"get": {
"tags": [
"SdnMplsLspPath"
],
"operationId": "getProfileGroup",
"description": "The parameters and request body are for method: getProfileGroup. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "extendedId",
"in": "path",
"required": true,
"schema": {
"title": "extendedId",
"type": "number"
}
},
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"title": "profileId",
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/nsp/net/l3/links": {
"post": {
"tags": [
"SdnNsp"
],
"operationId": "fetchLinks",
"description": "The parameters and request body are for method: fetchLinks. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/srpolicies/by-key/{color}/{endpoint}/{headend}": {
"get": {
"tags": [
"SdnSrPolicies"
],
"operationId": "getByKey",
"description": "The parameters and request body are for method: getByKey. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "color",
"in": "path",
"required": true,
"schema": {
"title": "color",
"type": "string"
}
},
{
"name": "endpoint",
"in": "path",
"required": true,
"schema": {
"title": "endpoint",
"type": "string"
}
},
{
"name": "headend",
"in": "path",
"required": true,
"schema": {
"title": "headend",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/candidate-path-list": {
"post": {
"tags": [
"SdnSrPolicies"
],
"operationId": "fetchCandidatePathList",
"description": "The parameters and request body are for method: fetchCandidatePathList. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"description": "indeterminate body object",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"/v4/srpolicies/consumer/{id}": {
"get": {
"tags": [
"SdnSrPolicies"
],
"operationId": "getConsumer",
"description": "The parameters and request body are for method: getConsumer. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/resignal-all": {
"post": {
"tags": [
"SdnSrPolicies"
],
"operationId": "createResignalAll",
"description": "The parameters and request body are for method: createResignalAll. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
},
"/v4/srpolicies/{id}": {
"get": {
"tags": [
"SdnSrPolicies"
],
"operationId": "getSRPolicyByID",
"description": "The parameters and request body are for method: getSRPolicyByID. Same endpoint also used in methods:",
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"title": "result",
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"title": "id",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object"
},
"example": {}
}
}
}
}
}
},
"components": {
"schemas": {}
}
}