Skip to content

DefaultApi.md

Latest commit

 

History

History
1003 lines (651 loc) · 32.9 KB

DefaultApi.md

File metadata and controls

1003 lines (651 loc) · 32.9 KB

\DefaultApi

All URIs are relative to https://api.enphaseenergy.com/api/v2

Method HTTP request Description
ConsumptionLifetime Get /systems/{system_id}/consumption_lifetime
ConsumptionStats Get /systems/{system_id}/consumption_stats
EnergyLifetime Get /systems/{system_id}/energy_lifetime
Envoys Get /systems/{system_id}/envoys
Inventory Get /systems/{system_id}/inventory
InvertersSummaryByEnvoyOrSite Get /systems/inverters_summary_by_envoy_or_site
MonthlyProduction Get /systems/{system_id}/monthly_production
ProductionMeterReadings Get /systems/{system_id}/production_meter_readings
RgmStats Get /systems/{system_id}/rgm_stats
SearchSystemId Get /systems/search_system_id
Stats Get /systems/{system_id}/stats
Summary Get /systems/{system_id}/summary
Systems Get /systems

ConsumptionLifetime

ConsumptionLifetimeResponse ConsumptionLifetime(ctx, systemId).UserId(userId).StartDate(startDate).EndDate(endDate).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    startDate := time.Now() // string | The date on which to start the time series. Defaults to the system's operational date. (optional)
    endDate := time.Now() // string | The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.ConsumptionLifetime(context.Background(), systemId).UserId(userId).StartDate(startDate).EndDate(endDate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ConsumptionLifetime``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConsumptionLifetime`: ConsumptionLifetimeResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ConsumptionLifetime`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionLifetimeRequest struct via the builder pattern

Name Type Description Notes
userId string

startDate | string | The date on which to start the time series. Defaults to the system's operational date. | endDate | string | The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier. |

Return type

ConsumptionLifetimeResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConsumptionStats

ConsumptionStatsResponse ConsumptionStats(ctx, systemId).UserId(userId).StartAt(startAt).EndAt(endAt).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    startAt := int64(1448946000) // int64 | Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago, the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`. (optional)
    endAt := int64(1449011615) // int64 | End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with the last reported interval. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.ConsumptionStats(context.Background(), systemId).UserId(userId).StartAt(startAt).EndAt(endAt).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ConsumptionStats``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ConsumptionStats`: ConsumptionStatsResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ConsumptionStats`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiConsumptionStatsRequest struct via the builder pattern

Name Type Description Notes
userId string

startAt | int64 | Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago, the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`. | endAt | int64 | End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with the last reported interval. |

Return type

ConsumptionStatsResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnergyLifetime

EnergyLifetimeResponse EnergyLifetime(ctx, systemId).UserId(userId).StartDate(startDate).EndDate(endDate).Production(production).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    startDate := time.Now() // string | The date on which to start the time series. Defaults to the system's operational date. (optional)
    endDate := time.Now() // string | The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier. (optional)
    production := "all" // string | When `all`, returns the merged time series plus the time series as reported by the microinverters and the meter on the system. Other values are ignored. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.EnergyLifetime(context.Background(), systemId).UserId(userId).StartDate(startDate).EndDate(endDate).Production(production).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.EnergyLifetime``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EnergyLifetime`: EnergyLifetimeResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.EnergyLifetime`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiEnergyLifetimeRequest struct via the builder pattern

Name Type Description Notes
userId string

startDate | string | The date on which to start the time series. Defaults to the system's operational date. | endDate | string | The last date to include in the time series. Defaults to yesterday or the last day the system reported, whichever is earlier. | production | string | When `all`, returns the merged time series plus the time series as reported by the microinverters and the meter on the system. Other values are ignored. |

Return type

EnergyLifetimeResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Envoys

EnvoysResponse Envoys(ctx, systemId).UserId(userId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.Envoys(context.Background(), systemId).UserId(userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.Envoys``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Envoys`: EnvoysResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.Envoys`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiEnvoysRequest struct via the builder pattern

Name Type Description Notes
userId string

Return type

EnvoysResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Inventory

InventoryResponse Inventory(ctx, systemId).UserId(userId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.Inventory(context.Background(), systemId).UserId(userId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.Inventory``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Inventory`: InventoryResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.Inventory`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiInventoryRequest struct via the builder pattern

Name Type Description Notes
userId string

Return type

InventoryResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InvertersSummaryByEnvoyOrSite

[]InvertersSummaryByEnvoyOrSiteResponse InvertersSummaryByEnvoyOrSite(ctx).UserId(userId).SiteId(siteId).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    siteId := int32(66) // int32 | The identifier of the system.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.InvertersSummaryByEnvoyOrSite(context.Background()).UserId(userId).SiteId(siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.InvertersSummaryByEnvoyOrSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `InvertersSummaryByEnvoyOrSite`: []InvertersSummaryByEnvoyOrSiteResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.InvertersSummaryByEnvoyOrSite`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiInvertersSummaryByEnvoyOrSiteRequest struct via the builder pattern

