@itentialopensource/adapter-tcpwave/report/adapter-openapi.yaml

This adapter integrates with system described as: tcpwaveRestapiStore.

openapi: 3.0.0
info:
  title: TCPWave RestAPI Store
  description: This API Calls allows the user with the appropriate privileges to add a network to the TCPWave IPAM. The parameters, parameter types, and the data types of the REST call are shown below. Execution of this REST call is audited by the TCPWave IPAM. Customers are advised to execute this REST API call in a non production environment before attempting to execute it in a production environment.
  contact: {}
  version: '1.0.0'
servers:
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/tims/rest
paths:
  /acls/create:
    post:
      tags:
      - Acl Service
      summary: aclCreate
      description: "Creates a new Access Control List (ACL) in the TCPWave IPAM. This list is used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc. ACL cannot be created when the object(s) or subnet(s) or network(s) used to create ACL are not managed in the IPAM.\n Below example shows sample request JSON: \n {\"aclElementList\":\\[{\"exclude\":0,\"sequence\":1,\"value\":\"10.2.3.5\"}\\],\"name\":\"test-client\",\"description\":\"Testing REST API\"}"
      operationId: aclCreate
      parameters: []
      requestBody:
        description: ACL details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AccessControlListACL'
              - description: ACL details
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-2002: ACL already exists, TIMS-2007: ACL name is not valid, TIMS-14049: Cannot create the ACL as managed object(s) or subnet(s) or network(s) with IP addresses <IP Address> are not available in IPAM,  TIMS-2007: The ACL name is not valid : <ACL name>'
          headers: {}
          content: {}
      deprecated: false
  /acls/update:
    post:
      tags:
      - Acl Service
      summary: aclUpdate
      description: "Updates an existing Access Control List(ACL) in the TCPWave IPAM. ACL cannot be updated when the object(s) or subnet(s) or network(s) used\n  to update ACL are not managed in the IPAM.\n Below example shows sample request JSON: \n {\"name\":\"test-client\",\"newName\":\"new-test-client\",\"description\":\"ACL added to the TCPWave IPAM by Professional Services\",\"aclElementList\":[{\"value\":\"10.24.6.8\",\"sequence\":\"1\",\"exclude\":\"0\"},{\"value\":\"10.24.6.9\",\"sequence\":\"2\",\"exclude\":\"0\"},{\"value\":\"10.24.11.9\",\"sequence\":\"3\",\"exclude\":\"0\"},{\"value\":\"10.24.15.8\",\"sequence\":\"4\",\"exclude\":\"0\"},{\"value\":\"10.1.1.1\",\"sequence\":\"5\",\"exclude\":\"0\"},{\"refAclName\":\"localnets\",\"sequence\":\"6\",\"exclude\":\"0\"}]}"
      operationId: aclUpdate
      parameters: []
      requestBody:
        description: ACL details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AccessControlListACL'
              - description: ACL details
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: >-
            TIMS-2001: ACL(s) not found,
             TIMS-2002: ACL already exists,
             TIMS-2006: ACL is not valid,
             TIMS-14050: Cannot update the ACL as managed object(s) or subnet(s) or network(s) with IP addresses {0} are not available in IPAM
             TIMS-1737: ACL object cannot be null.
          headers: {}
          content: {}
      deprecated: false
  /acls/list:
    get:
      tags:
      - Acl Service
      summary: aclList
      description: Obtains the list of Access Control List(ACL) defined and managed by the TCPWave IPAM which are used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.
      operationId: aclList
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccessControlListACL'
                description: successful operation
        '500':
          description: 'TIMS-2001: ACL(s) not found'
          headers: {}
          content: {}
      deprecated: false
  /acls/get:
    get:
      tags:
      - Acl Service
      summary: aclGet
      description: Provides the list of Access Control List(ACL) in the TCPWave IPAM which are used to control the behavior of DNS when applied to the Allow-Notify, Allow-Query, Allow-Transfer etc.
      operationId: aclGet
      parameters:
      - name: name
        in: query
        description: ACL Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AccessControlListACL'
                - description: This class represents an Access Control List(ACL) and contains the attributes necessary for ACL management functionality in TCPWave IPAM.  The information includes the name, value, sequence, DataList, ElementList  and other ACL related information.
        '500':
          description: 'TIMS-2001: ACL(s) not found'
          headers: {}
          content: {}
      deprecated: false
  /acls/getreferences:
    get:
      tags:
      - Acl Service
      summary: aclGetReferences
      description: Provides the list of Option Templates, Zone Templates and AD enabled Zones in the TCPWave IPAM which use specific Access Control List(ACL)
      operationId: aclGetReferences
      parameters:
      - name: name
        in: query
        description: ACL Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
        '500':
          description: 'TIMS-12004: ACL Reference(s) not found.'
          headers: {}
          content: {}
      deprecated: false
  /acls/multidelete:
    post:
      tags:
      - Acl Service
      summary: aclMultiDelete
      description: 'Deletes multiple existing Access Control Lists(ACLs) from the TCPWave IPAM data repository. This action is audited.  Below example shows sample request JSON: ["test-client"]'
      operationId: aclMultiDelete
      parameters: []
      requestBody:
        description: List of ACL names
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
              description: List of ACL names
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: >-
            TIMS-2001: ACL(s) not found,
             TIMS-1307: Root zone(s) does(do) not exist.
          headers: {}
          content: {}
      deprecated: false
  /acls/search:
    get:
      tags:
      - Acl Service
      summary: aclPage
      description: Provides the list of searched Access Control List(ACL) on search screen in the TCPWave IPAM.
      operationId: aclPage
      parameters:
      - name: page
        in: query
        description: Page Number
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: rows
        in: query
        description: Number of Rows
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedListAccessControlListACL'
      deprecated: false
  /activedirectory/useradd:
    post:
      tags:
      - Active Directory Service
      summary: adUserAdd
      description: >-
        Creates a mapping of existing Active Directory Domain Services (AD DS) to User Principal Name (UPN) into the TCPWave IPAM. A UPN is the name of a system user in an e-mail address format.Example: username@user.associated.internet.domain.

        Below example shows sample request JSON:

        {"dc_ip":"10.1.2.3","dnsDomainName":"apac.nsroot.net","dnsIp":"10.1.2.4","dnsServerName":"server1","encryption_type":"RC4-HMAC-NT","file_data":"File Data","file_name":"filename","principal_name":"server1@domain.com","principal_type":"KRB5_NT_PRINCIPAL","realm":"TCPWAVE.COM","service_type":"ServerType"}
      operationId: adUserAdd
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActiveDirectory'
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation,   TIMS-1312: Duplicate entry.'
          headers: {}
          content: {}
      deprecated: false
  /activedirectory/userlist:
    get:
      tags:
      - Active Directory Service
      summary: adUserList
      description: 'Obtains a list of Active Directory Domain Services (AD DS) User Principal Name (UPN) which Obtains a List of all permissions associated with a given admin group. Functional Admin can list the permissions of any admin group. Rest of the Admins are restricted to the admin groups that belong to their organization. A UPN is the name of a system user in an e-mail address format. Example: username@user.associated.internet.domain.'
      operationId: adUserList
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActiveDirectory'
                description: successful operation
      deprecated: false
  /activedirectory/delete:
    post:
      tags:
      - Active Directory Service
      summary: adUserDelete
      description: >-
        Removes mapping of existing Active Directory Domain Services (AD DS)  User Principal Name (UPN) from the TCPWave IPAM. Beloew example shows sample example

        [{

        "dnsIp": "192.168.0.215",

        "encryption_type": "RC4-HMAC-NT",

        "id": 8,

        "principal_name": "TCPWave00001Remote.domain.com",

        "principal_type": "KRB5_NT_PRINCIPAL",

        "realm": "DOMAIN.COM",

        "service_type": "LOCAL"

        }]
      operationId: adUserDelete
      parameters: []
      requestBody:
        description: List of ActiveDirectory details
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ActiveDirectory'
              description: List of ActiveDirectory details
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: >-
            TIMS-7003: You are not authorized to perform this operation

            TIMS-1203: Please select an Active Directory user principal (UPN) name to delete.
          headers: {}
          content: {}
      deprecated: false
  /activedirectory/authenticate:
    post:
      tags:
      - Active Directory Service
      summary: adUserAuthenticate
      description: "Validates authentication between TCPWave DNS and Active Directory Domain Services (AD DS) using Kerberos authentication to use the interoperability features provided by the Kerberos Key Distribution Center (KDC) service.\n Below example shows sample request JSON: \n {\"service_type\":\"DNS\",\"principal_name\":\"DEV-DNSROOT-AUTH-001.plab.tcpwave.com\",\"principal_type\":\"KRB5_NT_PRINCIPAL\",\"realm\":\"TCPWAVE.COM\",\"dnsIp\":\"10.1.10.187\",\"encryption_type\":\"RC4-HMAC-NT\",\"dc_ip\":\"10.1.10.170\"}"
      operationId: adUserAuthenticate
      parameters: []
      requestBody:
        description: ActiveDirectory details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ActiveDirectory'
              - description: ActiveDirectory details
        required: true
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: string
                description: successful operation
        '500':
          description: 'TIMS-1207: Please select an Active Directory user principal name (UPN) for authentication,'
          headers: {}
          content: {}
      deprecated: false
  /admingroup/delete:
    post:
      tags:
      - Admin Group Service
      summary: del
      description: "Deletes an existing Admin group.   Functional Admin can delete an Admin Group belonging to any organization. Super Admin and User Admin  can update Admin Groups only in the organization that they belong to. \n Below example shows sample request JSON: \n{\"name\":\"QA Admin group-1\",\"organization_name\":\"QAOrg\"}"
      operationId: del
      parameters:
      - name: id
        in: query
        description: Admin Group ID
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: Admin Group Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: organization_id
        in: query
        description: Organization ID associated with Admin Group
        style: form
        explode: true
        schema:
          type: string
      - name: organization_name
        in: query
        description: Organization Name associated with Admin Group
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-1140: Both admin group id and name cannot be null,   TIMS-1141: Admin group does not exist,  TIMS-1143: Admin group cannot be deleted as it is associated with existing users.'
          headers: {}
          content: {}
      deprecated: false
  /admingroup/update:
    post:
      tags:
      - Admin Group Service
      summary: edit
      description: "Updates an existing Admin group.   Functional Admin can update an Admin Group belonging to any organization. Super Admin and User Admin  can update Admin Groups only in the organization that they belong to.\n Below example shows sample request JSON: \n{ \"*name\"*:\"QA Admin group-1\", \"*oldName\"*:\"*QA Admin group\"*, \"*organization_name\"*:\"*QAOrg\"* \"description\":\"Admin group\"}"
      operationId: edit
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminGroup'
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-1101: Cannot find organization,  TIMS-1100: Both organization name and id cannot be null,  TIMS-1142: Admin group does not exist'
          headers: {}
          content: {}
      deprecated: false
  /admingroup/search:
    get:
      tags:
      - Admin Group Service
      summary: adminGroupPage
      description: 'Search all admin groups associated with an organization in the TCPWave IPAM. '
      operationId: adminGroupPage
      parameters:
      - name: page
        in: query
        description: total result pages
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: rows
        in: query
        description: rows per page
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedListAdminGroup'
      deprecated: false
  /admingroup/get:
    get:
      tags:
      - Admin Group Service
      summary: get
      description: Obtains details of all Admin Groups defined and managed by the TCPWave IPAM. Functional Admin gets the list of all admin groups. Rest of the Admins get only the list of admin  groups associated with the organization that they belong to.
      operationId: get
      parameters:
      - name: TIMS-Session-Token
        in: header
        description: Session token for authorization
        style: simple
        schema:
          type: string
      - name: admin_group_id
        in: query
        description: Admin Group ID
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: admin_group_name
        in: query
        description: Admin Group Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/AdminGroup'
                - description: This class contains detailed Information about Admin Group. The information includes the admin group name, organization name and description.
        '500':
          description: 'TIMS-1101: Cannot find organization.'
          headers: {}
          content: {}
      deprecated: false
  /admingroup/list:
    get:
      tags:
      - Admin Group Service
      summary: list
      description: Obtains a List of all Admin Groups defined and managed by the TCPWave IPAM. Functional Admin gets the list of all admin groups. Rest of the Admins get only the list of admin  groups associated with the organization that they belong to.
      operationId: list
      parameters:
      - name: org_id
        in: query
        description: Organization ID
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: org_name
        in: query
        description: Organization Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminGroup'
                description: successful operation
        '500':
          description: 'TIMS-1354: Organization does not exist.'
          headers: {}
          content: {}
      deprecated: false
  /admingroup/add:
    post:
      tags:
      - Admin Group Service
      summary: create
      description: "Creates a new admin group.   Functional Admin can create an Admin Group in any organization. Super Admin and User Admin can  create Admin Groups only in the organization that they belong to.\n Below example shows sample request JSON: \n{  \"*name\"*:\"QA Admin group\",  \"*organization_name\"*:\"QAOrg\",  \"*description\"*:\"*Admin group\"* }"
      operationId: create
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminGroup'
        required: false
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-1101: Cannot find organization,  TIMS-1100: Both organization name and id cannot be null,  TIMS-1401: Admin group already defined'
          headers: {}
          content: {}
      deprecated: false
  /alarmSubscription/categoryList:
    get:
      tags:
      - Alarm Subscription Service
      summary: categoryList
      description: Obtains a list of monitored service categories to subscribe for email notifications in the TCPWave IPAM.
      operationId: categoryList
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                description: successful operation
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation'
          headers: {}
          content: {}
      deprecated: false
  /alarmSubscription/thresholdList:
    get:
      tags:
      - Alarm Subscription Service
      summary: listCategoryMonitorService
      description: Obtains a list of monitoring services for the given category to subscribe for alarm notifications in the TCPWave IPAM.
      operationId: listCategoryMonitorService
      parameters:
      - name: category
        in: query
        description: Category
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MonitorInformation'
                description: successful operation
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation'
          headers: {}
          content: {}
      deprecated: false
  /alarmSubscription/componentList:
    get:
      tags:
      - Alarm Subscription Service
      summary: listComponents
      description: Obtains a list of components such as Network, Subnet, Zone, IPAM etc for the given monitoring services in the TCPWave IPAM.
      operationId: listComponents
      parameters:
      - name: serviceList
        in: query
        description: Comma separated list of monitoring services
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: orgName
        in: query
        description: Organization name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: draw
        in: query
        description: Page Draw Param
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: Starting Appliance Group Range
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: length
        in: query
        description: Page Length
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: filterRules
        in: query
        description: Filter String
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: Sort String
        style: form
        explode: true
        schema:
          type: string
      - name: order
        in: query
        description: Sort Order(asc/desc)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListComponent'
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation'
          headers: {}
          content: {}
      deprecated: false
  /alarmSubscription/add:
    post:
      tags:
      - Alarm Subscription Service
      summary: addSubscriptions
      description: 'Create alarm subscriptions in the TCPWave IPAM. Alarm Subscriptions are used to send email notifications to the subscribed users in the TCPWave IPAM.  '
      operationId: addSubscriptions
      parameters: []
      requestBody:
        description: Subscription List
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AlarmSubscription'
              description: Subscription List
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation,TIMS-8338: Alarm Subscription does not exist,8339 = TIMS-8339: Alarm Component type does not exist,8340 = TIMS-8340: Monitoring threshold does not exist.'
          headers: {}
          content: {}
      deprecated: false
  /alarmSubscription/delete:
    post:
      tags:
      - Alarm Subscription Service
      summary: deleteSubscription
      description: 'Delete alarm subscriptions from the TCPWave IPAM. Alarm Subscriptions are used to send email notifications to the subscribed users in the TCPWave IPAM.  '
      operationId: deleteSubscription
      parameters: []
      requestBody:
        description: List of alarm subscriptions
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AlarmSubscription'
              description: List of alarm subscriptions
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation,TIMS-8338: Alarm Subscription does not exist,8339 = TIMS-8339: Alarm Component type does not exist.'
          headers: {}
          content: {}
      deprecated: false
  /alarmSubscription/list:
    get:
      tags:
      - Alarm Subscription Service
      summary: Getlist
      description: 'Provides the list of all available subscriptions in the TCPWave IPAM. Subscriptions are used to send email notifications to the subscribed users in the TCPWave IPAM.  '
      operationId: Getlist
      parameters:
      - name: draw
        in: query
        description: Page Draw Param
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: Starting Appliance Group Range
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: length
        in: query
        description: Page Length
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: filterRules
        in: query
        description: Filter String
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: Sort String
        style: form
        explode: true
        schema:
          type: string
      - name: order
        in: query
        description: Sort Order(asc/desc)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListAlarmSubscription'
        '500':
          description: 'TIMS-7003: You are not authorized to perform this operation'
          headers: {}
          content: {}
      deprecated: false
  /algo/tsiglist:
    get:
      tags:
      - Algorithm Service
      summary: tsigList
      description: Obtains a list of Transaction Signature(TSIG) key algorithms supported by the TCPWave IPAM.
      operationId: tsigList
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Algorithm'
                description: successful operation
      deprecated: false
  /algo/list:
    get:
      tags:
      - Algorithm Service
      summary: Getlist1
      description: Obtains a list of valid DNS signing algorithms in the TCPWave IPAM.
      operationId: Getlist1
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Algorithm'
                description: successful operation
      deprecated: false
  /appliancegroup/edit:
    post:
      tags:
      - Appliance Group Service
      summary: Postedit
      description: "Updates an existing appliance group in the TCPWave IPAM. Functional and Super Admins can edit an Appliance group in any organization.\n Below example shows sample request JSON: \n {\"name\":\"app-group-1\",\"organization_name\":\"QAOrg\"\"description\":\"Appliance group\"\"prevAppGroupName\":\"app-group\",}"
      operationId: Postedit
      parameters: []
      requestBody:
        description: Group of appliances, using for patch.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApplianceGroup'
              - description: Group of appliances, using for patch.
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: A appliance group with the given name already exists.
          headers: {}
          content: {}
      deprecated: false
  /appliancegroup/references:
    get:
      tags:
      - Appliance Group Service
      summary: getApplainceGroupReferences
      description: Retrieves the list of appliances that are associated to the appliance group in the TCPWave IPAM.
      operationId: getApplainceGroupReferences
      parameters:
      - name: name
        in: query
        description: Appliance Group Name
        style: form
        explode: true
        schema:
          type: string
      - name: organization
        in: query
        description: Organization Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MonitoringHierarchy'
                description: successful operation
        '500':
          description: 'TIMS-12074: Appliance group name cannot be null.'
          headers: {}
          content: {}
      deprecated: false
  /appliancegroup/get:
    get:
      tags:
      - Appliance Group Service
      summary: getApplianceGroup
      description: "Retrieves the details of an appliance group in the TCPWave IPAM.\n Below example shows sample request URL: \n /rest/appliancegroup/get?name=app-group-1256&organization=Internal"
      operationId: getApplianceGroup
      parameters:
      - name: name
        in: query
        description: Appliance Group Name
        style: form
        explode: true
        schema:
          type: string
      - name: organization
        in: query
        description: Organization Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ApplianceGroup'
                - description: Detailed information about Appliance Group model.
        '500':
          description: 'TIMS-12074: Appliance group name cannot be null.'
          headers: {}
          content: {}
      deprecated: false
  /appliancegroup/delete:
    get:
      tags:
      - Appliance Group Service
      summary: deleteApplianceGroup
      description: "Deletes the Appliance group present in the TCPWave IPAM. Functional Admins can delete an Appliance group in any organization. Other Admins can delete the Appliance groups belonging to their organization only.\n Below example shows sample request URL: \n /rest/appliancegroup/delete?name=app-group-new&organization=Internal"
      operationId: deleteApplianceGroup
      parameters:
      - name: name
        in: query
        description: Appliance Group Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: organization
        in: query
        description: Organization Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-2051: Appliance group is not deleted as it is being used.'
          headers: {}
          content: {}
      deprecated: false
  /appliancegroup/listbyorg:
    get:
      tags:
      - Appliance Group Service
      summary: listByOrg
      description: "Provides a list of Appliance groups present in an organization.\n Below example shows sample request URL: \n /rest/appliancegroup/listbyorg?organization=QAOrg"
      operationId: listByOrg
      parameters:
      - name: organization
        in: query
        description: Organization Name
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApplianceGroup'
                description: successful operation
      deprecated: false
  /appliancegroup/search:
    get:
      tags:
      - Appliance Group Service
      summary: applianceGroupSearchPage
      description: Lists information of appliance groups resulted from global search in TCPWave IPAM.
      operationId: applianceGroupSearchPage
      parameters:
      - name: draw
        in: query
        description: Page Draw Param
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: Starting ApplianceGroup Range
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: length
        in: query
        description: Page Length
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: user_id
        in: query
        description: userId
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: filterRules
        in: query
        description: Filter String
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: Sort String
        style: form
        explode: true
        schema:
          type: string
      - name: order
        in: query
        description: Sort Order(asc/desc)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListApplianceGroup'
      deprecated: false
  /appliancegroup/list:
    get:
      tags:
      - Appliance Group Service
      summary: Getlist12
      description: Provides a list of Appliance groups present in the TCPWave IPAM.
      operationId: Getlist12
      parameters:
      - name: draw
        in: query
        description: Page Draw Param
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: Starting Appliance Group Range
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: length
        in: query
        description: Page Length
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: filterRules
        in: query
        description: Filter String
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: Sort String
        style: form
        explode: true
        schema:
          type: string
      - name: order
        in: query
        description: Sort Order(asc/desc)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListApplianceGroup'
      deprecated: false
  /appliancegroup/add:
    post:
      tags:
      - Appliance Group Service
      summary: Postcreate
      description: "Creates a new appliance group in the TCPWave IPAM. Functional admins can add an appliance group in any organization. Super admins can add an appliance group in their own organization only.\n Below example shows sample request JSON: \n{\"name\":\"app-group\",\"organization_name\":\"QAOrg\",\"description\":\"Appliance group\"}"
      operationId: Postcreate
      parameters: []
      requestBody:
        description: Group of appliances, using for patch.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ApplianceGroup'
              - description: Group of appliances, using for patch.
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: An appliance group with the given name already exists.
          headers: {}
          content: {}
      deprecated: false
  /asset/edit:
    post:
      tags:
      - Asset Service
      summary: Postedit1
      description: "Updates an existing asset defined in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation. \n Below example shows sample request JSON: \n {\"service_tag\":\"Asset1\",\"serial_num\":\"12345\",\"vendor\":\"CISCO\",\"name\":\"EXAMPLE-ROUTER\",\"model\":\"ASR10\",\"acquisition_type\":\"Merger and Acquisition\",\"cpu\":\"2\",\"capacity\":\"unlimited\",\"os_version\":\"IOS 11.0\",\"maintenance_cost\":\"500\",\"purchase_cost\":\"10000\",\"city\":\"Salem\",\"green_zone\":\"false\",\"disposal_reason\":\"Trash\",\"description\":\"Remove City or add country\",\"purchase_dt\":\"2017-08-23T00:00:00.000Z\",\"warranty_end_dt\":\"2017-08-23T00:00:00.000Z\",\"disposal_dt\":\"2017-08-23T00:00:00.000Z\",\"previousAssetSerTag\":\"Asset\"} "
      operationId: Postedit1
      parameters: []
      requestBody:
        description: Asset details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Asset'
              - description: Asset details
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: >-
            TIMS-1701: Please select a single asset to edit.
             TIMS-1702: Please select an asset to edit.
          headers: {}
          content: {}
      deprecated: false
  /asset/deleteAll:
    post:
      tags:
      - Asset Service
      summary: deleteAll
      description: "Deletes the given assets defined in the TCPWave IPAM. This API accepts the list of Asset names to delete.\n Below example shows sample request JSON: \n  [\"*Asset*\"]"
      operationId: deleteAll
      parameters: []
      requestBody:
        description: List of asset service tags
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
              description: List of asset service tags
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: >-
            TIMS-1703: Please select an asset to delete.
             TIMS-7778: The Asset cannot be deleted as it is being referred from object(s): {0}
             TIMS-7779: Invalid Asset specified: {0}
          headers: {}
          content: {}
      deprecated: false
  /asset/get:
    get:
      tags:
      - Asset Service
      summary: Getget
      description: 'Provides the details of a given asset defined in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation. '
      operationId: Getget
      parameters:
      - name: service_tag
        in: query
        description: Asset Service Tag
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Asset'
                - description: This class represents an Asset and contains the attributes necessary for asset management functionality in TCPWave IPAM.  The information includes the service tag and other manufacturing information, the cost and acquisition details, maintenance and warranty information, physical location and OS and related information.
        '500':
          description: 'TIMS-7779: Invalid Asset specified: {0}.'
          headers: {}
          content: {}
      deprecated: false
  /asset/list:
    get:
      tags:
      - Asset Service
      summary: Getlist123
      description: 'Obtains a list of assets defined and managed by the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation. '
      operationId: Getlist123
      parameters: []
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Asset'
                description: successful operation
      deprecated: false
  /asset/add:
    post:
      tags:
      - Asset Service
      summary: Postcreate1
      description: "Creates a new asset in the TCPWave IPAM. An asset can be associated to an object so that an IP Address can be associated to a service tag number for proper inventory reconciliation. \n Below example shows sample request JSON: \n {\"service_tag\":\"Asset\",\"serial_num\":\"12345\",\"vendor\":\"CISCO\",\"name\":\"EXAMPLE-ROUTER\",\"model\":\"ASR10\",\"acquisition_type\":\"Merger and Acquisition\",\"cpu\":\"2\",\"capacity\":\"unlimited\",\"os_version\":\"IOS 11.0\",\"maintenance_cost\":\"500\",\"purchase_cost\":\"10000\",\"city\":\"Trash\",\"green_zone\":\"false\",\"disposal_reason\":\"Salem\",\"description\":\"Remove City or add country\",\"purchase_dt\":\"2017-08-23T00:00:00.000Z\",\"warranty_end_dt\":\"2017-08-23T00:00:00.000Z\",\"disposal_dt\":\"2017-08-23T00:00:00.000Z\"}"
      operationId: Postcreate1
      parameters: []
      requestBody:
        description: Asset details
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Asset'
              - description: Asset details
        required: true
      responses:
        '200':
          description: ''
          headers: {}
          content: {}
        '500':
          description: 'TIMS-7777: Specified asset already exists.'
          headers: {}
          content: {}
      deprecated: false
  /auditbackup/reportlistbydate:
    get:
      tags:
      - Audit data Backup Files Service
      summary: getReportRecordsForGrid
      description: "Obtains a backup report in grid in the TCPWave IPAM. \n Below are the sample query parameter values accepted: \n Starting date for fetching records:02/22/2019 \n Ending date for fetching records :02/22/2019 \n Page Draw Param:1 \n Starting Page Number:1 \n Page Length:20 \n Filter string: \n Sort String: \n order param(asc/desc): \n"
      operationId: getReportRecordsForGrid
      parameters:
      - name: fromDate
        in: query
        description: Starting date for fetching records
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: toDate
        in: query
        description: Ending date for fetching records
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: draw
        in: query
        description: Page Draw Param
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: start
        in: query
        description: Starting Page Number
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: length
        in: query
        description: Page Length
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: filterRules
        in: query
        description: Filter String
        style: form
        explode: true
        schema:
          type: string
      - name: sort
        in: query
        description: Sort String
        style: form
        explode: true
        schema:
          type: string
      - name: order
        in: query
        description: order param(asc/desc)
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedListAuditReportDetails'
        '500':
          description: 'TIMS-8059: Please select report start date.  TIMS-8060: Please select report end date.'
          headers: {}
          content: {}
      deprecated: false
  /auditbackup/upload:
    post:
      tags:
      - Audit data Backup Files Service
      summary: upload
      description: Uploads a new audit backup file in the TCPWave IPAM.
      operationId: upload
      parameters: []
      requestBody:
        description: Audit Backup files details