github.com/optim-corp/cios-golang-sdk@v0.5.1/openapi/components/parameters.yml (about) 1 openapi: 3.0.1 2 info: 3 title: Parameter Component 4 version: 1.0.0 5 6 paths: {} 7 8 components: 9 parameters: 10 # path 11 node_id_required: 12 name: node_id 13 in: path 14 required: true 15 schema: 16 type: string 17 bucket_id_required: 18 name: bucket_id 19 in: path 20 required: true 21 schema: 22 type: string 23 channel_id_required: 24 name: channel_id 25 in: path 26 required: true 27 schema: 28 type: string 29 group_id_required: 30 name: group_id 31 in: path 32 required: true 33 schema: 34 type: string 35 format: uuid 36 resource_owner_id_required: 37 name: resource_owner_id 38 in: path 39 required: true 40 schema: 41 type: string 42 object_id_required: 43 name: object_id 44 in: path 45 required: true 46 schema: 47 type: string 48 session_id_required: 49 name: session_id 50 in: path 51 required: true 52 schema: 53 type: string 54 device_id: 55 name: device_id 56 in: path 57 required: true 58 schema: 59 type: string 60 client_id: 61 name: client_id 62 in: path 63 required: true 64 schema: 65 type: string 66 device_id_required: 67 name: device_id 68 in: path 69 description: デバイスID 70 required: true 71 schema: 72 type: string 73 point_id_required: 74 name: point_id 75 in: path 76 required: true 77 schema: 78 type: string 79 circle_id_required: 80 name: circle_id 81 in: path 82 required: true 83 schema: 84 type: string 85 route_id_required: 86 name: route_id 87 in: path 88 required: true 89 schema: 90 type: string 91 video_id: 92 name: video_id 93 in: path 94 required: true 95 schema: 96 type: string 97 policy_id: 98 name: policy_id 99 in: path 100 required: true 101 schema: 102 type: string 103 name: 104 name: name 105 in: path 106 required: true 107 schema: 108 type: string 109 key: 110 name: key 111 in: path 112 required: true 113 schema: 114 type: string 115 component: 116 name: component 117 in: path 118 required: true 119 schema: 120 type: string 121 lifecycle_id: 122 name: lifecycle_id 123 in: path 124 required: true 125 schema: 126 type: string 127 contract_id: 128 name: contract_id 129 in: path 130 required: true 131 schema: 132 type: string 133 user_id_path: 134 name: user_id 135 in: path 136 required: true 137 schema: 138 type: string 139 collection_id: 140 description: コレクション名 141 explode: false 142 in: path 143 name: collection_id 144 required: true 145 schema: 146 description: コレクション名 147 example: location 148 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]{1,34}[a-zA-Z0-9]$ 149 title: CollectionId 150 type: string 151 style: simple 152 series_id: 153 description: シリーズID 154 explode: false 155 in: path 156 name: series_id 157 required: true 158 schema: 159 type: string 160 timestamp_path: 161 description: UNIXタイム(ミリ秒) 162 explode: false 163 in: path 164 name: timestamp 165 required: true 166 schema: 167 description: UNIXタイム(ミリ秒) 168 example: 1518165596566320 169 format: int64 170 title: TimeStamp 171 type: integer 172 style: simple 173 174 175 # query 176 resource_owner_id_query_required: 177 name: resource_owner_id 178 in: query 179 required: true 180 schema: 181 type: string 182 name_query: 183 name: name 184 description: 名前での部分一致検索 185 in: query 186 required: false 187 schema: 188 pattern: \A.{1,100}\z 189 type: string 190 maxLength: 255 191 key_query: 192 name: key 193 in: query 194 required: false 195 schema: 196 type: string 197 serial_number_query: 198 name: serial_number 199 in: query 200 required: false 201 schema: 202 type: string 203 node_id_query: 204 name: node_id 205 in: query 206 required: false 207 schema: 208 type: string 209 session_id_query: 210 name: session_id 211 in: query 212 required: false 213 schema: 214 type: string 215 parent_node_id: 216 name: parent_node_id 217 in: query 218 required: false 219 schema: 220 type: string 221 parent_key: 222 name: parent_key 223 in: query 224 required: false 225 schema: 226 type: string 227 group_id: 228 name: group_id 229 in: query 230 required: false 231 schema: 232 type: string 233 user_id: 234 name: user_id 235 in: query 236 required: false 237 schema: 238 type: string 239 format: uuid 240 type: 241 name: type 242 in: query 243 required: false 244 schema: 245 type: string 246 group_type: 247 name: type 248 in: query 249 required: false 250 schema: 251 type: string 252 enum: [ Corporation, Group ] 253 device_id_query: 254 name: device_id 255 in: query 256 required: false 257 schema: 258 type: string 259 is_enable: 260 name: is_enable 261 in: query 262 required: false 263 schema: 264 type: string 265 page: 266 name: page 267 in: query 268 required: false 269 schema: 270 type: string 271 offset: 272 name: offset 273 in: query 274 required: false 275 description: ページネーションのうち、何件読み飛ばすか 276 schema: 277 type: integer 278 description: 0以上 279 minimum: 0 280 format: int64 281 limit: 282 name: limit 283 in: query 284 required: false 285 description: ページネーションのうち、上位何件取得するか 286 schema: 287 type: integer 288 format: int64 289 minimum: 1 290 maximum: 1000 291 group_order_by: 292 name: order_by 293 in: query 294 required: false 295 schema: 296 type: string 297 enum: [ display_name ] 298 member_order_by: 299 name: order_by 300 in: query 301 required: false 302 schema: 303 type: string 304 enum: [ role, category ] 305 node_order_by: 306 name: order_by 307 in: query 308 required: false 309 schema: 310 type: string 311 enum: [ parent_node_id, name, key, created_at, updated_at, file_size ] 312 order_by: 313 name: order_by 314 description: ソート対象。指定順に高優先でのソートとなる 315 in: query 316 required: false 317 schema: 318 type: string 319 order: 320 name: order 321 description: ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 322 in: query 323 required: false 324 schema: 325 type: string 326 enum: [ desc, asc ] 327 recursive: 328 name: recursive 329 in: query 330 required: false 331 schema: 332 type: boolean 333 is_directory: 334 name: is_directory 335 in: query 336 required: false 337 schema: 338 type: boolean 339 directory_size: 340 name: directory_size 341 in: query 342 required: false 343 schema: 344 type: boolean 345 force: 346 name: force 347 in: query 348 required: false 349 schema: 350 type: boolean 351 checksum: 352 name: checksum 353 in: query 354 required: true 355 schema: 356 type: string 357 lang: 358 description: 言語指定 359 name: lang 360 in: query 361 required: false 362 schema: 363 description: |- 364 IETF言語タグ(BCP47)準拠。 365 指定言語が設定されていない場合デフォルト言語(display_info.is_defaultがtrueの言語)を利用する 366 type: string 367 is_dev: 368 name: is_dev 369 in: query 370 required: false 371 description: 開発者モードの有効・無効 372 schema: 373 type: boolean 374 description: |- 375 true:display_infoを表示, 376 false:langで指定した言語のnameとdescriptionを表示 377 is_public: 378 name: is_public 379 in: query 380 description: デバイスの公開・非公開 381 required: false 382 schema: 383 description: |- 384 true:公開されているものでの絞り込み, 385 false:所有するものでの絞り込み, 386 all:絞り込みなし 387 type: string 388 enum: [true, false, all] 389 messaging_enabled: 390 name: messaging_enabled 391 in: query 392 required: false 393 schema: 394 type: string 395 datastore_enabled: 396 name: datastore_enabled 397 in: query 398 required: false 399 schema: 400 type: string 401 messaging_persisted: 402 name: messaging_persisted 403 in: query 404 required: false 405 schema: 406 type: string 407 channel_protocol: 408 name: channel_protocol 409 in: query 410 required: false 411 schema: 412 type: string 413 channel_protocol_id: 414 name: channel_protocol_id 415 in: query 416 required: false 417 schema: 418 type: string 419 channel_protocol_version: 420 name: channel_protocol_version 421 in: query 422 required: false 423 schema: 424 type: integer 425 location: 426 name: location 427 in: query 428 required: false 429 schema: 430 type: string 431 ascending: 432 name: ascending 433 in: query 434 required: false 435 schema: 436 type: boolean 437 location_range: 438 name: location_range 439 in: query 440 required: false 441 schema: 442 type: string 443 timestamp_range: 444 name: timestamp_range 445 in: query 446 required: false 447 schema: 448 type: string 449 timestamp: 450 name: timestamp 451 in: query 452 required: false 453 schema: 454 type: string 455 resource_owner_id: 456 name: resource_owner_id 457 in: query 458 required: false 459 schema: 460 type: string 461 format: uuid 462 label: 463 name: label 464 in: query 465 required: false 466 schema: 467 type: string 468 state: 469 name: state 470 in: query 471 required: false 472 schema: 473 type: string 474 city: 475 name: city 476 in: query 477 required: false 478 schema: 479 type: string 480 address_1: 481 name: address_1 482 in: query 483 required: false 484 schema: 485 type: string 486 address_2: 487 name: address_2 488 in: query 489 required: false 490 schema: 491 type: string 492 tag: 493 name: tag 494 in: query 495 required: false 496 schema: 497 type: string 498 tags: 499 name: tags 500 in: query 501 required: false 502 schema: 503 type: string 504 domain: 505 name: domain 506 in: query 507 required: false 508 schema: 509 type: string 510 parent_group_id: 511 name: parent_group_id 512 in: query 513 required: false 514 schema: 515 type: string 516 format: uuid 517 includes: 518 name: includes 519 in: query 520 required: false 521 schema: 522 type: string 523 category: 524 name: category 525 in: query 526 required: false 527 schema: 528 type: string 529 enum: [ member, guest ] 530 role: 531 name: role 532 in: query 533 required: false 534 schema: 535 type: string 536 enum: [ super_admin, admin, manager, staff ] 537 phonetic_given_name: 538 name: phonetic_given_name 539 in: query 540 required: false 541 schema: 542 type: string 543 phonetic_family_name: 544 name: phonetic_family_name 545 in: query 546 required: false 547 schema: 548 type: string 549 primary: 550 name: primary 551 in: query 552 required: false 553 schema: 554 type: boolean 555 email: 556 name: email 557 in: query 558 required: false 559 schema: 560 type: string 561 packer_format: 562 name: packer_format 563 required: false 564 in: query 565 schema: 566 type: string 567 channel_id_query_required: 568 name: channel_id 569 required: true 570 in: query 571 schema: 572 type: string 573 definition_id: 574 name: definition_id 575 description: |- 576 デバイス定義ID(custom_inventory.definition_id)での完全一致検索 577 required: false 578 in: query 579 schema: 580 type: string 581 id_number: 582 name: id_number 583 required: false 584 description: 識別番号での完全一致検索 585 in: query 586 schema: 587 type: string 588 definition_tag: 589 name: definition_tag 590 description: デバイス定義のタグ(custom_inventory.tag)での完全一致検索 591 required: false 592 in: query 593 schema: 594 type: string 595 inventory_key: 596 name: definition_tag 597 description: |- 598 custominventoryの内部データでの検索時に指定。 599 key,valueのセットの完全一致での検索とし、 600 本パラメータでkeyを指定し、inventory_valueでvalueを指定する。 601 required: false 602 in: query 603 schema: 604 type: string 605 inventory_value: 606 name: definition_tag 607 description: |- 608 custominventoryの内部データでの検索時に指定。 609 key,valueのセットの完全一致での検索とし、本パラメータでvalueを指定し、 610 inventory_keyでkeyを指定する。 611 required: false 612 in: query 613 schema: 614 type: string 615 sort: 616 name: sort 617 required: false 618 in: query 619 schema: 620 type: string 621 top: 622 name: top 623 required: false 624 in: query 625 schema: 626 type: integer 627 skip: 628 name: skip 629 required: false 630 in: query 631 schema: 632 type: integer 633 version: 634 name: version 635 in: query 636 required: false 637 schema: 638 type: string 639 component_key: 640 name: component_key 641 in: query 642 required: false 643 schema: 644 type: string 645 component_value: 646 name: component_value 647 in: query 648 required: false 649 schema: 650 type: string 651 component_id_query: 652 name: component_id_query 653 in: query 654 required: false 655 schema: 656 type: string 657 is_flat: 658 name: is_flat 659 in: query 660 required: false 661 schema: 662 type: boolean 663 default: false 664 is_recursive: 665 name: is_recursive 666 in: query 667 required: true 668 schema: 669 type: boolean 670 event_kind: 671 name: event_kind 672 in: query 673 required: false 674 schema: 675 type: string 676 event_mode: 677 name: event_mode 678 in: query 679 required: false 680 schema: 681 type: string 682 event_type: 683 name: event_type 684 in: query 685 required: false 686 schema: 687 type: string 688 component_id: 689 name: component_id 690 in: query 691 required: false 692 schema: 693 type: string 694 before_id: 695 name: before_id 696 in: query 697 required: false 698 schema: 699 type: string 700 after_id: 701 name: after_id 702 in: query 703 required: false 704 schema: 705 type: string 706 start_event_at: 707 name: start_event_at 708 in: query 709 required: false 710 schema: 711 type: string 712 end_event_at: 713 name: end_event_at 714 in: query 715 required: false 716 schema: 717 type: string 718 maker_id: 719 name: end_event_at 720 in: query 721 required: false 722 schema: 723 type: string 724 status: 725 name: status 726 in: query 727 required: false 728 schema: 729 type: string 730 is_latest: 731 description: 最新画像としてアップロードする場合はtrue。保存に失敗した画像を再度アップロードする場合など、最新画像でない場合はfalseを指定する。 732 explode: true 733 in: query 734 name: is_latest 735 required: false 736 schema: 737 default: true 738 example: false 739 type: boolean 740 style: form 741 time_range: 742 description: <開始時刻>:<終了時刻>、UNIX時間(ミリ秒)。開始時刻はInclusive、終了時刻はExclusive(開始時刻≦取得範囲＜終了時刻)。最大で取得できる期間は7日間以内とする。開始、終了時刻の指定が7日間を超える場合は、400エラーとなる 743 explode: true 744 in: query 745 name: time_range 746 required: true 747 schema: 748 example: 1518165596566:1518165596566 749 pattern: ^((0)|([1-9][0-9]*)):((0)|([1-9][0-9]*))$ 750 type: string 751 style: form 752 projection: 753 description: |- 754 取得する対象を以下から選択する 755 756 |値|取得対象| 757 |---|---| 758 |data|画像以外の最新データのみ取得。時系列データ保存APIで保存された各シリーズの時系列データで最後に保存されたデータが返却される。時系列データ保存 (bulk upload)で保存されたデータは取得されない。| 759 |thumbnail|最新のサムネイル画像のみ取得。画像保存APIで各シリーズに対してis_latest=trueを指定して最後に保存された画像が返却される。| 760 |image|最新のオリジナル画像のみ取得。画像保存APIで各シリーズに対してis_latest=trueを指定して最後に保存された画像が返却される。| 761 explode: true 762 in: query 763 name: projection 764 required: false 765 schema: 766 default: data 767 enum: [ data, thumbnail, image ] 768 type: string 769 style: form 770 month_required: 771 description: 問い合わせ年月(YYYY-MM)。1970-01から9999-12まで 772 example: 2019-12 773 explode: true 774 in: query 775 name: month 776 required: true 777 schema: 778 pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$ 779 type: string 780 style: form 781 gmt_offset: 782 description: タイムゾーンをGMTからのオフセットで指定(日本の場合9) hh:mmの形式で指定。時間が一桁の場合は0パディングはなし。時間は[-12, 14]の範囲。分は、00, 15, 30, 45のいずれかのみ許容 783 explode: true 784 in: query 785 name: gmt_offset 786 required: false 787 schema: 788 default: 0:00 789 pattern: ^(0|-?[1-9]|-1[0-1]|1[0-3]):(00|15|30|45)$|^(-12:00|14:00)$ 790 type: string 791 style: form 792 interval: 793 description: 時系列データを集計する単位時間（ミリ秒）を指定する 794 explode: true 795 in: query 796 name: interval 797 required: true 798 schema: 799 example: 60000 800 format: int32 801 maximum: 86400000 802 minimum: 1000 803 type: integer 804 style: form 805 # header 806 Accept-Encoding: 807 description: レスポンスボディの圧縮形式。gzipのみ対応。 808 explode: false 809 in: header 810 name: Accept-Encoding 811 required: false 812 schema: 813 pattern: gzip 814 type: string 815 style: simple