Name Type Description Notes
userId string
siteId int32 The identifier of the system.

Return type

[]InvertersSummaryByEnvoyOrSiteResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

MonthlyProduction

MonthlyProductionResponse MonthlyProduction(ctx, systemId).UserId(userId).StartDate(startDate).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    startDate := time.Now() // string | Start date for reporting period. The reporting period ends on the previous day of the next month; for example, a `start_date` of 2011-07-20 returns data through 2011-06-19. When the start date is the first of a calendar month, the end date is the last day of that month.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.MonthlyProduction(context.Background(), systemId).UserId(userId).StartDate(startDate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.MonthlyProduction``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `MonthlyProduction`: MonthlyProductionResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.MonthlyProduction`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiMonthlyProductionRequest struct via the builder pattern

Name Type Description Notes
userId string

startDate | string | Start date for reporting period. The reporting period ends on the previous day of the next month; for example, a `start_date` of 2011-07-20 returns data through 2011-06-19. When the start date is the first of a calendar month, the end date is the last day of that month. |

Return type

MonthlyProductionResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ProductionMeterReadings

ProductionMeterReadingsResponse ProductionMeterReadings(ctx, systemId).UserId(userId).EndAt(endAt).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    endAt := int64(1473901755) // int64 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.ProductionMeterReadings(context.Background(), systemId).UserId(userId).EndAt(endAt).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ProductionMeterReadings``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ProductionMeterReadings`: ProductionMeterReadingsResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ProductionMeterReadings`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiProductionMeterReadingsRequest struct via the builder pattern

Name Type Description Notes
userId string

endAt | int64 | |

Return type

ProductionMeterReadingsResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RgmStats

RgmStatsResponse RgmStats(ctx, systemId).UserId(userId).StartAt(startAt).EndAt(endAt).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    startAt := int64(1381474800) // int64 | Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago, the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`. (optional)
    endAt := int64(1381561200) // int64 | End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with the last reported interval. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.RgmStats(context.Background(), systemId).UserId(userId).StartAt(startAt).EndAt(endAt).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.RgmStats``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RgmStats`: RgmStatsResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.RgmStats`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiRgmStatsRequest struct via the builder pattern

Name Type Description Notes
userId string

startAt | int64 | Start of period to report on in Unix epoch time. If no start is specified, the assumed start is midnight today, in the timezone of the system. If the start is earlier than one year ago, the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the first interval of the `operational_date`. | endAt | int64 | End of reporting period in Unix epoch time. If no end is specified, defaults to the time of the request. If the end is later than the last reported interval the response data ends with the last reported interval. |

Return type

RgmStatsResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchSystemId

SearchSystemIdResponse SearchSystemId(ctx).UserId(userId).SerialNum(serialNum).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    serialNum := "23435345345" // string | Serial number of the envoy.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.SearchSystemId(context.Background()).UserId(userId).SerialNum(serialNum).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.SearchSystemId``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SearchSystemId`: SearchSystemIdResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.SearchSystemId`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSearchSystemIdRequest struct via the builder pattern

Name Type Description Notes
userId string
serialNum string Serial number of the envoy.

Return type

SearchSystemIdResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Stats

