@itentialopensource/adapter-nokia_vitalqip

openapi: 3.0.0 info: title: VitalQIP RESTful APIs Document description: Sample call for RESTful APIs contact: {} version: '1.0.0' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com/api paths: /login: post: tags: - Authentication summary: getToken description: Get token operationId: getToken parameters: [] requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/QIPUser' - description: Request body required: true responses: '200': description: OK headers: Authentication: description: Token content: text/plain: schema: type: string description: Token Date: description: Date Time content: text/plain: schema: type: string description: Date Time Expire Time: description: Expire Time content: text/plain: schema: type: string description: Expire Time content: {} '401': description: Authentication failed headers: {} content: {} '500': description: Server error headers: {} content: {} deprecated: false /v1/{orgName}/v4network/{networkInfo}{extension}: get: tags: - V4 Network summary: getV4Network description: Get V4 network by name or address operationId: getV4Network parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: networkInfo in: path description: Network info (address or name of V4 network) required: true style: simple schema: type: string - name: extension in: path description: ".json if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/V4NetworkRec' - description: V4 Network model application/xml: schema: allOf: - $ref: '#/components/schemas/V4NetworkRec' - description: V4 Network model xml: name: V4NetworkRec attribute: false wrapped: false '400': description: '<address> is not an IPv4 network address. Network address should have format x.x.x.0 (x is a number between 1 and 255)' headers: {} content: {} '404': description: 'Network not found: [address=<address>]' headers: {} content: {} deprecated: false /v1/{orgName}/v4network/{networkInfo}: delete: tags: - V4 Network summary: deleteV4Network description: Delete V4 network by name or address operationId: deleteV4Network parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: networkInfo in: path description: Network info (address or name of V4 network) required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: {} '404': description: Network does not exist. headers: {} content: {} deprecated: false /v1/{orgName}/v4network: post: tags: - V4 Network summary: addV4Network description: Create a new V4 network operationId: addV4Network parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/V4NetworkRec' - description: Request body required: true responses: '201': description: Created headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '400': description: Bad request headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: Not Found headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '409': description: Conflict headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false /v1/{orgName}/v4network{extension}: get: tags: - V4 Network summary: searchV4Network description: Search V4 network by name or address. operationId: searchV4Network parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: address in: query description: V4 network address style: form explode: true schema: type: string - name: name in: query description: V4 network name style: form explode: true schema: type: string - name: pageSize in: query description: page size of response style: form explode: true schema: type: string - name: pageIndex in: query description: page index of response style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/V4NetworkRec' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/V4NetworkRec' description: '' xml: attribute: false wrapped: false '400': description: '<address> is not an IPv4 network address. Network address should have format x.x.x.0 (x is a number between 1 and 255)' headers: {} content: {} '404': description: 'Network not found: [address=<address>]' headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet/{address}/{prefixLength}{extension}: get: tags: - V6 Subnet summary: getV6SubnetByAddress description: Get V6 subnet get by address and prefix length. operationId: getV6SubnetByAddress parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: address in: path description: Address of V6 subnet required: true style: simple schema: type: string - name: prefixLength in: path description: prefix length of v6 subnet required: true style: simple schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/V6SubnetRec' - description: V6 Subnet model application/xml: schema: allOf: - $ref: '#/components/schemas/V6SubnetRec' - description: V6 Subnet model xml: name: V6SubnetRec attribute: false wrapped: false '404': description: Subnet not found headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet/{address}/{prefixLength}: delete: tags: - V6 Subnet summary: deleteV6SubnetByAddress description: Delete V6 Subnet by address and prefix length. operationId: deleteV6SubnetByAddress parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: address in: path description: Address of V6 subnet required: true style: simple schema: type: string - name: prefixLength in: path description: prefix length of v6 subnet required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: Subnet not found headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet/{address}/{prefixLength}/v6addresses{extension}: get: tags: - V6 Subnet summary: getV6AddressInV6SubnetByAddress description: Get list v6 address in v6 subnet by address and prefixlength. operationId: getV6AddressInV6SubnetByAddress parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: address in: path description: Address of V6 subnet required: true style: simple schema: type: string - name: prefixLength in: path description: prefix length of v6 subnet required: true style: simple schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/V6AddressRec' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/V6AddressRec' description: '' xml: attribute: false wrapped: false '404': description: Not found headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet/{address}/{prefixLength}/ranges{extension}: get: tags: - V6 Subnet summary: getListRangeInV6SubnetByAddress description: Get list range in v6 subnet by address and prefixlength. operationId: getListRangeInV6SubnetByAddress parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: address in: path description: Address of V6 subnet required: true style: simple schema: type: string - name: prefixLength in: path description: prefix length of v6 subnet required: true style: simple schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/V6AddressRec' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/V6AddressRec' description: '' xml: attribute: false wrapped: false '404': description: Not found headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet/{subnetName}{extension}: get: tags: - V6 Subnet summary: getV6SubnetByName description: Get V6 subnet by name operationId: getV6SubnetByName parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: subnetName in: path description: Name of V6 subnet required: true style: simple schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/V6SubnetRec' - description: V6 Subnet model application/xml: schema: allOf: - $ref: '#/components/schemas/V6SubnetRec' - description: V6 Subnet model xml: name: V6SubnetRec attribute: false wrapped: false '404': description: Subnet not found headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet/{subnetName}: delete: tags: - V6 Subnet summary: deleteV6SubnetByName description: Delete V6 Subnet by name operationId: deleteV6SubnetByName parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: subnetName in: path description: V6 Subnet's name required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: Subnet not found headers: {} content: {} deprecated: false /v1/{orgName}/v6subnet: post: tags: - V6 Subnet summary: addV6Subnet description: >- Creates a new V6 Subnet. Subnet Name and Address pairs are returned after adding subnets successfully. *Note:* Should not test this API on Swagger. Please use another REST Client (cURL, Postman). operationId: addV6Subnet parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string requestBody: description: The format of request body when creating a V6Subnet is different to the format of response when searching a V6Subnet. Please do not use it. content: application/json: schema: allOf: - $ref: '#/components/schemas/V6CreateSubnetRec' - description: The format of request body when creating a V6Subnet is different to the format of response when searching a V6Subnet. Please do not use it. required: true responses: '201': description: >- Successfully created subnets - <subnetsNo> <no><subnetName> - <subnetAddress> headers: {} content: {} '400': description: Bad request headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: >- Pool not found: [name=<name>, parent=<name>] Block not found headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '409': description: Subnet with this name already Exists in the Parent Pool. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false put: tags: - V6 Subnet summary: updateV6Subnet description: Modify a V6 Subnet operationId: updateV6Subnet parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/V6SubnetRec' - description: Request body required: true responses: '200': description: OK headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '400': description: Bad request headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: >- Pool not found: [name=<name>, parent=<name>] Block not found headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '409': description: Subnet with this name already Exists in the Parent Pool. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false /v1/{orgName}/v6subnet{extension}: get: tags: - V6 Subnet summary: searchV6Subnet description: Search V6 subnet by name or address. operationId: searchV6Subnet parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json - name: address in: query description: V6 Subnet address style: form explode: true schema: type: string - name: name in: query description: V6 Subet name style: form explode: true schema: type: string - name: pageSize in: query description: page size of response style: form explode: true schema: type: string - name: pageIndex in: query description: page index of response style: form explode: true schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/V6SubnetRec' description: '' application/xml: schema: type: array items: $ref: '#/components/schemas/V6SubnetRec' description: '' xml: attribute: false wrapped: false '404': description: Subnet not found headers: {} content: {} deprecated: false /v1/{orgName}/v6address: post: tags: - V6 Address summary: addV6Address description: Creates V6 Address operationId: addV6Address parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/V6AddressRec' - description: Request body required: true responses: '201': description: Created headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '400': description: 'Required Field(s) Missing: [field]' headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: Range not found. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '409': description: IPv6 address with the given IAID and DUID combination already exists within the parent subnet subnetAddress. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false put: tags: - V6 Address summary: updateV6Address description: Modify V6 Address operationId: updateV6Address parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/V6AddressRec' - description: Request body required: true responses: '200': description: OK headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: >- Address not found. UDA group not found: [name=<groupName>]. User Defined Attribute not found: [name=<udaName>]. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false /v1/{orgName}/v6address/{addressInfo}/: delete: tags: - V6 Address summary: deleteV6Address description: Delete V6 Address by name or address. The trailing slash is required. operationId: deleteV6Address parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: addressInfo in: path description: V6 address or name required: true style: simple schema: type: string responses: '200': description: OK headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: Address not found. headers: {} content: {} deprecated: false /v1/{orgName}/v6address/{addressInfo}{extension}: get: tags: - V6 Address summary: getV6Address description: Get V6 address by address or by name operationId: getV6Address parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: addressInfo in: path description: Address OR object name and domain name of V6 Address required: true style: simple schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/V6AddressRec' application/xml: schema: allOf: - $ref: '#/components/schemas/V6AddressRec' - xml: name: V6AddressRec attribute: false wrapped: false '404': description: Address not found. headers: {} content: {} deprecated: false /v1/{orgName}/v4subnet: post: tags: - V4 Subnet summary: addV4Subnet description: Creates V4 Subnet operationId: addV4Subnet parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/V4SubnetRec' - description: Request body required: true responses: '201': description: Created headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '400': description: >- Required Field(s) Missing: [field] UDA <uda> is required. UDA <uda>'s value is required. UDA <uda> in group <group> is required. UDA <uda>'s value in group <group> is required. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '409': description: Subnet address already exists headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false put: tags: - V4 Subnet summary: updateV4Subnet description: Modify V4 Subnet operationId: updateV4Subnet parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: orgName in: path description: Organization name required: true style: simple schema: type: string - name: isUpdate in: query description: update required: true style: form explode: true schema: type: boolean requestBody: description: Request body content: application/json: schema: allOf: - $ref: '#/components/schemas/V4SubnetRec' - description: Request body required: true responses: '200': description: OK headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '400': description: >- Or "<routeAddress>" is not an IPv4 address Or Invalid Attribute(s): <attributeName> Or The threshold is invalid. Valid warning type is in 0 - 3. Valid warning percent is in 0 - 99. Or Invalid input specified for [checkUsage] parameter. Required [true | false], Received [false1]. headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false '404': description: >- Or Subnet having address "<address>" does not exist. Or Domain <domainName> not found. Or The time server object <timeServer> does not exist. Or DHCP Server <dhcpServer> does not exist. Or DHCP Option Template not found: [dhcpOptionTemplate] Or DHCP Policy Template not found: [dhcpPolicyTemplate] Or DNS Server not found: [<dnsServerName>]" headers: {} content: {} '409': description: Subnet address already exists headers: {} content: application/json: schema: type: object application/xml: schema: type: object xml: name: response attribute: false wrapped: false deprecated: false /v1/{orgName}/v4subnet{extension}: get: tags: - V4 Subnet summary: searchV4Subnet description: Search V4 subnet by name or address. operationId: searchV4Subnet parameters: - name: Authentication in: header description: >- Token tokenValue or Basic username:password or Leave blank if using Client Certificate Authentication style: simple schema: type: string - name: Content-Type in: header description: >- application/xml application/json required: true style: simple schema: allOf: - $ref: '#/components/schemas/Content-Type' - description: >- application/xml application/json example: application/json - name: orgName in: path description: Organization Name required: true style: simple schema: type: string - name: address in: query description: V4 Subnet address style: form explode: true schema: type: string - name: name in: query description: V4 Subet name style: form explode: true schema: type: string - name: extension in: path description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" required: true style: simple schema: allOf: - $ref: '#/components/schemas/extension' - description: ".json or null if you want to reponse with JSON format \n.xml to reponse with XML format" example: .json responses: '200': description: OK headers: {}