\CollectionsApi

All URIs are relative to https://api.lab5e.com

Method	HTTP request	Description
CreateCollection	Post /span/collections	Create collection
DeleteCollection	Delete /span/collections/{collectionId}	Delete collection
ListCollectionData	Get /span/collections/{collectionId}/data	Retrieve data from devices
ListCollections	Get /span/collections	List collections
RetrieveCollection	Get /span/collections/{collectionId}	Retrieve collection
RetrieveCollectionStats	Get /span/collections/{collectionId}/stats	Retrieve collection statistics
UpdateCollection	Patch /span/collections/{collectionId}	Update collection

CreateCollection

Collection CreateCollection(ctx).Body(body).Execute()

Create collection

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    body := *openapiclient.NewCreateCollectionRequest() // CreateCollectionRequest | Request object when creating a collection. The collect ID is assigned by the service.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CollectionsApi.CreateCollection(context.Background()).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CollectionsApi.CreateCollection``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateCollection`: Collection
    fmt.Fprintf(os.Stdout, "Response from `CollectionsApi.CreateCollection`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
body	CreateCollectionRequest	Request object when creating a collection. The collect ID is assigned by the service.

Return type

Collection

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

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

DeleteCollection

Collection DeleteCollection(ctx, collectionId).Execute()

Delete collection

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | The ID of the collection you want to delete

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string	The ID of the collection you want to delete

Other Parameters

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

Name	Type	Description	Notes

Return type

Collection

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListCollectionData

ListDataResponse ListCollectionData(ctx, collectionId).Limit(limit).Start(start).End(end).Offset(offset).Execute()

Retrieve data from devices

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | The collection ID requested. This is included in the request path.
    limit := int32(56) // int32 | Limit the number of payloads to return. The default is 512. (optional)
    start := "start_example" // string | Start of time range. The default is 24 hours ago. Value is in milliseconds since epoch. (optional)
    end := "end_example" // string | End of time range. The default is the current time stamp. Value is in milliseconds since epoch. (optional)
    offset := "offset_example" // string | The message offset based on the message ID. This parameter can't be combined with the start and end parameters. If no parameter is set the first N messages will be returned. If this parameter is set the next N messages (from newest to oldest) with message ID less than the offset will be returned. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CollectionsApi.ListCollectionData(context.Background(), collectionId).Limit(limit).Start(start).End(end).Offset(offset).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CollectionsApi.ListCollectionData``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListCollectionData`: ListDataResponse
    fmt.Fprintf(os.Stdout, "Response from `CollectionsApi.ListCollectionData`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string	The collection ID requested. This is included in the request path.

Other Parameters

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

Name	Type	Description	Notes

limit | int32 | Limit the number of payloads to return. The default is 512. | start | string | Start of time range. The default is 24 hours ago. Value is in milliseconds since epoch. | end | string | End of time range. The default is the current time stamp. Value is in milliseconds since epoch. | offset | string | The message offset based on the message ID. This parameter can't be combined with the start and end parameters. If no parameter is set the first N messages will be returned. If this parameter is set the next N messages (from newest to oldest) with message ID less than the offset will be returned. |

Return type

ListDataResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListCollections

ListCollectionResponse ListCollections(ctx).Execute()

List collections

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

ListCollectionResponse

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

RetrieveCollection

Collection RetrieveCollection(ctx, collectionId).Upstream(upstream).Downstream(downstream).Execute()

Retrieve collection

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | The collection ID of the collection you are requesting
    upstream := true // bool |  (optional)
    downstream := true // bool |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CollectionsApi.RetrieveCollection(context.Background(), collectionId).Upstream(upstream).Downstream(downstream).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CollectionsApi.RetrieveCollection``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RetrieveCollection`: Collection
    fmt.Fprintf(os.Stdout, "Response from `CollectionsApi.RetrieveCollection`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string	The collection ID of the collection you are requesting

Other Parameters

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

Name	Type	Description	Notes

Return type

Collection

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

RetrieveCollectionStats

CollectionStats RetrieveCollectionStats(ctx, collectionId).Execute()

Retrieve collection statistics

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | The collection ID of the collection you are requesting

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string	The collection ID of the collection you are requesting

Other Parameters

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

Name	Type	Description	Notes

Return type

CollectionStats

Authorization

APIToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdateCollection

Collection UpdateCollection(ctx, collectionId).Body(body).Execute()

Update collection

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/lab5e/go-spanapi"
)

func main() {
    collectionId := "collectionId_example" // string | The ID of the collection. This is assigned by the backend.
    body := *openapiclient.NewUpdateCollectionRequest() // UpdateCollectionRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.CollectionsApi.UpdateCollection(context.Background(), collectionId).Body(body).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `CollectionsApi.UpdateCollection``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateCollection`: Collection
    fmt.Fprintf(os.Stdout, "Response from `CollectionsApi.UpdateCollection`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	string	The ID of the collection. This is assigned by the backend.

Other Parameters

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

Name	Type	Description	Notes

body | UpdateCollectionRequest | |

Return type

Collection

Authorization

APIToken

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

CollectionsApi.md

Latest commit

History

CollectionsApi.md

File metadata and controls

\CollectionsApi

CreateCollection

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteCollection

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListCollectionData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListCollections

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetrieveCollection

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RetrieveCollectionStats

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateCollection

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers