@itentialopensource/adapter-nokia_nsp_sdn
Version:
This adapter integrates with system described as: networkServicesPlatformRestApi-V4.
1,619 lines • 1.66 MB
YAML
openapi: 3.0.0
info:
title: Network Services Platform REST API - v4
description: This API describes the REST interface to interact with the Network Services Platform
contact: {}
version: '1.0'
servers:
- url: http://10.0.0.67:8543/sdn/api
variables: {}
paths:
/v4/nsp/configuration/latency:
get:
tags:
- sdn-nrcp-configuration
summary: getLatency
description: Get NSP latency parameters
operationId: getLatency
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchLatency
description: Patch NSP latency parameters
operationId: patchLatency
parameters: []
requestBody:
description: Grouping of all latency related parameters for IP/MPLS optimization. If using classic mode, the user must define the session name, source, and destination for twamp tests using the twampTests body. Test session names must be unique among all tests. A new test with an already used session name will overwrite previous one.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestLatency'
- description: Grouping of all latency related parameters for IP/MPLS optimization. If using classic mode, the user must define the session name, source, and destination for twamp tests using the twampTests body. Test session names must be unique among all tests. A new test with an already used session name will overwrite previous one.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/latency/{session}:
delete:
tags:
- sdn-nrcp-configuration
summary: deleteLatency
description: API used to delete twamp tests.
operationId: deleteLatency
parameters:
- name: session
in: path
description: Session name for test to be removed. If session is "all" it will remove all tests.
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/tca-config-policy:
get:
tags:
- sdn-nrcp-configuration
summary: getTcaConfigPolicy
description: Get TCA Policy configuration. Policies configuration include list of policies and collection enable flag
operationId: getTcaConfigPolicy
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchTcaConfigPolicy
description: Patch a TCA configuration policy by updating the parameters
operationId: patchTcaConfigPolicy
parameters: []
requestBody:
description: NSP configuration on SNMP TCA policy for statistic collection
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestSnmpTcaPolicyInfo'
- description: NSP configuration on SNMP TCA policy for statistic collection
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/traffic-data-collection:
get:
tags:
- sdn-nrcp-configuration
summary: getTrafficDataCollection
description: Get NSP traffic collection parameters.
operationId: getTrafficDataCollection
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchTrafficDataCollection
description: Patch NSP traffic-collection parameters.
operationId: patchTrafficDataCollection
parameters: []
requestBody:
description: Grouping of all traffic collection parameters
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestTrafficDataCollection'
- description: Grouping of all traffic collection parameters
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/assoc-group-config:
get:
tags:
- sdn-nrcp-configuration
summary: getAssocGroupConfig
description: Get association group configuration parameters.
operationId: getAssocGroupConfig
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchAssocGroupConfig
description: Patch association group configuration parameters.
operationId: patchAssocGroupConfig
parameters: []
requestBody:
description: Grouping of all association group related parameters for IP/MPLS optimization.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestAssocGroupConfig'
- description: Grouping of all association group related parameters for IP/MPLS optimization.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/bsid-generation-config:
get:
tags:
- sdn-nrcp-configuration
summary: getBsidGenerationConfig
description: Get BSID generation configuration parameters.
operationId: getBsidGenerationConfig
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchBsidGenerationConfig
description: Patch BSID generation configuration parameters.
operationId: patchBsidGenerationConfig
parameters: []
requestBody:
description: bsidGenerationConfig
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestBsidGenerationConfig'
- description: bsidGenerationConfig
required: true
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/device-name-ip-service:
get:
tags:
- sdn-nrcp-configuration
summary: getDeviceNameIpService
description: Get NSP device name mapping parameters
operationId: getDeviceNameIpService
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchDeviceNameIpService
description: Patch NSP device name mapping parameters
operationId: patchDeviceNameIpService
parameters: []
requestBody:
description: Group of all device and name mapping related parameters for IP/MPLS optimization.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestDeviceNameMappingConfig'
- description: Group of all device and name mapping related parameters for IP/MPLS optimization.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/lsp-bsid-generation-config:
get:
tags:
- sdn-nrcp-configuration
summary: getLspBsidGenerationConfig
description: Get LSP BSID generation configuration parameters.
operationId: getLspBsidGenerationConfig
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchLspBsidGenerationConfig
description: Patch LSP BSID generation configuration parameters.
operationId: patchLspBsidGenerationConfig
parameters: []
requestBody:
description: Define LSP related configuration.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestLspBsidGenerationConfig'
- description: Define LSP related configuration.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/nrcp-historical:
get:
tags:
- sdn-nrcp-configuration
summary: getNrcpHistorical
description: Get NSP NRCP historical parameters.
operationId: getNrcpHistorical
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchNrcpHistorical
description: Patch NSP NRCP historical parameters.
operationId: patchNrcpHistorical
parameters: []
requestBody:
description: Grouping of all historical related parameters for IP/MPLS optimization.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestNrcpHistorical'
- description: Grouping of all historical related parameters for IP/MPLS optimization.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/nsp/configuration/sr-policy-config:
get:
tags:
- sdn-nrcp-configuration
summary: getSrPolicyConfig
description: Get SR policy configuration parameters.
operationId: getSrPolicyConfig
parameters: []
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
patch:
tags:
- sdn-nrcp-configuration
summary: patchSrPolicyConfig
description: Patch SR policy configuration parameters.
operationId: patchSrPolicyConfig
parameters: []
requestBody:
description: Grouping of all SR policy related parameters for IP/MPLS optimization.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestSrPolicyConfig'
- description: Grouping of all SR policy related parameters for IP/MPLS optimization.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDataboolean'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/generic/application-id/{id}:
get:
tags:
- sdn-generic
summary: getApplicationId
description: Find an object by Application ID
operationId: getApplicationId
parameters:
- name: id
in: path
description: The Application ID of the object
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
/v4/generic/application-id/{id}/{appId}:
put:
tags:
- sdn-generic
summary: setApplicationId
description: Set an object Application ID
operationId: setApplicationId
parameters:
- name: appId
in: path
description: The Application ID to be set
required: true
style: simple
schema:
type: string
- name: id
in: path
description: The unique identifier of the object
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
/v4/generic/consumed/{uuid}:
get:
tags:
- sdn-generic
summary: getConsumed
description: Find all objects being consumed by an object
operationId: getConsumed
parameters:
- name: uuid
in: path
description: The unique identifier of the object
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
/v4/generic/find-by-external-id:
post:
tags:
- sdn-generic
summary: findByExternalId
description: Find the unique identifier of an object given an external identifier
operationId: findByExternalId
parameters: []
requestBody:
description: An external identifier to the NSP.
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestExternalId'
- description: An external identifier to the NSP.
required: false
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseDatastring'
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'404':
description: Not Found - Resource does not exist
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'409':
description: Conflict - System not ready
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponseData'
deprecated: false
security:
- RESTToken:
- global
/v4/generic/tenants/{uuid}:
get:
tags:
- sdn-generic
summary: getTenants
description: Find all tenants assigned to an object
operationId: getTenants
parameters:
- name: uuid
in: path
description: The unique identifiers for the object
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
/v4/generic/{uuid}:
get:
tags:
- sdn-generic
summary: get
description: Find an object by a unique identifier
operationId: get
parameters:
- name: uuid
in: path
description: The unique identifier for the query
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK - Request executed successfully
headers: {}
content:
'*/*':
schema: {}
'400':
description: Bad Request - Malformed content or invalid data provided
headers: {}
content:
'*/*':
schema: {}
'401':
description: Unauthorized - Authentication rejected
headers: {}
content:
'*/*':
schema: {}
'403':
description: Forbidden - Authorization rejected
headers: {}
content:
'*/*':
schema: {}
'404':
description: Not Found - Resource does not exist
headers: {}
content:
'*/*':
schema: {}
'409':
description: Conflict - System not ready
headers: {}
content:
'*/*':
schema: {}
'500':
description: Internal Server Error - Unrecognized system error
headers: {}
content:
'*/*':
schema: {}
deprecated: false
security:
- RESTToken:
- global
/v4/ietf/ethtsvc/l2-backhaul/{serviceUuid}/endpoint:
post:
tags:
- sdn-services
summary: addL2BackhaulEndpoint11
description: Add an endpoint to a L2 Backhaul Service
operationId: addL2BackhaulEndpoint11
parameters:
- name: serviceUuid
in: path
description: The unique identifier of the service to be modified
required: true
style: simple
schema:
type: string
requestBody:
description: ETH transport services access parameters
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/RequestNspEthtSvcAccessParameters'
- description: ETH transport services access parameters
required: false
responses:
'200':
description: OK - Request executed