IXON AssetTreeList API

The AssetTreeList API from IXON — 1 operation(s) for assettreelist.

OpenAPI Specification

ixon-assettreelist-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  contact:
    name: IXON B.V.
    url: https://www.ixon.cloud/
    email: support@ixon.cloud
  description: API for the IXON Cloud Platform
  license:
    name: All Rights Reserved
    url: https://www.ixon.cloud/
  title: IXON AccessRecoverList AssetTreeList API
  version: 0.1.294
servers:
- description: IXON Cloud platform server
  url: https://portal.ixon.cloud:443/api/
tags:
- name: AssetTreeList
paths:
  /asset-trees:
    put:
      tags:
      - AssetTreeList
      summary: AssetTreeList
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - type
                - data
                properties:
                  status:
                    type: string
                    default: success
                    nullable: false
                  type:
                    type: string
                    nullable: false
                  data:
                    type: object
                    nullable: true
        4XX:
          $ref: '#/components/responses/4XXErrorResponse'
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/apiApplication'
      - $ref: '#/components/parameters/apiCompany'
      - $ref: '#/components/parameters/apiBrandingOptional'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  nodes:
                    type: array
                    items:
                      oneOf:
                      - type: object
                        properties:
                          nodes:
                            type: array
                            items:
                              oneOf:
                              - type: object
                                properties:
                                  nodes:
                                    type: array
                                    items:
                                      oneOf:
                                      - type: object
                                        properties:
                                          reference:
                                            nullable: false
                                            type: object
                                        required:
                                        - reference
                                      - type: object
                                        properties:
                                          name:
                                            maxLength: 255
                                            minLength: 1
                                            nullable: false
                                            type: string
                                          resourceVariant:
                                            nullable: false
                                            type: object
                                        required:
                                        - name
                                        - resourceVariant
                                  reference:
                                    nullable: false
                                    type: object
                                required:
                                - reference
                              - type: object
                                properties:
                                  name:
                                    maxLength: 255
                                    minLength: 1
                                    nullable: false
                                    type: string
                                  resourceVariant:
                                    nullable: false
                                    type: object
                                required:
                                - name
                                - resourceVariant
                          reference:
                            nullable: false
                            type: object
                        required:
                        - reference
                      - type: object
                        properties:
                          name:
                            maxLength: 255
                            minLength: 1
                            nullable: false
                            type: string
                          resourceVariant:
                            nullable: false
                            type: object
                        required:
                        - name
                        - resourceVariant
                  reference:
                    nullable: false
                    type: object
                required:
                - reference
        description: You can give one item or a list of items
      security:
      - bearerToken: []
components:
  parameters:
    apiApplication:
      required: true
      description: Get your Application ID via support@ixon.cloud
      name: Api-Application
      in: header
      schema:
        type: string
        pattern: ^[0-9a-zA-Z]{12}$
    apiVersion:
      required: true
      description: Version of the API to use
      name: Api-Version
      in: header
      schema:
        type: integer
        format: int32
        enum:
        - 2
    apiBrandingOptional:
      required: false
      description: Domain that provides the branding
      name: Api-Branding
      in: header
      schema:
        type: string
        pattern: .+(\..[^.]+)
    apiCompany:
      required: true
      description: PublicId of the company
      name: Api-Company
      in: header
      schema:
        type: string
        pattern: ^(\d{4}-){4}\d{4}$
  responses:
    4XXErrorResponse:
      description: 4XX error response
      content:
        application/json:
          schema:
            type: object
            required:
            - status
            - type
            - data
            properties:
              status:
                type: string
                default: error
                nullable: false
              type:
                type: string
                default: Error
                nullable: false
              data:
                nullable: false
                type: array
                items:
                  $ref: '#/components/schemas/4XXErrorSchema'
  schemas:
    4XXErrorSchema:
      type: object
      properties:
        message:
          nullable: false
          type: string
        propertyName:
          nullable: true
          type: string
        listIndex:
          nullable: true
          type: integer
          format: int32
      required:
      - message
  securitySchemes:
    bearerToken:
      type: http
      description: Bearer token created by the endpoint "POST AccessTokenList"
      scheme: bearer
x-samples-languages:
- curl
- ruby
- javascript
- python
- powershell