openapi: 3.0.0
info:
  title: Accedian Skylight Vision
  description: >-
    The Skylight orchestrator Vision Module is Accedian’s Performance Element and Service Management System.The Skylight orchestrator Vision REST API gives access to most of the functionality of the Skylight orchestrator and to its inventory of performance elements and modules.


    The API is northbound, meaning that the API gives systems above it in the network hierarchy, access to the elements and performance monitoring information that it manages.


    It is also a REST (Representational State Transfer) API, meaning it can be used in an HTTP client to interact with Skylight orchestrator.You will be able to send GET, POST, PUT, and DELETE requests to Skylight orchestrator. Data is passed in both directions using JSON object notation.
  contact:
    email: apiteam@swagger.io
  version: '1.0.0'
servers:
- url: https://localhost/nbapiemswsweb/rest
  variables: {}
- url: http://localhost/nbapiemswsweb/rest
  variables: {}
paths:
  /CliScript:
    post:
      tags:
      - CLIScript
      summary: createCLIScript
      description: Create a new CLI Script
      operationId: createCLIScript
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /CliScript/{id}:
    put:
      tags:
      - CLIScript
      summary: updateCLIScript
      description: Update a CLI Script
      operationId: updateCLIScript
      parameters:
      - name: id
        in: path
        description: CLI Script persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - CLIScript
      summary: getCLIScript
      description: Get a CLI Script data
      operationId: getCLIScript
      parameters:
      - name: id
        in: path
        description: CLI Script persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - CLIScript
      summary: deleteCLIScript
      description: Delete a CLI Script
      operationId: deleteCLIScript
      parameters:
      - name: id
        in: path
        description: CLI Script persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowExecutor/{id}/param:
    post:
      tags:
      - ConfigFlowExecutor
      summary: setConfigFlowExecutorParam
      description: Set the token parameter values of this executor.
      operationId: setConfigFlowExecutorParam
      parameters:
      - name: id
        in: path
        description: Config flow executor persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowExecutor/{id}/start:
    post:
      tags:
      - ConfigFlowExecutor
      summary: startConfigFlowExecutor
      description: Start a config flow executor
      operationId: startConfigFlowExecutor
      parameters:
      - name: id
        in: path
        description: Config flow executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowExecutor/{id}/stop:
    post:
      tags:
      - ConfigFlowExecutor
      summary: stopConfigFlowExecutor
      description: Stop a config flow executor
      operationId: stopConfigFlowExecutor
      parameters:
      - name: id
        in: path
        description: Config flow executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowExecutor:
    post:
      tags:
      - ConfigFlowExecutor
      summary: createConfigFlowExecutor
      description: Create a new config flow executor
      operationId: createConfigFlowExecutor
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowExecutor/{id}/assign:
    post:
      tags:
      - ConfigFlowExecutor
      summary: assignConfigFlowExecutor
      description: Assign network elements to this executor
      operationId: assignConfigFlowExecutor
      parameters:
      - name: id
        in: path
        description: id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowExecutor/{id}:
    put:
      tags:
      - ConfigFlowExecutor
      summary: updateConfigFlowExecutor
      description: Edit an existing config flow executor
      operationId: updateConfigFlowExecutor
      parameters:
      - name: id
        in: path
        description: Config flow executor persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - ConfigFlowExecutor
      summary: getConfigFlowExecutor
      description: Get a config flow executor
      operationId: getConfigFlowExecutor
      parameters:
      - name: id
        in: path
        description: Config flow executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - ConfigFlowExecutor
      summary: deleteConfigFlowExecutor
      description: Delete a config flow executor
      operationId: deleteConfigFlowExecutor
      parameters:
      - name: id
        in: path
        description: Config flow executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigFlowProfile/{id}:
    get:
      tags:
      - ConfigFlowProfile
      summary: getConfigFlowProfile
      description: Get a config flow profile
      operationId: getConfigFlowProfile
      parameters:
      - name: id
        in: path
        description: Config flow profile persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigJob/{id}:
    get:
      tags:
      - ConfigJob
      summary: getConfigJob
      description: Get a config job
      operationId: getConfigJob
      parameters:
      - name: id
        in: path
        description: Config job persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigJobExecutor/{id}:
    get:
      tags:
      - ConfigJobExecutor
      summary: getConfigJobExecutor
      description: Get a config job executor
      operationId: getConfigJobExecutor
      parameters:
      - name: id
        in: path
        description: Config job executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigJobExecutor/{id}/start:
    post:
      tags:
      - ConfigJobExecutor
      summary: startConfigJobExecutor
      description: Start a config job executor
      operationId: startConfigJobExecutor
      parameters:
      - name: id
        in: path
        description: Config job executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /ConfigJobExecutor/{id}/stop:
    post:
      tags:
      - ConfigJobExecutor
      summary: stopConfigJobExecutor
      description: Stop a config job executor
      operationId: stopConfigJobExecutor
      parameters:
      - name: id
        in: path
        description: Config job executor persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Configuration/authenticationConfig:
    post:
      tags:
      - Configuration
      summary: setAuthenticationController
      description: Set the authentication configuration
      operationId: setAuthenticationController
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - Configuration
      summary: getAuthenticationConfiguration
      description: Get the authentication configuration
      operationId: getAuthenticationConfiguration
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Dataset/{id}:
    get:
      tags:
      - Dataset
      summary: getDataset
      description: Get a dataset data
      operationId: getDataset
      parameters:
      - name: id
        in: path
        description: Dataset persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Dataset
      summary: updateDataset
      description: Update a dataset
      operationId: updateDataset
      parameters:
      - name: id
        in: path
        description: Dataset persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Dataset
      summary: deleteDataset
      description: Delete a dataset
      operationId: deleteDataset
      parameters:
      - name: id
        in: path
        description: Dataset persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Dataset:
    post:
      tags:
      - Dataset
      summary: createDataset
      description: Create a new dataset
      operationId: createDataset
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Inventory/managedObject/{type}/{id}/{embeddedType}/{embeddedId}:
    get:
      tags:
      - Inventory
      summary: getEmbeddedManagedObject
      description: Get an embedded managed object
      operationId: getEmbeddedManagedObject
      parameters:
      - name: type
        in: path
        description: Managed object class type
        required: true
        style: simple
        schema:
          type: string
      - name: id
        in: path
        description: Managed object persistent id
        required: true
        style: simple
        schema:
          type: string
      - name: embeddedType
        in: path
        description: Embedded managed object class type
        required: true
        style: simple
        schema:
          type: string
      - name: embeddedId
        in: path
        description: Embedded managed object persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Inventory/managedObject/{type}/{id}:
    get:
      tags:
      - Inventory
      summary: getManagedObjectByTypeId
      description: Get a managed object by type and id
      operationId: getManagedObjectByTypeId
      parameters:
      - name: type
        in: path
        description: Managed object class type
        required: true
        style: simple
        schema:
          type: string
      - name: id
        in: path
        description: 'Managed object persistent id Type: long'
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Inventory/managedObject{dn}:
    get:
      tags:
      - Inventory
      summary: getManagedObjectByDN
      description: Get a managed object by DN
      operationId: getManagedObjectByDN
      parameters:
      - name: dn
        in: path
        description: Managed object dn
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Inventory/networkElement/{id}:
    post:
      tags:
      - Inventory
      summary: getManagedObjectNetworkElement
      description: Get managed objects for specified network element. If no type is specified then all managed objects are returned else only the ones for the specified types are.
      operationId: getManagedObjectNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Search/Inventory/managedObject/{type}:
    get:
      tags:
      - InventorySearch
      summary: searchManagedObject
      description: Execute a inventory search query for managed objects.
      operationId: searchManagedObject
      parameters:
      - name: type
        in: path
        description: The object type to search for.
        required: true
        style: simple
        schema:
          type: string
      - name: query
        in: query
        description: 'Search query arguments. There are two types of argument: Search options and Sorting options'
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: The desired page number, starting at 1.
        style: form
        explode: true
        schema:
          type: number
          format: double
      - name: limit
        in: query
        description: Number of objects per page. The maximum is 200 and cannot be changed.
        style: form
        explode: true
        schema:
          type: number
          format: double
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Search/Inventory/networkElements:
    post:
      tags:
      - InventorySearch
      summary: searchNetworkElements
      description: Execute a inventory search query for network elements and managed objects. If no managed object is specified then all of them will be looked for.
      operationId: searchNetworkElements
      parameters:
      - name: limit
        in: query
        description: Optional limit per page parameter
        style: form
        explode: true
        schema:
          type: number
          format: double
      - name: page
        in: query
        description: Optional page number parameter
        style: form
        explode: true
        schema:
          type: number
          format: double
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NECredential/{id}:
    put:
      tags:
      - NECredential
      summary: updateNECredential
      description: Update NE Credential
      operationId: updateNECredential
      parameters:
      - name: id
        in: path
        description: Credential persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - NECredential
      summary: getNECredential
      description: Get NE Credential
      operationId: getNECredential
      parameters:
      - name: id
        in: path
        description: Credential persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - NECredential
      summary: deleteNECredential
      description: Delete NE Credential
      operationId: deleteNECredential
      parameters:
      - name: id
        in: path
        description: Credential persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NECredential:
    post:
      tags:
      - NECredential
      summary: createNECredential
      description: Create NE Credential
      operationId: createNECredential
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NEInterface/{id}:
    get:
      tags:
      - NEInterface
      summary: getInterface
      description: Get an interface
      operationId: getInterface
      parameters:
      - name: id
        in: path
        description: Interface persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NEPort/{id}:
    get:
      tags:
      - NEPortInventory
      summary: getPort
      description: Get a port
      operationId: getPort
      parameters:
      - name: id
        in: path
        description: Port persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}/directCommand:
    post:
      tags:
      - NetworkElement
      summary: sendCommandToNetworkElement
      description: 'Send a command directly to the element.  Please note that commands having paging (the --More-- prompt) are not supported by this service.  The paging option must be explicitly added to the desired command to make it work properly otherwise command will timeout.  Example: vid-set show vid must be vid-set show vid paging disable'
      operationId: sendCommandToNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}/resynch:
    post:
      tags:
      - NetworkElement
      summary: networkElementResynch
      description: Network Element Resynch
      operationId: networkElementResynch
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}/addSubtend/{serial}:
    post:
      tags:
      - NetworkElement
      summary: addElementSubtendSerial
      description: Add an element that is in the element inventory
      operationId: addElementSubtendSerial
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      - name: serial
        in: path
        description: Element serial to add
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}/inventory:
    get:
      tags:
      - NetworkElement
      summary: getNetworkElementInventory
      description: See the network element inventory
      operationId: getNetworkElementInventory
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}/manage:
    post:
      tags:
      - NetworkElement
      summary: manageNetworkElement
      description: Manage the specified network element
      operationId: manageNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}/unmanage:
    post:
      tags:
      - NetworkElement
      summary: unmanageNetworkElement
      description: Unmanage the specified network element
      operationId: unmanageNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement/{id}:
    put:
      tags:
      - NetworkElement
      summary: updateNetworkElement
      description: Update Network Element
      operationId: updateNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    get:
      tags:
      - NetworkElement
      summary: getNetworkElement
      description: Get the specified network element
      operationId: getNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - NetworkElement
      summary: deleteNetworkElement
      description: Delete Network Element
      operationId: deleteNetworkElement
      parameters:
      - name: id
        in: path
        description: Network element persistent id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /NetworkElement:
    post:
      tags:
      - NetworkElement
      summary: createNetworkElement
      description: Create a new network element
      operationId: createNetworkElement
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /SAT/RFC2544/{id}:
    get:
      tags:
      - RFC2544ReportInfo
      summary: getRFC2544TestReport
      description: Get a RFC2544 test report
      operationId: getRFC2544TestReport
      parameters:
      - name: id
        in: path
        description: RFC2544 test report id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - RFC2544ReportInfo
      summary: deleteRFC2544TestReport
      description: Delete RFC2544 test report
      operationId: deleteRFC2544TestReport
      parameters:
      - name: id
        in: path
        description: RFC2544 test report id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /SAT/RFC2544/startTest:
    post:
      tags:
      - RFC2544ReportInfo
      summary: startRFC2544Test
      description: Start RFC2544 test
      operationId: startRFC2544Test
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /SAT/RFC2544/{id}/stopTest:
    post:
      tags:
      - RFC2544ReportInfo
      summary: stopRFC2544Test
      description: Stop RFC2544 test currently running
      operationId: stopRFC2544Test
      parameters:
      - name: id
        in: path
        description: RFC2544 test report id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Search/{type}:
    get:
      tags:
      - Search
      summary: searchNetworkElement
      description: Searching the Skylight orchestrator database is one of the most common requests to perform. The SearchController class of the API is used to get data on the objects stored in the Skylight orchestrator database.
      operationId: searchNetworkElement
      parameters:
      - name: type
        in: path
        description: The object type to search for.
        required: true
        style: simple
        schema:
          type: string
      - name: query
        in: query
        description: 'Search query arguments. There are two types of argument: Search options and Sorting options'
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: The desired page number, starting at 1.
        style: form
        explode: true
        schema:
          type: number
          format: double
      - name: limit
        in: query
        description: Number of objects per page. The maximum is 200 and cannot be changed.
        style: form
        explode: true
        schema:
          type: number
          format: double
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /Search:
    get:
      tags:
      - Search
      summary: listSearchObjects
      description: List available objects to search
      operationId: listSearchObjects
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /System/version:
    get:
      tags:
      - System
      summary: getSystemVersion
      description: Can be used to display which Skylight orchestrator version is running
      operationId: getSystemVersion
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /System/keepalive:
    get:
      tags:
      - System
      summary: keepalive
      description: Can be used to keep the session alive
      operationId: keepalive
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /System/time/timezone:
    get:
      tags:
      - System
      summary: getSystemTimezone
      description: Can be used to display the Skylight orchestrator server timezone
      operationId: getSystemTimezone
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /System/time:
    get:
      tags:
      - System
      summary: getSystemTime
      description: Get the Skylight orchestrator server date and timezone
      operationId: getSystemTime
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /System/time/timezone/offset:
    get:
      tags:
      - System
      summary: getSystemTimezoneOffset
      description: Get the Skylight orchestrator server timezone offset
      operationId: getSystemTimezoneOffset
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /SAT/Y1564/{id}:
    get:
      tags:
      - Y1564ReportInfo
      summary: getY1564TestReport
      description: Get a Y1564 test report
      operationId: getY1564TestReport
      parameters:
      - name: id
        in: path
        description: Y1564 test report id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Y1564ReportInfo
      summary: deleteY1564TestReport
      description: Delete a Y1564 test report
      operationId: deleteY1564TestReport
      parameters:
      - name: id
        in: path
        description: Y1564 test report id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /SAT/Y1564/startTest:
    post:
      tags:
      - Y1564ReportInfo
      summary: startY1564Test
      description: Start a Y1564 test
      operationId: startY1564Test
      parameters: []
      requestBody:
        description: body
        content:
          text/plain:
            schema:
              type: string
              description: body
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
  /SAT/Y1564/{id}/stopTest:
    post:
      tags:
      - Y1564ReportInfo
      summary: stopY1564Test
      description: Stop a Y1564 test currently running
      operationId: stopY1564Test
      parameters:
      - name: id
        in: path
        description: Y1564 test report id
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: string
                description: successful operation
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
tags:
- name: default
  description: ''
  externalDocs:
    url: http://swagger.io
- name: CLIScript
  description: Controller to access and modify CLI Scripts
- name: ConfigFlowExecutor
  description: Config Flow Executor Controller
- name: ConfigFlowProfile
  description: Config Flow Profile Controller
- name: ConfigJob
  description: Config Job Controller
- name: ConfigJobExecutor
  description: Config job executor controller
- name: Configuration
  description: Configuration Controller
- name: Dataset
  description: Dataset Controller
- name: Inventory
  description: Inventory Controller
- name: InventorySearch
  description: Inventory Search Controller
- name: NECredential
  description: Controller for NE credentials
- name: NEInterface
  description: NEInterface Controller
- name: NEPortInventory
  description: NE Port Inventory Controller
- name: NetworkElement
  description: Network Element Controller
- name: RFC2544ReportInfo
  description: RFC2544 Report Info Controller
- name: Search
  description: Search Controller
- name: System
  description: System Controller
- name: Y1564ReportInfo
  description: Y1564 Report Info Controller
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io