StatsResponse Stats(ctx, systemId).UserId(userId).StartAt(startAt).EndAt(endAt).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    startAt := int64(1381496100) // int64 | Start of reporting period in Unix epoch time. If no start is specified, defaults to midnight today, in the timezone of the system. If the start date is earlier than one year ago today, the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the `operational_date`. (optional)
    endAt := int64(1381497600) // int64 | End of reporting period in Unix epoch time. If no end is specified, the assumed end is now. If the end is later than the last reporting interval the response data ends with the last reported interval. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.Stats(context.Background(), systemId).UserId(userId).StartAt(startAt).EndAt(endAt).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.Stats``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Stats`: StatsResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.Stats`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiStatsRequest struct via the builder pattern

Name Type Description Notes
userId string

startAt | int64 | Start of reporting period in Unix epoch time. If no start is specified, defaults to midnight today, in the timezone of the system. If the start date is earlier than one year ago today, the response includes an empty intervals list. If the start is earlier than the system's `operational_date`, the response data begins with the `operational_date`. | endAt | int64 | End of reporting period in Unix epoch time. If no end is specified, the assumed end is now. If the end is later than the last reporting interval the response data ends with the last reported interval. |

Return type

StatsResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Summary

SummaryResponse Summary(ctx, systemId).UserId(userId).SummaryDate(summaryDate).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    systemId := int32(66) // int32 | 
    summaryDate := time.Now() // string | Start of reporting period. If no `summary_date` is provided, the start is the current day at midnight site-local time. Otherwise, the start is midnight site-local time of the requested day. If the requested date cannot be parsed or is in the future, the response includes an informative error message and `422` status. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.Summary(context.Background(), systemId).UserId(userId).SummaryDate(summaryDate).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.Summary``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Summary`: SummaryResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.Summary`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
systemId int32

Other Parameters

Other parameters are passed through a pointer to a apiSummaryRequest struct via the builder pattern

Name Type Description Notes
userId string

summaryDate | string | Start of reporting period. If no `summary_date` is provided, the start is the current day at midnight site-local time. Otherwise, the start is midnight site-local time of the requested day. If the requested date cannot be parsed or is in the future, the response includes an informative error message and `422` status. |

Return type

SummaryResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Systems

SystemsResponse Systems(ctx).UserId(userId).Next(next).Limit(limit).SystemId(systemId).SystemId2(systemId2).SystemName(systemName).SystemName2(systemName2).Status(status).Status2(status2).Reference(reference).Reference2(reference2).Installer(installer).Installer2(installer2).ConnectionType(connectionType).ConnectionType2(connectionType2).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    userId := "4d6a51330a" // string | 
    next := "4d5467784d5445770a" // string |  (optional)
    limit := int32(100) // int32 |  (optional) (default to 100)
    systemId := int32(67) // int32 |  (optional)
    systemId2 := []int32{int32(123)} // []int32 |  (optional)
    systemName := "Green" // string |  (optional)
    systemName2 := []string{"Inner_example"} // []string |  (optional)
    status := openapiclient.Status("comm") // Status |  (optional)
    status2 := []openapiclient.Status{openapiclient.Status("comm")} // []Status |  (optional)
    reference := "reference_example" // string |  (optional)
    reference2 := []string{"Inner_example"} // []string |  (optional)
    installer := "installer_example" // string |  (optional)
    installer2 := []string{"Inner_example"} // []string |  (optional)
    connectionType := openapiclient.ConnectionType("ethernet") // ConnectionType |  (optional)
    connectionType2 := []openapiclient.ConnectionType{openapiclient.ConnectionType("ethernet")} // []ConnectionType |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DefaultApi.Systems(context.Background()).UserId(userId).Next(next).Limit(limit).SystemId(systemId).SystemId2(systemId2).SystemName(systemName).SystemName2(systemName2).Status(status).Status2(status2).Reference(reference).Reference2(reference2).Installer(installer).Installer2(installer2).ConnectionType(connectionType).ConnectionType2(connectionType2).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.Systems``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `Systems`: SystemsResponse
    fmt.Fprintf(os.Stdout, "Response from `DefaultApi.Systems`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiSystemsRequest struct via the builder pattern

Name Type Description Notes
userId string
next string
limit int32 [default to 100]
systemId int32
systemId2 []int32
systemName string
systemName2 []string
status Status
status2 []Status
reference string
reference2 []string
installer string
installer2 []string
connectionType ConnectionType
connectionType2 []ConnectionType

Return type

SystemsResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]