github.com/optim-corp/cios-golang-sdk@v0.5.1/cios/docs/DeviceApi.md (about) 1 # \DeviceApi 2 3 All URIs are relative to *http://localhost* 4 5 Method | HTTP request | Description 6 ------------- | ------------- | ------------- 7 [**CreateDevice**](DeviceApi.md#CreateDevice) | **Post** /v2/devices | デバイスの登録 8 [**CreateDeviceClient**](DeviceApi.md#CreateDeviceClient) | **Post** /v2/devices/{device_id}/device_clients | 9 [**CreateDevicePolicy**](DeviceApi.md#CreateDevicePolicy) | **Post** /v2/devices/group_policies | 10 [**DeleteDevice**](DeviceApi.md#DeleteDevice) | **Delete** /v2/devices/{device_id} | 11 [**DeleteDeviceClient**](DeviceApi.md#DeleteDeviceClient) | **Delete** /v2/devices/{device_id}/device_clients/{client_id} | device.write 12 [**DeletePolicy**](DeviceApi.md#DeletePolicy) | **Delete** /v2/devices/group_policies/{policy_id} | 13 [**GetDevice**](DeviceApi.md#GetDevice) | **Get** /v2/devices/{device_id} | 指定したidのデバイスの情報を取得する 14 [**GetDeviceInventoryLatest**](DeviceApi.md#GetDeviceInventoryLatest) | **Get** /v2/devices/{device_id}/inventory/latest | 15 [**GetDeviceMonitoringLatest**](DeviceApi.md#GetDeviceMonitoringLatest) | **Get** /v2/devices/{device_id}/monitoring/latest | 16 [**GetDeviceMonitoringsLatest**](DeviceApi.md#GetDeviceMonitoringsLatest) | **Post** /v2/devices/monitoring/latest | 17 [**GetDevicePolicies**](DeviceApi.md#GetDevicePolicies) | **Get** /v2/devices/group_policies | 18 [**GetDeviceProfile**](DeviceApi.md#GetDeviceProfile) | **Get** /v2/devices/profile | device.profile 19 [**GetDevices**](DeviceApi.md#GetDevices) | **Get** /v2/devices | デバイスの一覧を取得する 20 [**UpdateDevice**](DeviceApi.md#UpdateDevice) | **Patch** /v2/devices/{device_id} | 指定したidのデバイス情報を更新する 21 [**UpdateDeviceClient**](DeviceApi.md#UpdateDeviceClient) | **Patch** /v2/devices/{device_id}/device_clients/{client_id} | device.write 22 23 24 25 ## CreateDevice 26 27 > SingleDevice CreateDevice(ctx).DeviceInfo(deviceInfo).Execute() 28 29 デバイスの登録 30 31 32 33 ### Example 34 35 ```go 36 package main 37 38 import ( 39 "context" 40 "fmt" 41 "os" 42 openapiclient "./openapi" 43 ) 44 45 func main() { 46 deviceInfo := *openapiclient.NewDeviceInfo("ResourceOwnerId_example") // DeviceInfo | 47 48 configuration := openapiclient.NewConfiguration() 49 api_client := openapiclient.NewAPIClient(configuration) 50 resp, r, err := api_client.DeviceApi.CreateDevice(context.Background()).DeviceInfo(deviceInfo).Execute() 51 if err.Error() != "" { 52 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.CreateDevice``: %v\n", err) 53 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 54 } 55 // response from `CreateDevice`: SingleDevice 56 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.CreateDevice`: %v\n", resp) 57 } 58 ``` 59 60 ### Path Parameters 61 62 63 64 ### Other Parameters 65 66 Other parameters are passed through a pointer to a apiCreateDeviceRequest struct via the builder pattern 67 68 69 Name | Type | Description | Notes 70 ------------- | ------------- | ------------- | ------------- 71 **deviceInfo** | [**DeviceInfo**](DeviceInfo.md) | | 72 73 ### Return type 74 75 [**SingleDevice**](SingleDevice.md) 76 77 ### Authorization 78 79 [bearerAuth](../README.md#bearerAuth) 80 81 ### HTTP request headers 82 83 - **Content-Type**: application/json 84 - **Accept**: application/json 85 86 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 87 [[Back to Model list]](../README.md#documentation-for-models) 88 [[Back to README]](../README.md) 89 90 91 ## CreateDeviceClient 92 93 > DeviceClientList CreateDeviceClient(ctx, deviceId).DeviceClientRequest(deviceClientRequest).Execute() 94 95 96 97 98 99 ### Example 100 101 ```go 102 package main 103 104 import ( 105 "context" 106 "fmt" 107 "os" 108 openapiclient "./openapi" 109 ) 110 111 func main() { 112 deviceId := "deviceId_example" // string | 113 deviceClientRequest := *openapiclient.NewDeviceClientRequest() // DeviceClientRequest | 114 115 configuration := openapiclient.NewConfiguration() 116 api_client := openapiclient.NewAPIClient(configuration) 117 resp, r, err := api_client.DeviceApi.CreateDeviceClient(context.Background(), deviceId).DeviceClientRequest(deviceClientRequest).Execute() 118 if err.Error() != "" { 119 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.CreateDeviceClient``: %v\n", err) 120 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 121 } 122 // response from `CreateDeviceClient`: DeviceClientList 123 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.CreateDeviceClient`: %v\n", resp) 124 } 125 ``` 126 127 ### Path Parameters 128 129 130 Name | Type | Description | Notes 131 ------------- | ------------- | ------------- | ------------- 132 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 133 **deviceId** | **string** | | 134 135 ### Other Parameters 136 137 Other parameters are passed through a pointer to a apiCreateDeviceClientRequest struct via the builder pattern 138 139 140 Name | Type | Description | Notes 141 ------------- | ------------- | ------------- | ------------- 142 143 **deviceClientRequest** | [**DeviceClientRequest**](DeviceClientRequest.md) | | 144 145 ### Return type 146 147 [**DeviceClientList**](DeviceClientList.md) 148 149 ### Authorization 150 151 No authorization required 152 153 ### HTTP request headers 154 155 - **Content-Type**: application/json 156 - **Accept**: application/json 157 158 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 159 [[Back to Model list]](../README.md#documentation-for-models) 160 [[Back to README]](../README.md) 161 162 163 ## CreateDevicePolicy 164 165 > DevicePolicy CreateDevicePolicy(ctx).DevicePolicyRequest(devicePolicyRequest).Execute() 166 167 168 169 ### Example 170 171 ```go 172 package main 173 174 import ( 175 "context" 176 "fmt" 177 "os" 178 openapiclient "./openapi" 179 ) 180 181 func main() { 182 devicePolicyRequest := *openapiclient.NewDevicePolicyRequest("ResourceOwnerId_example") // DevicePolicyRequest | 183 184 configuration := openapiclient.NewConfiguration() 185 api_client := openapiclient.NewAPIClient(configuration) 186 resp, r, err := api_client.DeviceApi.CreateDevicePolicy(context.Background()).DevicePolicyRequest(devicePolicyRequest).Execute() 187 if err.Error() != "" { 188 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.CreateDevicePolicy``: %v\n", err) 189 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 190 } 191 // response from `CreateDevicePolicy`: DevicePolicy 192 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.CreateDevicePolicy`: %v\n", resp) 193 } 194 ``` 195 196 ### Path Parameters 197 198 199 200 ### Other Parameters 201 202 Other parameters are passed through a pointer to a apiCreateDevicePolicyRequest struct via the builder pattern 203 204 205 Name | Type | Description | Notes 206 ------------- | ------------- | ------------- | ------------- 207 **devicePolicyRequest** | [**DevicePolicyRequest**](DevicePolicyRequest.md) | | 208 209 ### Return type 210 211 [**DevicePolicy**](DevicePolicy.md) 212 213 ### Authorization 214 215 [bearerAuth](../README.md#bearerAuth) 216 217 ### HTTP request headers 218 219 - **Content-Type**: application/json 220 - **Accept**: application/json 221 222 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 223 [[Back to Model list]](../README.md#documentation-for-models) 224 [[Back to README]](../README.md) 225 226 227 ## DeleteDevice 228 229 > DeleteDevice(ctx, deviceId).Execute() 230 231 232 233 ### Example 234 235 ```go 236 package main 237 238 import ( 239 "context" 240 "fmt" 241 "os" 242 openapiclient "./openapi" 243 ) 244 245 func main() { 246 deviceId := "deviceId_example" // string | デバイスID 247 248 configuration := openapiclient.NewConfiguration() 249 api_client := openapiclient.NewAPIClient(configuration) 250 resp, r, err := api_client.DeviceApi.DeleteDevice(context.Background(), deviceId).Execute() 251 if err.Error() != "" { 252 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.DeleteDevice``: %v\n", err) 253 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 254 } 255 } 256 ``` 257 258 ### Path Parameters 259 260 261 Name | Type | Description | Notes 262 ------------- | ------------- | ------------- | ------------- 263 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 264 **deviceId** | **string** | デバイスID | 265 266 ### Other Parameters 267 268 Other parameters are passed through a pointer to a apiDeleteDeviceRequest struct via the builder pattern 269 270 271 Name | Type | Description | Notes 272 ------------- | ------------- | ------------- | ------------- 273 274 275 ### Return type 276 277 (empty response body) 278 279 ### Authorization 280 281 [bearerAuth](../README.md#bearerAuth) 282 283 ### HTTP request headers 284 285 - **Content-Type**: Not defined 286 - **Accept**: Not defined 287 288 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 289 [[Back to Model list]](../README.md#documentation-for-models) 290 [[Back to README]](../README.md) 291 292 293 ## DeleteDeviceClient 294 295 > DeleteDeviceClient(ctx, deviceId, clientId).Execute() 296 297 device.write 298 299 300 301 ### Example 302 303 ```go 304 package main 305 306 import ( 307 "context" 308 "fmt" 309 "os" 310 openapiclient "./openapi" 311 ) 312 313 func main() { 314 deviceId := "deviceId_example" // string | 315 clientId := "clientId_example" // string | 316 317 configuration := openapiclient.NewConfiguration() 318 api_client := openapiclient.NewAPIClient(configuration) 319 resp, r, err := api_client.DeviceApi.DeleteDeviceClient(context.Background(), deviceId, clientId).Execute() 320 if err.Error() != "" { 321 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.DeleteDeviceClient``: %v\n", err) 322 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 323 } 324 } 325 ``` 326 327 ### Path Parameters 328 329 330 Name | Type | Description | Notes 331 ------------- | ------------- | ------------- | ------------- 332 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 333 **deviceId** | **string** | | 334 **clientId** | **string** | | 335 336 ### Other Parameters 337 338 Other parameters are passed through a pointer to a apiDeleteDeviceClientRequest struct via the builder pattern 339 340 341 Name | Type | Description | Notes 342 ------------- | ------------- | ------------- | ------------- 343 344 345 346 ### Return type 347 348 (empty response body) 349 350 ### Authorization 351 352 No authorization required 353 354 ### HTTP request headers 355 356 - **Content-Type**: Not defined 357 - **Accept**: Not defined 358 359 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 360 [[Back to Model list]](../README.md#documentation-for-models) 361 [[Back to README]](../README.md) 362 363 364 ## DeletePolicy 365 366 > DeletePolicy(ctx, policyId).Execute() 367 368 369 370 ### Example 371 372 ```go 373 package main 374 375 import ( 376 "context" 377 "fmt" 378 "os" 379 openapiclient "./openapi" 380 ) 381 382 func main() { 383 policyId := "policyId_example" // string | 384 385 configuration := openapiclient.NewConfiguration() 386 api_client := openapiclient.NewAPIClient(configuration) 387 resp, r, err := api_client.DeviceApi.DeletePolicy(context.Background(), policyId).Execute() 388 if err.Error() != "" { 389 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.DeletePolicy``: %v\n", err) 390 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 391 } 392 } 393 ``` 394 395 ### Path Parameters 396 397 398 Name | Type | Description | Notes 399 ------------- | ------------- | ------------- | ------------- 400 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 401 **policyId** | **string** | | 402 403 ### Other Parameters 404 405 Other parameters are passed through a pointer to a apiDeletePolicyRequest struct via the builder pattern 406 407 408 Name | Type | Description | Notes 409 ------------- | ------------- | ------------- | ------------- 410 411 412 ### Return type 413 414 (empty response body) 415 416 ### Authorization 417 418 [bearerAuth](../README.md#bearerAuth) 419 420 ### HTTP request headers 421 422 - **Content-Type**: Not defined 423 - **Accept**: Not defined 424 425 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 426 [[Back to Model list]](../README.md#documentation-for-models) 427 [[Back to README]](../README.md) 428 429 430 ## GetDevice 431 432 > SingleDevice GetDevice(ctx, deviceId).Lang(lang).IsDev(isDev).Execute() 433 434 指定したidのデバイスの情報を取得する 435 436 437 438 ### Example 439 440 ```go 441 package main 442 443 import ( 444 "context" 445 "fmt" 446 "os" 447 openapiclient "./openapi" 448 ) 449 450 func main() { 451 deviceId := "deviceId_example" // string | デバイスID 452 lang := "lang_example" // string | 言語指定 (optional) 453 isDev := true // bool | 開発者モードの有効・無効 (optional) 454 455 configuration := openapiclient.NewConfiguration() 456 api_client := openapiclient.NewAPIClient(configuration) 457 resp, r, err := api_client.DeviceApi.GetDevice(context.Background(), deviceId).Lang(lang).IsDev(isDev).Execute() 458 if err.Error() != "" { 459 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDevice``: %v\n", err) 460 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 461 } 462 // response from `GetDevice`: SingleDevice 463 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDevice`: %v\n", resp) 464 } 465 ``` 466 467 ### Path Parameters 468 469 470 Name | Type | Description | Notes 471 ------------- | ------------- | ------------- | ------------- 472 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 473 **deviceId** | **string** | デバイスID | 474 475 ### Other Parameters 476 477 Other parameters are passed through a pointer to a apiGetDeviceRequest struct via the builder pattern 478 479 480 Name | Type | Description | Notes 481 ------------- | ------------- | ------------- | ------------- 482 483 **lang** | **string** | 言語指定 | 484 **isDev** | **bool** | 開発者モードの有効・無効 | 485 486 ### Return type 487 488 [**SingleDevice**](SingleDevice.md) 489 490 ### Authorization 491 492 [bearerAuth](../README.md#bearerAuth) 493 494 ### HTTP request headers 495 496 - **Content-Type**: Not defined 497 - **Accept**: application/json 498 499 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 500 [[Back to Model list]](../README.md#documentation-for-models) 501 [[Back to README]](../README.md) 502 503 504 ## GetDeviceInventoryLatest 505 506 > map[string]interface{} GetDeviceInventoryLatest(ctx, deviceId).Execute() 507 508 509 510 ### Example 511 512 ```go 513 package main 514 515 import ( 516 "context" 517 "fmt" 518 "os" 519 openapiclient "./openapi" 520 ) 521 522 func main() { 523 deviceId := "deviceId_example" // string | 524 525 configuration := openapiclient.NewConfiguration() 526 api_client := openapiclient.NewAPIClient(configuration) 527 resp, r, err := api_client.DeviceApi.GetDeviceInventoryLatest(context.Background(), deviceId).Execute() 528 if err.Error() != "" { 529 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDeviceInventoryLatest``: %v\n", err) 530 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 531 } 532 // response from `GetDeviceInventoryLatest`: map[string]interface{} 533 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDeviceInventoryLatest`: %v\n", resp) 534 } 535 ``` 536 537 ### Path Parameters 538 539 540 Name | Type | Description | Notes 541 ------------- | ------------- | ------------- | ------------- 542 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 543 **deviceId** | **string** | | 544 545 ### Other Parameters 546 547 Other parameters are passed through a pointer to a apiGetDeviceInventoryLatestRequest struct via the builder pattern 548 549 550 Name | Type | Description | Notes 551 ------------- | ------------- | ------------- | ------------- 552 553 554 ### Return type 555 556 **map[string]interface{}** 557 558 ### Authorization 559 560 [bearerAuth](../README.md#bearerAuth) 561 562 ### HTTP request headers 563 564 - **Content-Type**: Not defined 565 - **Accept**: application/json 566 567 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 568 [[Back to Model list]](../README.md#documentation-for-models) 569 [[Back to README]](../README.md) 570 571 572 ## GetDeviceMonitoringLatest 573 574 > SingleDeviceMonitoring GetDeviceMonitoringLatest(ctx, deviceId).Execute() 575 576 577 578 ### Example 579 580 ```go 581 package main 582 583 import ( 584 "context" 585 "fmt" 586 "os" 587 openapiclient "./openapi" 588 ) 589 590 func main() { 591 deviceId := "deviceId_example" // string | 592 593 configuration := openapiclient.NewConfiguration() 594 api_client := openapiclient.NewAPIClient(configuration) 595 resp, r, err := api_client.DeviceApi.GetDeviceMonitoringLatest(context.Background(), deviceId).Execute() 596 if err.Error() != "" { 597 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDeviceMonitoringLatest``: %v\n", err) 598 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 599 } 600 // response from `GetDeviceMonitoringLatest`: SingleDeviceMonitoring 601 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDeviceMonitoringLatest`: %v\n", resp) 602 } 603 ``` 604 605 ### Path Parameters 606 607 608 Name | Type | Description | Notes 609 ------------- | ------------- | ------------- | ------------- 610 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 611 **deviceId** | **string** | | 612 613 ### Other Parameters 614 615 Other parameters are passed through a pointer to a apiGetDeviceMonitoringLatestRequest struct via the builder pattern 616 617 618 Name | Type | Description | Notes 619 ------------- | ------------- | ------------- | ------------- 620 621 622 ### Return type 623 624 [**SingleDeviceMonitoring**](SingleDeviceMonitoring.md) 625 626 ### Authorization 627 628 [bearerAuth](../README.md#bearerAuth) 629 630 ### HTTP request headers 631 632 - **Content-Type**: Not defined 633 - **Accept**: application/json 634 635 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 636 [[Back to Model list]](../README.md#documentation-for-models) 637 [[Back to README]](../README.md) 638 639 640 ## GetDeviceMonitoringsLatest 641 642 > MultipleDeviceMonitoring GetDeviceMonitoringsLatest(ctx).DeviceMonitoringIDsRequest(deviceMonitoringIDsRequest).Execute() 643 644 645 646 ### Example 647 648 ```go 649 package main 650 651 import ( 652 "context" 653 "fmt" 654 "os" 655 openapiclient "./openapi" 656 ) 657 658 func main() { 659 deviceMonitoringIDsRequest := *openapiclient.NewDeviceMonitoringIDsRequest([]string{"DeviceIds_example"}) // DeviceMonitoringIDsRequest | 660 661 configuration := openapiclient.NewConfiguration() 662 api_client := openapiclient.NewAPIClient(configuration) 663 resp, r, err := api_client.DeviceApi.GetDeviceMonitoringsLatest(context.Background()).DeviceMonitoringIDsRequest(deviceMonitoringIDsRequest).Execute() 664 if err.Error() != "" { 665 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDeviceMonitoringsLatest``: %v\n", err) 666 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 667 } 668 // response from `GetDeviceMonitoringsLatest`: MultipleDeviceMonitoring 669 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDeviceMonitoringsLatest`: %v\n", resp) 670 } 671 ``` 672 673 ### Path Parameters 674 675 676 677 ### Other Parameters 678 679 Other parameters are passed through a pointer to a apiGetDeviceMonitoringsLatestRequest struct via the builder pattern 680 681 682 Name | Type | Description | Notes 683 ------------- | ------------- | ------------- | ------------- 684 **deviceMonitoringIDsRequest** | [**DeviceMonitoringIDsRequest**](DeviceMonitoringIDsRequest.md) | | 685 686 ### Return type 687 688 [**MultipleDeviceMonitoring**](MultipleDeviceMonitoring.md) 689 690 ### Authorization 691 692 [bearerAuth](../README.md#bearerAuth) 693 694 ### HTTP request headers 695 696 - **Content-Type**: application/json 697 - **Accept**: application/json 698 699 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 700 [[Back to Model list]](../README.md#documentation-for-models) 701 [[Back to README]](../README.md) 702 703 704 ## GetDevicePolicies 705 706 > MultipleDevicePolicy GetDevicePolicies(ctx).Limit(limit).Offset(offset).Order(order).OrderBy(orderBy).ResourceOwnerId(resourceOwnerId).Execute() 707 708 709 710 ### Example 711 712 ```go 713 package main 714 715 import ( 716 "context" 717 "fmt" 718 "os" 719 openapiclient "./openapi" 720 ) 721 722 func main() { 723 limit := int64(789) // int64 | ページネーションのうち、上位何件取得するか (optional) 724 offset := int64(789) // int64 | ページネーションのうち、何件読み飛ばすか (optional) 725 order := "order_example" // string | ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 (optional) 726 orderBy := "orderBy_example" // string | ソート対象。指定順に高優先でのソートとなる (optional) 727 resourceOwnerId := TODO // string | (optional) 728 729 configuration := openapiclient.NewConfiguration() 730 api_client := openapiclient.NewAPIClient(configuration) 731 resp, r, err := api_client.DeviceApi.GetDevicePolicies(context.Background()).Limit(limit).Offset(offset).Order(order).OrderBy(orderBy).ResourceOwnerId(resourceOwnerId).Execute() 732 if err.Error() != "" { 733 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDevicePolicies``: %v\n", err) 734 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 735 } 736 // response from `GetDevicePolicies`: MultipleDevicePolicy 737 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDevicePolicies`: %v\n", resp) 738 } 739 ``` 740 741 ### Path Parameters 742 743 744 745 ### Other Parameters 746 747 Other parameters are passed through a pointer to a apiGetDevicePoliciesRequest struct via the builder pattern 748 749 750 Name | Type | Description | Notes 751 ------------- | ------------- | ------------- | ------------- 752 **limit** | **int64** | ページネーションのうち、上位何件取得するか | 753 **offset** | **int64** | ページネーションのうち、何件読み飛ばすか | 754 **order** | **string** | ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 | 755 **orderBy** | **string** | ソート対象。指定順に高優先でのソートとなる | 756 **resourceOwnerId** | [**string**](string.md) | | 757 758 ### Return type 759 760 [**MultipleDevicePolicy**](MultipleDevicePolicy.md) 761 762 ### Authorization 763 764 [bearerAuth](../README.md#bearerAuth) 765 766 ### HTTP request headers 767 768 - **Content-Type**: Not defined 769 - **Accept**: application/json 770 771 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 772 [[Back to Model list]](../README.md#documentation-for-models) 773 [[Back to README]](../README.md) 774 775 776 ## GetDeviceProfile 777 778 > SingleDevice GetDeviceProfile(ctx).Lang(lang).IsDev(isDev).Execute() 779 780 device.profile 781 782 ### Example 783 784 ```go 785 package main 786 787 import ( 788 "context" 789 "fmt" 790 "os" 791 openapiclient "./openapi" 792 ) 793 794 func main() { 795 lang := "lang_example" // string | 言語指定 (optional) 796 isDev := true // bool | 開発者モードの有効・無効 (optional) 797 798 configuration := openapiclient.NewConfiguration() 799 api_client := openapiclient.NewAPIClient(configuration) 800 resp, r, err := api_client.DeviceApi.GetDeviceProfile(context.Background()).Lang(lang).IsDev(isDev).Execute() 801 if err.Error() != "" { 802 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDeviceProfile``: %v\n", err) 803 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 804 } 805 // response from `GetDeviceProfile`: SingleDevice 806 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDeviceProfile`: %v\n", resp) 807 } 808 ``` 809 810 ### Path Parameters 811 812 813 814 ### Other Parameters 815 816 Other parameters are passed through a pointer to a apiGetDeviceProfileRequest struct via the builder pattern 817 818 819 Name | Type | Description | Notes 820 ------------- | ------------- | ------------- | ------------- 821 **lang** | **string** | 言語指定 | 822 **isDev** | **bool** | 開発者モードの有効・無効 | 823 824 ### Return type 825 826 [**SingleDevice**](SingleDevice.md) 827 828 ### Authorization 829 830 No authorization required 831 832 ### HTTP request headers 833 834 - **Content-Type**: Not defined 835 - **Accept**: application/json 836 837 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 838 [[Back to Model list]](../README.md#documentation-for-models) 839 [[Back to README]](../README.md) 840 841 842 ## GetDevices 843 844 > MultipleDevice GetDevices(ctx).Offset(offset).Limit(limit).Order(order).OrderBy(orderBy).Lang(lang).IsDev(isDev).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Name(name).IdNumber(idNumber).DefinitionId(definitionId).DefinitionTag(definitionTag).Execute() 845 846 デバイスの一覧を取得する 847 848 849 850 ### Example 851 852 ```go 853 package main 854 855 import ( 856 "context" 857 "fmt" 858 "os" 859 openapiclient "./openapi" 860 ) 861 862 func main() { 863 offset := int64(789) // int64 | ページネーションのうち、何件読み飛ばすか (optional) 864 limit := int64(789) // int64 | ページネーションのうち、上位何件取得するか (optional) 865 order := "order_example" // string | ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 (optional) 866 orderBy := "orderBy_example" // string | ソート対象。指定順に高優先でのソートとなる (optional) 867 lang := "lang_example" // string | 言語指定 (optional) 868 isDev := true // bool | 開発者モードの有効・無効 (optional) 869 isPublic := "isPublic_example" // string | デバイスの公開・非公開 (optional) 870 resourceOwnerId := TODO // string | (optional) 871 name := "name_example" // string | 名前での部分一致検索 (optional) 872 idNumber := "idNumber_example" // string | 識別番号での完全一致検索 (optional) 873 definitionId := "definitionId_example" // string | デバイス定義ID(custom_inventory.definition_id)での完全一致検索 (optional) 874 definitionTag := "definitionTag_example" // string | custominventoryの内部データでの検索時に指定。 key,valueのセットの完全一致での検索とし、本パラメータでvalueを指定し、 inventory_keyでkeyを指定する。 (optional) 875 876 configuration := openapiclient.NewConfiguration() 877 api_client := openapiclient.NewAPIClient(configuration) 878 resp, r, err := api_client.DeviceApi.GetDevices(context.Background()).Offset(offset).Limit(limit).Order(order).OrderBy(orderBy).Lang(lang).IsDev(isDev).IsPublic(isPublic).ResourceOwnerId(resourceOwnerId).Name(name).IdNumber(idNumber).DefinitionId(definitionId).DefinitionTag(definitionTag).Execute() 879 if err.Error() != "" { 880 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.GetDevices``: %v\n", err) 881 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 882 } 883 // response from `GetDevices`: MultipleDevice 884 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.GetDevices`: %v\n", resp) 885 } 886 ``` 887 888 ### Path Parameters 889 890 891 892 ### Other Parameters 893 894 Other parameters are passed through a pointer to a apiGetDevicesRequest struct via the builder pattern 895 896 897 Name | Type | Description | Notes 898 ------------- | ------------- | ------------- | ------------- 899 **offset** | **int64** | ページネーションのうち、何件読み飛ばすか | 900 **limit** | **int64** | ページネーションのうち、上位何件取得するか | 901 **order** | **string** | ソート順序。 order_byで指定したkeyそれぞれに対して昇順、降順を配列で指定 | 902 **orderBy** | **string** | ソート対象。指定順に高優先でのソートとなる | 903 **lang** | **string** | 言語指定 | 904 **isDev** | **bool** | 開発者モードの有効・無効 | 905 **isPublic** | **string** | デバイスの公開・非公開 | 906 **resourceOwnerId** | [**string**](string.md) | | 907 **name** | **string** | 名前での部分一致検索 | 908 **idNumber** | **string** | 識別番号での完全一致検索 | 909 **definitionId** | **string** | デバイス定義ID(custom_inventory.definition_id)での完全一致検索 | 910 **definitionTag** | **string** | custominventoryの内部データでの検索時に指定。 key,valueのセットの完全一致での検索とし、本パラメータでvalueを指定し、 inventory_keyでkeyを指定する。 | 911 912 ### Return type 913 914 [**MultipleDevice**](MultipleDevice.md) 915 916 ### Authorization 917 918 [bearerAuth](../README.md#bearerAuth) 919 920 ### HTTP request headers 921 922 - **Content-Type**: Not defined 923 - **Accept**: application/json 924 925 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 926 [[Back to Model list]](../README.md#documentation-for-models) 927 [[Back to README]](../README.md) 928 929 930 ## UpdateDevice 931 932 > SingleDevice UpdateDevice(ctx, deviceId).DeviceUpdateRequest(deviceUpdateRequest).Execute() 933 934 指定したidのデバイス情報を更新する 935 936 937 938 ### Example 939 940 ```go 941 package main 942 943 import ( 944 "context" 945 "fmt" 946 "os" 947 openapiclient "./openapi" 948 ) 949 950 func main() { 951 deviceId := "deviceId_example" // string | デバイスID 952 deviceUpdateRequest := *openapiclient.NewDeviceUpdateRequest() // DeviceUpdateRequest | 953 954 configuration := openapiclient.NewConfiguration() 955 api_client := openapiclient.NewAPIClient(configuration) 956 resp, r, err := api_client.DeviceApi.UpdateDevice(context.Background(), deviceId).DeviceUpdateRequest(deviceUpdateRequest).Execute() 957 if err.Error() != "" { 958 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.UpdateDevice``: %v\n", err) 959 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 960 } 961 // response from `UpdateDevice`: SingleDevice 962 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.UpdateDevice`: %v\n", resp) 963 } 964 ``` 965 966 ### Path Parameters 967 968 969 Name | Type | Description | Notes 970 ------------- | ------------- | ------------- | ------------- 971 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 972 **deviceId** | **string** | デバイスID | 973 974 ### Other Parameters 975 976 Other parameters are passed through a pointer to a apiUpdateDeviceRequest struct via the builder pattern 977 978 979 Name | Type | Description | Notes 980 ------------- | ------------- | ------------- | ------------- 981 982 **deviceUpdateRequest** | [**DeviceUpdateRequest**](DeviceUpdateRequest.md) | | 983 984 ### Return type 985 986 [**SingleDevice**](SingleDevice.md) 987 988 ### Authorization 989 990 [bearerAuth](../README.md#bearerAuth) 991 992 ### HTTP request headers 993 994 - **Content-Type**: application/json 995 - **Accept**: application/json 996 997 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 998 [[Back to Model list]](../README.md#documentation-for-models) 999 [[Back to README]](../README.md) 1000 1001 1002 ## UpdateDeviceClient 1003 1004 > SingleDeviceClientList UpdateDeviceClient(ctx, deviceId, clientId).RsaPublicKey(rsaPublicKey).Execute() 1005 1006 device.write 1007 1008 1009 1010 ### Example 1011 1012 ```go 1013 package main 1014 1015 import ( 1016 "context" 1017 "fmt" 1018 "os" 1019 openapiclient "./openapi" 1020 ) 1021 1022 func main() { 1023 deviceId := "deviceId_example" // string | 1024 clientId := "clientId_example" // string | 1025 rsaPublicKey := *openapiclient.NewRsaPublicKey("RsaPublickey_example") // RsaPublicKey | 1026 1027 configuration := openapiclient.NewConfiguration() 1028 api_client := openapiclient.NewAPIClient(configuration) 1029 resp, r, err := api_client.DeviceApi.UpdateDeviceClient(context.Background(), deviceId, clientId).RsaPublicKey(rsaPublicKey).Execute() 1030 if err.Error() != "" { 1031 fmt.Fprintf(os.Stderr, "Error when calling `DeviceApi.UpdateDeviceClient``: %v\n", err) 1032 fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) 1033 } 1034 // response from `UpdateDeviceClient`: SingleDeviceClientList 1035 fmt.Fprintf(os.Stdout, "Response from `DeviceApi.UpdateDeviceClient`: %v\n", resp) 1036 } 1037 ``` 1038 1039 ### Path Parameters 1040 1041 1042 Name | Type | Description | Notes 1043 ------------- | ------------- | ------------- | ------------- 1044 **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. 1045 **deviceId** | **string** | | 1046 **clientId** | **string** | | 1047 1048 ### Other Parameters 1049 1050 Other parameters are passed through a pointer to a apiUpdateDeviceClientRequest struct via the builder pattern 1051 1052 1053 Name | Type | Description | Notes 1054 ------------- | ------------- | ------------- | ------------- 1055 1056 1057 **rsaPublicKey** | [**RsaPublicKey**](RsaPublicKey.md) | | 1058 1059 ### Return type 1060 1061 [**SingleDeviceClientList**](SingleDeviceClientList.md) 1062 1063 ### Authorization 1064 1065 No authorization required 1066 1067 ### HTTP request headers 1068 1069 - **Content-Type**: application/json 1070 - **Accept**: application/json 1071 1072 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) 1073 [[Back to Model list]](../README.md#documentation-for-models) 1074 [[Back to README]](../README.md) 1075