@itentialopensource/adapter-nokia_nsp_sdn
Version:
This adapter integrates with system described as: networkServicesPlatformRestApi-V4.
1,521 lines • 1.25 MB
JSON
{
"swagger" : "2.0",
"info" : {
"description" : "This API describes the REST interface to interact with the Network Services Platform",
"title" : "Network Services Platform REST API - v4",
"license" : { }
},
"host" : "10.0.0.67:8543",
"basePath" : "/sdn/api",
"tags" : [ {
"name" : "sdn-nrcp-configuration",
"description" : " "
}, {
"name" : "sdn-generic",
"description" : " "
}, {
"name" : "sdn-services",
"description" : " "
}, {
"name" : "sdn-ietf",
"description" : " "
}, {
"name" : "sdn-backhaul-paths",
"description" : " "
}, {
"name" : "sdn-mediation",
"description" : " "
}, {
"name" : "sdn-mpls",
"description" : " "
}, {
"name" : "sdn-mpls-lsp-path",
"description" : " "
}, {
"name" : "sdn-ne",
"description" : " "
}, {
"name" : "sdn-nsp",
"description" : " "
}, {
"name" : "sdn-openflow",
"description" : " "
}, {
"name" : "sdn-physicallinks",
"description" : " "
}, {
"name" : "sdn-policy",
"description" : " "
}, {
"name" : "sdn-ports",
"description" : " "
}, {
"name" : "sdn-security",
"description" : " "
}, {
"name" : "sdn-services",
"description" : " "
}, {
"name" : "sdn-service-debug",
"description" : " "
}, {
"name" : "sdn-system",
"description" : " "
}, {
"name" : "sdn-template",
"description" : " "
}, {
"name" : "sdn-tenants",
"description" : " "
}, {
"name" : "sdn-usergroups",
"description" : " "
} ],
"paths" : {
"/v4/generic/application-id/{id}" : {
"get" : {
"tags" : [ "sdn-generic" ],
"summary" : "Find an object by Application ID",
"description" : "Find an object by Application ID",
"operationId" : "getApplicationId",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "The Application ID of the object",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseEntity»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/generic/application-id/{id}/{appId}" : {
"put" : {
"tags" : [ "sdn-generic" ],
"summary" : "Set an object Application ID",
"description" : "Set an object Application ID",
"operationId" : "setApplicationId",
"consumes" : [ "application/json" ],
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "appId",
"in" : "path",
"description" : "The Application ID to be set",
"required" : false,
"type" : "string"
}, {
"name" : "id",
"in" : "path",
"description" : "The unique identifier of the object",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseEntity»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/generic/consumed/{uuid}" : {
"get" : {
"tags" : [ "sdn-generic" ],
"summary" : "Find all objects being consumed by an object",
"description" : "Find all objects being consumed by an object",
"operationId" : "getConsumed",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "uuid",
"in" : "path",
"description" : "The unique identifier of the object",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«List«string»»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/generic/find-by-external-id" : {
"post" : {
"tags" : [ "sdn-generic" ],
"summary" : "Find the unique identifier of an object given an external identifier",
"description" : "Find the unique identifier of an object given an external identifier",
"operationId" : "findByExternalId",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "An external identifier to the NSP.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«ExternalId»"
}
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«string»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/generic/tenants/{uuid}" : {
"get" : {
"tags" : [ "sdn-generic" ],
"summary" : "Find all tenants assigned to an object",
"description" : "Find all tenants assigned to an object",
"operationId" : "getTenants",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "uuid",
"in" : "path",
"description" : "The unique identifiers for the object",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«string»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/generic/{uuid}" : {
"get" : {
"tags" : [ "sdn-generic" ],
"summary" : "Find an object by a unique identifier",
"description" : "Find an object by a unique identifier",
"operationId" : "get",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "uuid",
"in" : "path",
"description" : "The unique identifier for the query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseEntity»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint" : {
"post" : {
"tags" : [ "sdn-services" ],
"summary" : "Add an endpoint to a L2 Backhaul Service",
"description" : "Add an endpoint to a L2 Backhaul Service",
"operationId" : "addL2BackhaulEndpoint",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "ETH transport services access parameters",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«NspEthtSvcAccessParameters»"
}
}, {
"name" : "serviceUuid",
"in" : "path",
"description" : "The unique identifier of the service to be modified",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseService»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint/{endpointUuid}" : {
"put" : {
"tags" : [ "sdn-services" ],
"summary" : "Update endpoint of a L2 Backhaul service",
"description" : "Update endpoint of a L2 Backhaul service",
"operationId" : "updateL2BackhaulEndpoint",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "endpointUuid",
"in" : "path",
"description" : "The unique identifier of the service endpoint to be modified",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "ETH transport services access parameters",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«NspEthtSvcAccessParameters»"
}
}, {
"name" : "serviceUuid",
"in" : "path",
"description" : "The unique identifier of the service to which the endpoint belongs",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseService»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
},
"patch" : {
"tags" : [ "sdn-services" ],
"summary" : "Patch endpoint of an L3 VPN service",
"description" : "Patch endpoint of an L3 VPN service",
"operationId" : "patchL2BackhaulEndpoint",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "endpointUuid",
"in" : "path",
"description" : "The unique identifier of the service endpoint to be patched",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "ETH transport services access parameters",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«NspEthtSvcAccessParameters»"
}
}, {
"name" : "serviceUuid",
"in" : "path",
"description" : "The unique identifier of the service to which the endpoint belongs",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseService»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/ethtsvc/l2backhaul/{autoPath}" : {
"post" : {
"tags" : [ "sdn-services" ],
"summary" : "Create L2 Backhaul Service",
"description" : "Create L2 Backhaul Service",
"operationId" : "createL2backhaul",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "autoPath",
"in" : "path",
"description" : "If True SF will automatically compuate the best path and use it for service provisioning",
"required" : false,
"type" : "boolean"
}, {
"in" : "body",
"name" : "body",
"description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«BackhaulL2RequestData»"
}
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseService»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/ethtsvc/l2backhaul/{serviceUuid}" : {
"put" : {
"tags" : [ "sdn-services" ],
"summary" : "Modify L2 Backhaul service",
"description" : "Modify L2 Backhaul service",
"operationId" : "updateL2backhaul",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«BackhaulL2RequestData»"
}
}, {
"name" : "serviceUuid",
"in" : "path",
"description" : "The unique identifier of the service that is being modified",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseService»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
},
"patch" : {
"tags" : [ "sdn-services" ],
"summary" : "Patch L2 Backhaul service",
"description" : "Patch L2 Backhaul service",
"operationId" : "patchL2backhaul",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The normalized Micorowave L2 Backhaul Service. This object is used to create and modify service entities in the network.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«BackhaulL2RequestData»"
}
}, {
"name" : "serviceUuid",
"in" : "path",
"description" : "The unique identifier of the service that is being patched",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BaseService»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/te/link/{linkId}" : {
"get" : {
"tags" : [ "sdn-ietf" ],
"summary" : "Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point).",
"description" : "Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point).",
"operationId" : "getLink",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "linkId",
"in" : "path",
"description" : "UUID: Identifier for a link",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«Link»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/te/link/{linkUuid}" : {
"patch" : {
"tags" : [ "sdn-ietf" ],
"summary" : "Patch TE link by updating the configuration parameters. Supported configuration parameter(s): SRLG, Latency, AdminStatus",
"description" : "Patch TE link by updating the configuration parameters. Supported configuration parameter(s): SRLG, Latency, AdminStatus",
"operationId" : "patchLink",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "linkUuid",
"in" : "path",
"description" : "The unique identifier of the TE link",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "TE link configuration grouping.",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«TeLinkConfig»"
}
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«Link»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/te/network/{networkId}" : {
"get" : {
"tags" : [ "sdn-ietf" ],
"summary" : "Get TE network. A network has a UUID, attributes, a list of nodes and a list of links.",
"description" : "Get TE network. A network has a UUID, attributes, a list of nodes and a list of links.",
"operationId" : "getNetwork",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "networkId",
"in" : "path",
"description" : "UUID: Identifier for a network",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«Network»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/te/networks" : {
"get" : {
"tags" : [ "sdn-ietf" ],
"summary" : "Get TE networks. A list of networks where each network has a UUID.",
"description" : "Get TE networks. A list of networks where each network has a UUID.",
"operationId" : "getNetworks",
"produces" : [ "*/*" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«Networks»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/te/node/{nodeId}" : {
"get" : {
"tags" : [ "sdn-ietf" ],
"summary" : "Get TE node. A node has a UUID, attributes and a list of termination-points.",
"description" : "Get TE node. A node has a UUID, attributes and a list of termination-points.",
"operationId" : "getNode",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "nodeId",
"in" : "path",
"description" : "UUID: Identifier for a node",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«Node»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/ietf/te/termination-point/{tpId}" : {
"get" : {
"tags" : [ "sdn-ietf" ],
"summary" : "Get TE termination-point. A termination-point has a UUID and attributes.",
"description" : "Get TE termination-point. A termination-point has a UUID and attributes.",
"operationId" : "getTerminationPoint",
"produces" : [ "*/*" ],
"parameters" : [ {
"name" : "tpId",
"in" : "path",
"description" : "UUID: Identifier for a termination-point",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«TerminationPoint»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/l2/backhaul/paths/l2-paths" : {
"get" : {
"tags" : [ "sdn-backhaul-paths" ],
"summary" : "Get L2 Path",
"description" : "Get L2 Path",
"operationId" : "getL2Paths",
"produces" : [ "*/*" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The path calculation request definition",
"required" : false,
"schema" : {
"$ref" : "#/definitions/Request«PathSearchRequest»"
}
} ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«BackhaulPath»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/mediation/ami-version-templates" : {
"get" : {
"tags" : [ "sdn-mediation" ],
"summary" : "Fetch the template global names for all AMIs, grouped by AMI",
"description" : "Fetch the template global names for all AMIs, grouped by AMI",
"operationId" : "getAmiVersionTemplates",
"produces" : [ "*/*" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«List«AmiNameVersionTemplates»»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/mediation/amis-versions" : {
"get" : {
"tags" : [ "sdn-mediation" ],
"summary" : "Fetch the AMIs and the versions.",
"description" : "Fetch the AMIs and the versions.",
"operationId" : "getAmisVersions",
"produces" : [ "*/*" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«List«AmiNameVersions»»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
}
},
"/v4/mediation/augmentation-meta" : {
"get" : {
"tags" : [ "sdn-mediation" ],
"summary" : "Query all Augmentation Meta Infos",
"description" : "Query all Augmentation Meta Infos",
"operationId" : "getAllAugmentationMeta",
"produces" : [ "*/*" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "OK - Request executed successfully",
"schema" : {
"$ref" : "#/definitions/ResponseData«List«AugmentationMetaInput»»"
}
},
"400" : {
"description" : "Bad Request - Malformed content or invalid data provided",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"401" : {
"description" : "Unauthorized - Authentication rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"403" : {
"description" : "Forbidden - Authorization rejected",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"404" : {
"description" : "Not Found - Resource does not exist",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"409" : {
"description" : "Conflict - System not ready",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
},
"500" : {
"description" : "Internal Server Error - Unrecognized system error",
"schema" : {
"$ref" : "#/definitions/ErrorResponseData"
}
}
},
"security" : [ {
"REST Token" : [ "global" ]
} ]
},
"post" : {
"tags" : [ "sdn-mediation" ],
"summary" : "Create an Augmentation Meta