github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/components/device-component.openapi.yml (about)

     1  openapi: 3.0.3
     2  info:
     3    title: Device Component
     4    description: Component
     5    version: 1.0.0
     6  
     7  paths: {}
     8  
     9  components:
    10    schemas:
    11      MultipleDevice:
    12        type: object
    13        required:
    14          - total
    15          - devices
    16        properties:
    17          total:
    18            type: integer
    19            format: int64
    20          devices:
    21            type: array
    22            items:
    23              $ref: "#/components/schemas/Device"
    24      SingleDevice:
    25        type: object
    26        required:
    27          - device
    28        properties:
    29          device:
    30            $ref: "#/components/schemas/Device"
    31      DeviceInfo:
    32        type: object
    33        properties:
    34          resource_owner_id:
    35            type: string
    36            format: uuid
    37          name:
    38            type: string
    39            pattern: \A.{1,100}\z
    40          id_number:
    41            type: string
    42            pattern: \A.{0,100}\z
    43          description:
    44            type: string
    45            pattern: \A.{0,1000}\z
    46          display_info:
    47            type: array
    48            items:
    49              $ref: './general.yml#/components/schemas/DisplayInfo'
    50          client_id_list:
    51            type: array
    52            description: |-
    53              クライアントIDリスト。デバイスコンテキストのクライアントが必要な場合(is_managedをmanagedかfull_managedに設定する場合)、対応するエージェント等、デバイス上で動作させるクライアントのIDと公開鍵を指定する。複数ある場合、すべて登録すること。
    54            items:
    55              type: string
    56          is_managed:
    57            type: string
    58            enum: [unmanaged, managed, full_managed]
    59            description: |-
    60              該当デバイスの管理方法についての区分。
    61  
    62              管理外：unmanaged
    63              ・・・該当デバイス情報に情報を持たせるのみの場合、こちらを選択。
    64              一部管理：managed
    65              ・・・該当デバイス情報に情報を持たせ、かつ当サービス以外システム（アプリ）にて管理される場合、こちらを選択。
    66              完全管理：full_managed（次期対応検討内容）
    67              ・・・該当デバイス情報に情報を持たせ、かつ当サービス以外システム（アプリ）およびデバイスエージェント（キッティング、ファームウェアアップデート等行う機構）にて管理される場合、こちらを選択。
    68          rsa_publickey:
    69            type: string
    70            description: RSAの公開鍵をPEM形式で設定する。クライアントIDを指定する場合必須。
    71          custom_inventory:
    72            description: 付帯情報リスト
    73            type: array
    74            items: { }
    75        required:
    76          - resource_owner_id
    77      Device:
    78        type: object
    79        required:
    80          - id
    81          - resource_owner_id
    82          - created_at
    83          - updated_at
    84        properties:
    85          id:
    86            type: string
    87          resource_owner_id:
    88            type: string
    89          name:
    90            type: string
    91          id_number:
    92            type: string
    93          description:
    94            type: string
    95          display_info:
    96            $ref: './general.yml#/components/schemas/DisplayInfo'
    97          client_list:
    98            type: array
    99            items:
   100              $ref: "#/components/schemas/Client"
   101          is_managed:
   102            type: string
   103            enum: [unmanaged, managed, full_managed]
   104          rsa_publickey:
   105            type: string
   106          custom_inventory:
   107            type: array
   108            items: { }
   109          created_at:
   110            type: string
   111            description: 最終更新時間
   112          updated_at:
   113            type: string
   114            description: 作成時間
   115          activated_at:
   116            type: string
   117            description: アクティベート時間。is_managedがfull_managedの場合のみ表示
   118          monitoring_status:
   119            type: string
   120            description: |-
   121              ok:正常,
   122              error:エラー,
   123              offline:オフライン、
   124              Null:監視状態なし
   125            enum: [ok, error, offline]
   126      Client:
   127        type: object
   128        properties:
   129          application_client:
   130            $ref: '#/components/schemas/ApplicationClient'
   131          device_client:
   132            $ref: '#/components/schemas/DeviceClient'
   133      ApplicationClient:
   134        type: object
   135        properties:
   136          client_id:
   137            type: string
   138      DeviceClient:
   139        type: object
   140        properties:
   141          client_id:
   142            type: string
   143          client_secret:
   144            type: string
   145          rsa_publickey:
   146            type: string
   147            description: PEM
   148          display_name:
   149            type: string
   150      DeviceUpdateRequest:
   151        type: object
   152        properties:
   153          name:
   154            type: string
   155          id_number:
   156            type: string
   157          description:
   158            type: string
   159          display_info:
   160            $ref: './general.yml#/components/schemas/DisplayInfo'
   161          client_id_list:
   162            type: array
   163            items:
   164              type: string
   165          is_managed:
   166            type: string
   167            description: |-
   168              該当デバイスの管理方法についての区分。8
   169  
   170              管理外：unmanaged
   171              ・・・該当デバイス情報に情報を持たせるのみの場合、こちらを選択。
   172              一部管理：managed
   173              ・・・該当デバイス情報に情報を持たせ、かつ当サービス以外システム（アプリ）にて管理される場合、こちらを選択。
   174              完全管理：full_managed
   175              ・・・該当デバイス情報に情報を持たせ、かつ当サービス以外システム（アプリ）およびデバイスエージェント（キッティング、ファームウェアアップデート等行う機構）にて管理される場合、こちらを選択。
   176            enum: [unmanaged, managed, full_managed]
   177          rsa_publickey:
   178            type: string
   179          custom_inventory:
   180            type: array
   181            items: { }
   182      MultipleDeviceMonitoring:
   183        type: object
   184        required:
   185          - total
   186          - monitorings
   187        properties:
   188          total:
   189            type: integer
   190            format: int64
   191          monitorings:
   192            type: array
   193            items:
   194              $ref: '#/components/schemas/DeviceMonitoring'
   195      SingleDeviceMonitoring:
   196        type: object
   197        required:
   198          - monitoring
   199        properties:
   200          monitoring:
   201            $ref: '#/components/schemas/DeviceMonitoring'
   202      DeviceMonitoring:
   203        type: object
   204        required:
   205          - device_id
   206        properties:
   207          device_id:
   208            type: string
   209          timestamp:
   210            type: string
   211          connection_status:
   212            type: string
   213          monitoring_status:
   214            type: string
   215          error_message:
   216            type: string
   217          perfomance:
   218            $ref: '#/components/schemas/DevicePerformance'
   219          connected_device_results:
   220            type: array
   221            items:
   222              $ref: '#/components/schemas/ConnectedDeviceResult'
   223      DeviceMonitoringIDsRequest:
   224        type: object
   225        required:
   226          - device_ids
   227        properties:
   228          device_ids:
   229            type: array
   230            items:
   231              type: string
   232      DevicePerformance:
   233        type: object
   234        properties:
   235          used_cpu_rate:
   236            type: string
   237          total_memory:
   238            type: string
   239          used_memory:
   240            type: string
   241          used_memory_rate:
   242            type: string
   243          total_disk:
   244            type: string
   245          used_disk:
   246            type: string
   247          used_disk_rate:
   248            type: string
   249      ConnectedDeviceResult:
   250        type: object
   251        properties:
   252          name:
   253            type: string
   254          device_number:
   255            type: string
   256          device_type:
   257            type: string
   258          timestamp:
   259            type: string
   260          status:
   261            type: string
   262          error_message:
   263            type: string
   264          custom_items:
   265            type: string
   266      MultipleDevicePolicy:
   267        type: object
   268        required:
   269          - total
   270          - policies
   271        properties:
   272          total:
   273            type: integer
   274            format: int64
   275          policies:
   276            type: array
   277            items:
   278              $ref: '#/components/schemas/DevicePolicy'
   279      DevicePolicy:
   280        type: object
   281        required:
   282          - policy_id
   283          - resource_owner_id
   284          - created_at
   285          - updated_at
   286        properties:
   287          policy_id:
   288            type: string
   289          activation_key:
   290            type: string
   291          resource_owner_id:
   292            type: string
   293          created_at:
   294            type: string
   295          updated_at:
   296            type: string
   297      DevicePolicyRequest:
   298        type: object
   299        required:
   300          - resource_owner_id
   301        properties:
   302          resource_owner_id:
   303            type: string
   304      DeviceInventory:
   305        type: object
   306      ComponentTypeEnum:
   307        enum:
   308          - product
   309          - unit
   310          - parts
   311          - sensor
   312          - software
   313          - instrument
   314      Inventory:
   315        type: object
   316        properties:
   317          serial_number:
   318            type: string
   319          resource_owner_id:
   320            type: string
   321          start_at:
   322            type: string
   323          custom_inventory:
   324            type: object
   325            example:
   326              001: bnu4hbnrmflais1m02e1
   327              002: bnu4hbnrmflais1m02e2
   328              003: bnu4hbnrmflais1m02e3
   329              004: bnu4hbnrmflais1m02e4
   330              005: bnu4hbnrmflais1m02e5
   331              006: bnu4hbnrmflais1m02e6
   332              007: bnu4hbnrmflais1m02e7
   333              008: bnu4hbnrmflais1m02e8
   334              009: bnu4hbnrmflais1m02e9
   335              010: bnu4hbnrmflais1m02e0
   336  
   337      DeviceClientRequest:
   338        type: object
   339        properties:
   340          client_id_list:
   341            type: array
   342            items:
   343              $ref: '#/components/schemas/DeviceClientRsaKey'
   344      DeviceClientRsaKey:
   345        type: object
   346        required:
   347          - client_id
   348          - rsa_publickey
   349        properties:
   350          client_id:
   351            type: string
   352          rsa_publickey:
   353            type: string
   354      DeviceClientList:
   355        type: object
   356        properties:
   357          client_list:
   358            type: array
   359            items:
   360              $ref: '#/components/schemas/Client'
   361      SingleDeviceClientList:
   362        type: object
   363        properties:
   364          client_list:
   365            $ref: '#/components/schemas/Client'
   366  
   367      RsaPublicKey:
   368        type: object
   369        required:
   370          - rsa_publickey
   371        properties:
   372          rsa_publickey:
   373            type: string