All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| CreateDeviceTemplate | Post /manage/api/v8/devicetemplates | Creates a device template. |
| CreateDeviceTemplateVersion | Post /manage/api/v8/devicetemplates/versions | Creates a new version of an existing device template. |
| DeleteDeviceTemplate | Delete /manage/api/v8/devicetemplates/{id} | Deletes a device template. |
| GetDeviceTemplate | Get /manage/api/v8/devicetemplates/{id} | Returns a device template. |
| GetDeviceTemplatesList | Get /manage/api/v8/devicetemplates/list | Returns a list of device templates. |
| ScanDeviceTemplateParameters | Post /manage/api/v8/devicetemplates/parameters/scan | API to scan parameters from the device template XML. |
| UpdateDeviceTemplateAccess | Put /manage/api/v8/devicetemplates/{id}/access | Updates device template access. |
DeviceTemplate CreateDeviceTemplate(ctx).DeviceTemplateCreate(deviceTemplateCreate).Execute()
Creates a device template.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
deviceTemplateCreate := *openapiclient.NewDeviceTemplateCreate("Name_example", "ServiceType_example", "ConfigContent_example", "ResourceProvider_example") // DeviceTemplateCreate |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.CreateDeviceTemplate(context.Background()).DeviceTemplateCreate(deviceTemplateCreate).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.CreateDeviceTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateDeviceTemplate`: DeviceTemplate
fmt.Fprintf(os.Stdout, "Response from `DeviceTemplatesApi.CreateDeviceTemplate`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateDeviceTemplateRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| deviceTemplateCreate | DeviceTemplateCreate |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeviceTemplate CreateDeviceTemplateVersion(ctx).DeviceTemplateVersionCreate(deviceTemplateVersionCreate).Execute()
Creates a new version of an existing device template.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
deviceTemplateVersionCreate := *openapiclient.NewDeviceTemplateVersionCreate("Name_example", "ConfigContent_example") // DeviceTemplateVersionCreate |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.CreateDeviceTemplateVersion(context.Background()).DeviceTemplateVersionCreate(deviceTemplateVersionCreate).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.CreateDeviceTemplateVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateDeviceTemplateVersion`: DeviceTemplate
fmt.Fprintf(os.Stdout, "Response from `DeviceTemplatesApi.CreateDeviceTemplateVersion`: %v\n", resp)
}Other parameters are passed through a pointer to a apiCreateDeviceTemplateVersionRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| deviceTemplateVersionCreate | DeviceTemplateVersionCreate |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteDeviceTemplate(ctx, id).Execute()
Deletes a device template.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.DeleteDeviceTemplate(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.DeleteDeviceTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
Other parameters are passed through a pointer to a apiDeleteDeviceTemplateRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeviceTemplate GetDeviceTemplate(ctx, id).Execute()
Returns a device template.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.GetDeviceTemplate(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.GetDeviceTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetDeviceTemplate`: DeviceTemplate
fmt.Fprintf(os.Stdout, "Response from `DeviceTemplatesApi.GetDeviceTemplate`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
Other parameters are passed through a pointer to a apiGetDeviceTemplateRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]DeviceTemplate GetDeviceTemplatesList(ctx).AllVersions(allVersions).ServiceType(serviceType).TenantId(tenantId).Execute()
Returns a list of device templates.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
allVersions := true // bool | (optional) (default to false)
serviceType := "manageddevice" // string | (optional)
tenantId := "2664f157-18d8-4ecd-8c78-66b7cb7e1e25" // string | (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.GetDeviceTemplatesList(context.Background()).AllVersions(allVersions).ServiceType(serviceType).TenantId(tenantId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.GetDeviceTemplatesList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetDeviceTemplatesList`: []DeviceTemplate
fmt.Fprintf(os.Stdout, "Response from `DeviceTemplatesApi.GetDeviceTemplatesList`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetDeviceTemplatesListRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| allVersions | bool | [default to false] | |
| serviceType | string | ||
| tenantId | string |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]string ScanDeviceTemplateParameters(ctx).File(file).Execute()
API to scan parameters from the device template XML.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
file := os.NewFile(1234, "some_file") // *os.File | The XML template file of a device template (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.ScanDeviceTemplateParameters(context.Background()).File(file).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.ScanDeviceTemplateParameters``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ScanDeviceTemplateParameters`: []string
fmt.Fprintf(os.Stdout, "Response from `DeviceTemplatesApi.ScanDeviceTemplateParameters`: %v\n", resp)
}Other parameters are passed through a pointer to a apiScanDeviceTemplateParametersRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| file | *os.File | The XML template file of a device template |
[]string
No authorization required
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeviceTemplateAccessResponse UpdateDeviceTemplateAccess(ctx, id).DeviceTemplateAccess(deviceTemplateAccess).Execute()
Updates device template access.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |
deviceTemplateAccess := *openapiclient.NewDeviceTemplateAccess() // DeviceTemplateAccess |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.DeviceTemplatesApi.UpdateDeviceTemplateAccess(context.Background(), id).DeviceTemplateAccess(deviceTemplateAccess).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DeviceTemplatesApi.UpdateDeviceTemplateAccess``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateDeviceTemplateAccess`: DeviceTemplateAccessResponse
fmt.Fprintf(os.Stdout, "Response from `DeviceTemplatesApi.UpdateDeviceTemplateAccess`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
Other parameters are passed through a pointer to a apiUpdateDeviceTemplateAccessRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
deviceTemplateAccess | DeviceTemplateAccess | |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]