All URIs are relative to https://api.notefile.net
| Method | HTTP request | Description |
|---|---|---|
| GetEvents | Get /v1/projects/{projectOrProductUID}/events | |
| GetEventsByCursor | Get /v1/projects/{projectOrProductUID}/events-cursor | |
| GetFleetEvents | Get /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events | |
| GetFleetEventsByCursor | Get /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor | |
| GetRouteLogsByEvent | Get /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs |
GetEvents200Response GetEvents(ctx, projectOrProductUID).PageSize(pageSize).PageNum(pageNum).DeviceUID(deviceUID).SortBy(sortBy).SortOrder(sortOrder).StartDate(startDate).EndDate(endDate).DateType(dateType).SystemFilesOnly(systemFilesOnly).Files(files).Format(format).SerialNumber(serialNumber).FleetUID(fleetUID).SessionUID(sessionUID).EventUID(eventUID).SelectFields(selectFields).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
pageSize := int32(56) // int32 | (optional) (default to 50)
pageNum := int32(56) // int32 | (optional) (default to 1)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
sortBy := "sortBy_example" // string | (optional) (default to "captured")
sortOrder := "sortOrder_example" // string | (optional) (default to "asc")
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
dateType := "uploaded" // string | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to "captured")
systemFilesOnly := true // bool | (optional)
files := "_health.qo, data.qo" // string | (optional)
format := "format_example" // string | Response format (JSON or CSV) (optional) (default to "json")
serialNumber := []string{"Inner_example"} // []string | Filter by Serial Number (optional)
fleetUID := []string{"Inner_example"} // []string | Filter by Fleet UID (optional)
sessionUID := []string{"Inner_example"} // []string | Filter by Session UID (optional)
eventUID := []string{"Inner_example"} // []string | Filter by Event UID (optional)
selectFields := "selectFields_example" // string | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.EventAPI.GetEvents(context.Background(), projectOrProductUID).PageSize(pageSize).PageNum(pageNum).DeviceUID(deviceUID).SortBy(sortBy).SortOrder(sortOrder).StartDate(startDate).EndDate(endDate).DateType(dateType).SystemFilesOnly(systemFilesOnly).Files(files).Format(format).SerialNumber(serialNumber).FleetUID(fleetUID).SessionUID(sessionUID).EventUID(eventUID).SelectFields(selectFields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `EventAPI.GetEvents``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetEvents`: GetEvents200Response
fmt.Fprintf(os.Stdout, "Response from `EventAPI.GetEvents`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string |
Other parameters are passed through a pointer to a apiGetEventsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
pageSize | int32 | | [default to 50] pageNum | int32 | | [default to 1] deviceUID | []string | A Device UID. | sortBy | string | | [default to "captured"] sortOrder | string | | [default to "asc"] startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp | dateType | string | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters | [default to "captured"] systemFilesOnly | bool | | files | string | | format | string | Response format (JSON or CSV) | [default to "json"] serialNumber | []string | Filter by Serial Number | fleetUID | []string | Filter by Fleet UID | sessionUID | []string | Filter by Session UID | eventUID | []string | Filter by Event UID | selectFields | string | Comma-separated list of fields to select from JSON payload (e.g., "field1,field2.subfield,field3"), this will reflect the columns in the CSV output. |
- Content-Type: Not defined
- Accept: application/json, text/csv
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEventsByCursor200Response GetEventsByCursor(ctx, projectOrProductUID).Limit(limit).Cursor(cursor).SortOrder(sortOrder).SystemFilesOnly(systemFilesOnly).Files(files).FleetUID(fleetUID).DeviceUID(deviceUID).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
limit := int32(56) // int32 | (optional) (default to 50)
cursor := "cursor_example" // string | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional)
sortOrder := "sortOrder_example" // string | (optional) (default to "asc")
systemFilesOnly := true // bool | (optional)
files := "_health.qo, data.qo" // string | (optional)
fleetUID := "fleetUID_example" // string | (optional)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.EventAPI.GetEventsByCursor(context.Background(), projectOrProductUID).Limit(limit).Cursor(cursor).SortOrder(sortOrder).SystemFilesOnly(systemFilesOnly).Files(files).FleetUID(fleetUID).DeviceUID(deviceUID).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `EventAPI.GetEventsByCursor``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetEventsByCursor`: GetEventsByCursor200Response
fmt.Fprintf(os.Stdout, "Response from `EventAPI.GetEventsByCursor`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string |
Other parameters are passed through a pointer to a apiGetEventsByCursorRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
limit | int32 | | [default to 50] cursor | string | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | sortOrder | string | | [default to "asc"] systemFilesOnly | bool | | files | string | | fleetUID | string | | deviceUID | []string | A Device UID. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEvents200Response GetFleetEvents(ctx, projectOrProductUID, fleetUID).PageSize(pageSize).PageNum(pageNum).DeviceUID(deviceUID).SortBy(sortBy).SortOrder(sortOrder).StartDate(startDate).EndDate(endDate).DateType(dateType).SystemFilesOnly(systemFilesOnly).Files(files).Format(format).SerialNumber(serialNumber).SessionUID(sessionUID).EventUID(eventUID).SelectFields(selectFields).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
fleetUID := "fleetUID_example" // string |
pageSize := int32(56) // int32 | (optional) (default to 50)
pageNum := int32(56) // int32 | (optional) (default to 1)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
sortBy := "sortBy_example" // string | (optional) (default to "captured")
sortOrder := "sortOrder_example" // string | (optional) (default to "asc")
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
dateType := "uploaded" // string | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to "captured")
systemFilesOnly := true // bool | (optional)
files := "_health.qo, data.qo" // string | (optional)
format := "format_example" // string | Response format (JSON or CSV) (optional) (default to "json")
serialNumber := []string{"Inner_example"} // []string | Filter by Serial Number (optional)
sessionUID := []string{"Inner_example"} // []string | Filter by Session UID (optional)
eventUID := []string{"Inner_example"} // []string | Filter by Event UID (optional)
selectFields := "selectFields_example" // string | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.EventAPI.GetFleetEvents(context.Background(), projectOrProductUID, fleetUID).PageSize(pageSize).PageNum(pageNum).DeviceUID(deviceUID).SortBy(sortBy).SortOrder(sortOrder).StartDate(startDate).EndDate(endDate).DateType(dateType).SystemFilesOnly(systemFilesOnly).Files(files).Format(format).SerialNumber(serialNumber).SessionUID(sessionUID).EventUID(eventUID).SelectFields(selectFields).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `EventAPI.GetFleetEvents``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetFleetEvents`: GetEvents200Response
fmt.Fprintf(os.Stdout, "Response from `EventAPI.GetFleetEvents`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string | ||
| fleetUID | string |
Other parameters are passed through a pointer to a apiGetFleetEventsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
pageSize | int32 | | [default to 50] pageNum | int32 | | [default to 1] deviceUID | []string | A Device UID. | sortBy | string | | [default to "captured"] sortOrder | string | | [default to "asc"] startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp | dateType | string | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters | [default to "captured"] systemFilesOnly | bool | | files | string | | format | string | Response format (JSON or CSV) | [default to "json"] serialNumber | []string | Filter by Serial Number | sessionUID | []string | Filter by Session UID | eventUID | []string | Filter by Event UID | selectFields | string | Comma-separated list of fields to select from JSON payload (e.g., "field1,field2.subfield,field3"), this will reflect the columns in the CSV output. |
- Content-Type: Not defined
- Accept: application/json, text/csv
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetEventsByCursor200Response GetFleetEventsByCursor(ctx, projectOrProductUID, fleetUID).Limit(limit).Cursor(cursor).SortOrder(sortOrder).SystemFilesOnly(systemFilesOnly).Files(files).DeviceUID(deviceUID).StartDate(startDate).EndDate(endDate).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
fleetUID := "fleetUID_example" // string |
limit := int32(56) // int32 | (optional) (default to 50)
cursor := "cursor_example" // string | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional)
sortOrder := "sortOrder_example" // string | (optional) (default to "asc")
systemFilesOnly := true // bool | (optional)
files := "_health.qo, data.qo" // string | (optional)
deviceUID := []string{"Inner_example"} // []string | A Device UID. (optional)
startDate := int32(1628631763) // int32 | Start date for filtering results, specified as a Unix timestamp (optional)
endDate := int32(1657894210) // int32 | End date for filtering results, specified as a Unix timestamp (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.EventAPI.GetFleetEventsByCursor(context.Background(), projectOrProductUID, fleetUID).Limit(limit).Cursor(cursor).SortOrder(sortOrder).SystemFilesOnly(systemFilesOnly).Files(files).DeviceUID(deviceUID).StartDate(startDate).EndDate(endDate).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `EventAPI.GetFleetEventsByCursor``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetFleetEventsByCursor`: GetEventsByCursor200Response
fmt.Fprintf(os.Stdout, "Response from `EventAPI.GetFleetEventsByCursor`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string | ||
| fleetUID | string |
Other parameters are passed through a pointer to a apiGetFleetEventsByCursorRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
limit | int32 | | [default to 50] cursor | string | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. | sortOrder | string | | [default to "asc"] systemFilesOnly | bool | | files | string | | deviceUID | []string | A Device UID. | startDate | int32 | Start date for filtering results, specified as a Unix timestamp | endDate | int32 | End date for filtering results, specified as a Unix timestamp |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RouteLog GetRouteLogsByEvent(ctx, projectOrProductUID, eventUID).Execute()
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/blues/notehub-go"
)
func main() {
projectOrProductUID := "app:2606f411-dea6-44a0-9743-1130f57d77d8" // string |
eventUID := "4506f411-dea6-44a0-9743-1130f57d7747" // string |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.EventAPI.GetRouteLogsByEvent(context.Background(), projectOrProductUID, eventUID).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `EventAPI.GetRouteLogsByEvent``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRouteLogsByEvent`: []RouteLog
fmt.Fprintf(os.Stdout, "Response from `EventAPI.GetRouteLogsByEvent`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectOrProductUID | string | ||
| eventUID | string |
Other parameters are passed through a pointer to a apiGetRouteLogsByEventRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]