github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/openapis/deviceasset.openapi.yml (about) 1 openapi: "3.0.3" 2 info: 3 version: 1.0.0 4 title: Cios Device Asset Management Openapi 5 6 paths: 7 '/v2/device_models': 8 post: 9 tags: 10 - device-asset 11 operationId: createDeviceModel 12 requestBody: 13 required: true 14 content: 15 application/json: 16 schema: 17 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/DeviceModelRequest' 18 responses: 19 200: 20 description: "Processing success" 21 content: 22 application/json: 23 schema: 24 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceModel' 25 400: 26 $ref: '../components/responses.yml#/components/responses/BadRequest' 27 401: 28 $ref: '../components/responses.yml#/components/responses/InvalidToken' 29 403: 30 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 31 409: 32 $ref: '../components/responses.yml#/components/responses/Conflict' 33 500: 34 $ref: '../components/responses.yml#/components/responses/InternalServerError' 35 503: 36 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 37 get: 38 tags: 39 - device-asset 40 operationId: getDeviceModels 41 parameters: 42 - $ref: '../components/parameters.yml#/components/parameters/offset' 43 - $ref: '../components/parameters.yml#/components/parameters/limit' 44 - $ref: '../components/parameters.yml#/components/parameters/order' 45 - $ref: '../components/parameters.yml#/components/parameters/order_by' 46 - $ref: '../components/parameters.yml#/components/parameters/name_query' 47 - $ref: '../components/parameters.yml#/components/parameters/maker_id' 48 - $ref: '../components/parameters.yml#/components/parameters/version' 49 - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id' 50 - $ref: '../components/parameters.yml#/components/parameters/component_key' 51 - $ref: '../components/parameters.yml#/components/parameters/component_value' 52 responses: 53 200: 54 description: "Processing success" 55 content: 56 application/json: 57 schema: 58 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/MultipleDeviceModel' 59 400: 60 $ref: '../components/responses.yml#/components/responses/BadRequest' 61 401: 62 $ref: '../components/responses.yml#/components/responses/InvalidToken' 63 403: 64 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 65 500: 66 $ref: '../components/responses.yml#/components/responses/InternalServerError' 67 501: 68 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 69 security: 70 - bearerAuth: [] 71 '/v2/device_models/{name}': 72 get: 73 tags: 74 - device-asset 75 operationId: getDeviceModel 76 parameters: 77 - $ref: '../components/parameters.yml#/components/parameters/name' 78 responses: 79 200: 80 description: "Processing success" 81 content: 82 application/json: 83 schema: 84 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceModel' 85 400: 86 $ref: '../components/responses.yml#/components/responses/BadRequest' 87 401: 88 $ref: '../components/responses.yml#/components/responses/InvalidToken' 89 403: 90 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 91 404: 92 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 93 500: 94 $ref: '../components/responses.yml#/components/responses/InternalServerError' 95 503: 96 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 97 security: 98 - bearerAuth: [] 99 patch: 100 description: maker_id, version及びcomponentsが更新可能 101 tags: 102 - device-asset 103 operationId: updateDeviceModel 104 parameters: 105 - $ref: '../components/parameters.yml#/components/parameters/name' 106 requestBody: 107 required: true 108 content: 109 application/json: 110 schema: 111 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/DeviceModelUpdateRequest' 112 responses: 113 200: 114 description: "Processing success" 115 content: 116 application/json: 117 schema: 118 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceModel' 119 120 400: 121 $ref: '../components/responses.yml#/components/responses/BadRequest' 122 401: 123 $ref: '../components/responses.yml#/components/responses/InvalidToken' 124 403: 125 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 126 404: 127 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 128 500: 129 $ref: '../components/responses.yml#/components/responses/InternalServerError' 130 501: 131 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 132 security: 133 - bearerAuth: [] 134 delete: 135 tags: 136 - device-asset 137 operationId: deleteDeviceModel 138 parameters: 139 - $ref: '../components/parameters.yml#/components/parameters/name' 140 responses: 141 200: 142 description: "Processing success" 143 400: 144 $ref: '../components/responses.yml#/components/responses/BadRequest' 145 401: 146 $ref: '../components/responses.yml#/components/responses/InvalidToken' 147 403: 148 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 149 404: 150 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 151 500: 152 $ref: '../components/responses.yml#/components/responses/InternalServerError' 153 503: 154 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 155 '/v2/device_models/{name}/components': 156 get: 157 tags: 158 - device-asset 159 operationId: getDeviceModelsComponents 160 parameters: 161 - $ref: '../components/parameters.yml#/components/parameters/name' 162 responses: 163 200: 164 description: "Processing success" 165 content: 166 application/json: 167 schema: 168 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/MultipleConstitutionComponent' 169 400: 170 $ref: '../components/responses.yml#/components/responses/BadRequest' 171 401: 172 $ref: '../components/responses.yml#/components/responses/InvalidToken' 173 403: 174 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 175 404: 176 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 177 500: 178 $ref: '../components/responses.yml#/components/responses/InternalServerError' 179 503: 180 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 181 security: 182 - bearerAuth: [] 183 '/v2/device_models/{name}/entities': 184 post: 185 tags: 186 - device-asset 187 parameters: 188 - $ref: '../components/parameters.yml#/components/parameters/name' 189 operationId: createInventory 190 requestBody: 191 required: true 192 content: 193 application/json: 194 schema: 195 $ref: '../components/device-component.openapi.yml#/components/schemas/Inventory' 196 responses: 197 200: 198 description: "Processing success" 199 content: 200 application/json: 201 schema: 202 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceModelsEntity' 203 204 400: 205 $ref: '../components/responses.yml#/components/responses/BadRequest' 206 401: 207 $ref: '../components/responses.yml#/components/responses/InvalidToken' 208 403: 209 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 210 409: 211 $ref: '../components/responses.yml#/components/responses/Conflict' 212 500: 213 $ref: '../components/responses.yml#/components/responses/InternalServerError' 214 503: 215 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 216 '/v2/device_entities': 217 get: 218 tags: 219 - device-asset 220 operationId: getDeviceEntities 221 parameters: 222 - $ref: '../components/parameters.yml#/components/parameters/offset' 223 - $ref: '../components/parameters.yml#/components/parameters/limit' 224 - $ref: '../components/parameters.yml#/components/parameters/order' 225 - $ref: '../components/parameters.yml#/components/parameters/order_by' 226 - $ref: '../components/parameters.yml#/components/parameters/key_query' 227 - $ref: '../components/parameters.yml#/components/parameters/serial_number_query' 228 - $ref: '../components/parameters.yml#/components/parameters/device_id_query' 229 - $ref: '../components/parameters.yml#/components/parameters/resource_owner_id' 230 - $ref: '../components/parameters.yml#/components/parameters/component_key' 231 - $ref: '../components/parameters.yml#/components/parameters/component_value' 232 - $ref: '../components/parameters.yml#/components/parameters/is_flat' 233 responses: 234 200: 235 description: "Processing success" 236 content: 237 application/json: 238 schema: 239 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/MultipleDeviceModelEntity' 240 400: 241 $ref: '../components/responses.yml#/components/responses/BadRequest' 242 401: 243 $ref: '../components/responses.yml#/components/responses/InvalidToken' 244 403: 245 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 246 500: 247 $ref: '../components/responses.yml#/components/responses/InternalServerError' 248 503: 249 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 250 '/v2/device_entities/{key}': 251 get: 252 tags: 253 - device-asset 254 operationId: getDeviceEntity 255 parameters: 256 - $ref: '../components/parameters.yml#/components/parameters/key' 257 responses: 258 200: 259 description: "Processing success" 260 content: 261 application/json: 262 schema: 263 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceModelsEntity' 264 400: 265 $ref: '../components/responses.yml#/components/responses/BadRequest' 266 401: 267 $ref: '../components/responses.yml#/components/responses/InvalidToken' 268 403: 269 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 270 404: 271 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 272 500: 273 $ref: '../components/responses.yml#/components/responses/InternalServerError' 274 503: 275 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 276 patch: 277 tags: 278 - device-asset 279 operationId: updateDeviceEntity 280 parameters: 281 - $ref: '../components/parameters.yml#/components/parameters/key' 282 requestBody: 283 required: true 284 content: 285 application/json: 286 schema: 287 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/DeviceModelsEntity' 288 responses: 289 200: 290 description: "Processing success" 291 content: 292 application/json: 293 schema: 294 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceModelsEntity' 295 400: 296 $ref: '../components/responses.yml#/components/responses/BadRequest' 297 401: 298 $ref: '../components/responses.yml#/components/responses/InvalidToken' 299 403: 300 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 301 404: 302 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 303 500: 304 $ref: '../components/responses.yml#/components/responses/InternalServerError' 305 503: 306 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 307 delete: 308 tags: 309 - device-asset 310 operationId: deleteDeviceEntity 311 parameters: 312 - $ref: '../components/parameters.yml#/components/parameters/key' 313 responses: 314 200: 315 description: "Processing success" 316 400: 317 $ref: '../components/responses.yml#/components/responses/BadRequest' 318 401: 319 $ref: '../components/responses.yml#/components/responses/InvalidToken' 320 403: 321 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 322 404: 323 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 324 500: 325 $ref: '../components/responses.yml#/components/responses/InternalServerError' 326 503: 327 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 328 '/v2/device_entities/{key}/components': 329 post: 330 tags: 331 - device-asset 332 parameters: 333 - $ref: '../components/parameters.yml#/components/parameters/key' 334 operationId: createDeviceEntitiesComponent 335 requestBody: 336 required: true 337 content: 338 application/json: 339 schema: 340 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/DeviceEntitiesComponent' 341 responses: 342 200: 343 description: "Processing success" 344 content: 345 application/json: 346 schema: 347 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceEntitiesComponent' 348 400: 349 $ref: '../components/responses.yml#/components/responses/BadRequest' 350 401: 351 $ref: '../components/responses.yml#/components/responses/InvalidToken' 352 403: 353 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 354 409: 355 $ref: '../components/responses.yml#/components/responses/Conflict' 356 500: 357 $ref: '../components/responses.yml#/components/responses/InternalServerError' 358 503: 359 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 360 get: 361 tags: 362 - device-asset 363 parameters: 364 - $ref: '../components/parameters.yml#/components/parameters/key' 365 - $ref: '../components/parameters.yml#/components/parameters/component_id_query' 366 operationId: getDeviceEntitiesComponents 367 368 responses: 369 200: 370 description: "Processing success" 371 content: 372 application/json: 373 schema: 374 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/MultipleDeviceEntitiesComponent' 375 400: 376 $ref: '../components/responses.yml#/components/responses/BadRequest' 377 401: 378 $ref: '../components/responses.yml#/components/responses/InvalidToken' 379 403: 380 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 381 500: 382 $ref: '../components/responses.yml#/components/responses/InternalServerError' 383 503: 384 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 385 patch: 386 description: attributeが更新可能 387 tags: 388 - device-asset 389 parameters: 390 - $ref: '../components/parameters.yml#/components/parameters/key' 391 operationId: updateDeviceEntitiesComponents 392 requestBody: 393 required: true 394 content: 395 application/json: 396 schema: 397 type: array 398 items: 399 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/DeviceEntitiesComponent' 400 responses: 401 200: 402 description: "Processing success" 403 400: 404 $ref: '../components/responses.yml#/components/responses/BadRequest' 405 401: 406 $ref: '../components/responses.yml#/components/responses/InvalidToken' 407 403: 408 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 409 404: 410 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 411 500: 412 $ref: '../components/responses.yml#/components/responses/InternalServerError' 413 503: 414 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 415 '/v2/device_entities/{key}/components/{component_id}': 416 get: 417 tags: 418 - device-asset 419 operationId: getDeviceEntitiesComponent 420 parameters: 421 - $ref: '../components/parameters.yml#/components/parameters/key' 422 - $ref: '../components/parameters.yml#/components/parameters/component' 423 responses: 424 200: 425 description: "Processing success" 426 content: 427 application/json: 428 schema: 429 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceEntitiesComponent' 430 400: 431 $ref: '../components/responses.yml#/components/responses/BadRequest' 432 401: 433 $ref: '../components/responses.yml#/components/responses/InvalidToken' 434 403: 435 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 436 404: 437 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 438 500: 439 $ref: '../components/responses.yml#/components/responses/InternalServerError' 440 503: 441 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 442 patch: 443 tags: 444 - device-asset 445 operationId: updateDeviceEntitiesComponent 446 parameters: 447 - $ref: '../components/parameters.yml#/components/parameters/key' 448 - $ref: '../components/parameters.yml#/components/parameters/component' 449 requestBody: 450 content: 451 application/json: 452 schema: 453 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/DeviceEntitiesComponentUpdateRequest' 454 responses: 455 200: 456 description: "Processing success" 457 content: 458 application/json: 459 schema: 460 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleDeviceEntitiesComponent' 461 400: 462 $ref: '../components/responses.yml#/components/responses/BadRequest' 463 401: 464 $ref: '../components/responses.yml#/components/responses/InvalidToken' 465 403: 466 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 467 404: 468 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 469 500: 470 $ref: '../components/responses.yml#/components/responses/InternalServerError' 471 503: 472 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 473 delete: 474 tags: 475 - device-asset 476 operationId: deleteDeviceEntitiesComponent 477 parameters: 478 - $ref: '../components/parameters.yml#/components/parameters/key' 479 - $ref: '../components/parameters.yml#/components/parameters/component' 480 - $ref: '../components/parameters.yml#/components/parameters/is_recursive' 481 responses: 482 200: 483 description: "Processing success" 484 400: 485 $ref: '../components/responses.yml#/components/responses/BadRequest' 486 401: 487 $ref: '../components/responses.yml#/components/responses/InvalidToken' 488 403: 489 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 490 404: 491 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 492 500: 493 $ref: '../components/responses.yml#/components/responses/InternalServerError' 494 503: 495 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 496 '/v2/device_entities/{key}/lifecycles': 497 get: 498 tags: 499 - device-asset 500 parameters: 501 - $ref: '../components/parameters.yml#/components/parameters/key' 502 - $ref: '../components/parameters.yml#/components/parameters/offset' 503 - $ref: '../components/parameters.yml#/components/parameters/limit' 504 - $ref: '../components/parameters.yml#/components/parameters/order' 505 - $ref: '../components/parameters.yml#/components/parameters/order_by' 506 - $ref: '../components/parameters.yml#/components/parameters/event_kind' 507 - $ref: '../components/parameters.yml#/components/parameters/event_mode' 508 - $ref: '../components/parameters.yml#/components/parameters/event_type' 509 - $ref: '../components/parameters.yml#/components/parameters/component_id' 510 - $ref: '../components/parameters.yml#/components/parameters/before_id' 511 - $ref: '../components/parameters.yml#/components/parameters/after_id' 512 - $ref: '../components/parameters.yml#/components/parameters/start_event_at' 513 - $ref: '../components/parameters.yml#/components/parameters/end_event_at' 514 operationId: getDeviceEntitiesLifecycles 515 responses: 516 200: 517 description: "Processing success" 518 content: 519 application/json: 520 schema: 521 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/MultipleLifeCycle' 522 400: 523 $ref: '../components/responses.yml#/components/responses/BadRequest' 524 401: 525 $ref: '../components/responses.yml#/components/responses/InvalidToken' 526 403: 527 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 528 404: 529 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 530 500: 531 $ref: '../components/responses.yml#/components/responses/InternalServerError' 532 503: 533 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 534 post: 535 tags: 536 - device-asset 537 parameters: 538 - $ref: '../components/parameters.yml#/components/parameters/key' 539 operationId: createDeviceEntitiesLifecycle 540 requestBody: 541 required: true 542 content: 543 application/json: 544 schema: 545 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/LifeCycleRequest' 546 responses: 547 200: 548 description: "Processing success" 549 content: 550 application/json: 551 schema: 552 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleLifeCycle' 553 400: 554 $ref: '../components/responses.yml#/components/responses/BadRequest' 555 401: 556 $ref: '../components/responses.yml#/components/responses/InvalidToken' 557 403: 558 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 559 500: 560 $ref: '../components/responses.yml#/components/responses/InternalServerError' 561 503: 562 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 563 '/v2/device_entities/{key}/lifecycles/{lifecycle_id}': 564 get: 565 tags: 566 - device-asset 567 parameters: 568 - $ref: '../components/parameters.yml#/components/parameters/key' 569 - $ref: '../components/parameters.yml#/components/parameters/lifecycle_id' 570 operationId: getDeviceEntitiesLifecycle 571 responses: 572 573 574 200: 575 description: "Processing success" 576 content: 577 application/json: 578 schema: 579 $ref: '../components/deviceasset-component.openapi.yml#/components/schemas/SingleLifeCycle' 580 400: 581 $ref: '../components/responses.yml#/components/responses/BadRequest' 582 401: 583 $ref: '../components//responses.yml#/components/responses/InvalidToken' 584 403: 585 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 586 404: 587 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 588 500: 589 $ref: '../components/responses.yml#/components/responses/InternalServerError' 590 503: 591 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 592 delete: 593 tags: 594 - device-asset 595 parameters: 596 - $ref: '../components/parameters.yml#/components/parameters/key' 597 - $ref: '../components/parameters.yml#/components/parameters/lifecycle_id' 598 operationId: deleteDeviceEntitiesLifecycle 599 responses: 600 200: 601 description: "Processing success" 602 400: 603 $ref: '../components/responses.yml#/components/responses/BadRequest' 604 401: 605 $ref: '../components/responses.yml#/components/responses/InvalidToken' 606 403: 607 $ref: '../components/responses.yml#/components/responses/InsufficientScopes' 608 404: 609 $ref: '../components/responses.yml#/components/responses/ResourceNotFound' 610 500: 611 $ref: '../components/responses.yml#/components/responses/InternalServerError' 612 503: 613 $ref: '../components/responses.yml#/components/responses/ServerTemporarilyUnavailable' 614 615 616 components: 617 securitySchemes: 618 bearerAuth: 619 type: http 620 scheme: bearer 621 bearerFormat: JWT