api

package
v0.2.27 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2025 License: Apache-2.0 Imports: 21 Imported by: 2

Documentation

Index

Constants

View Source 
const DisplayNameAttributeKey = "shared/nickname"
View Source 
const DisplayNameAttributeOrigin = "shared"
View Source 
const UpdateOnlySameOriginAttributesKey = "update-only-same-origin-attributes"

Variables

This section is empty.

Functions

func GeneratedCheckMultiplePermissions_devicegroups added in v0.2.13 

func GeneratedCheckMultiplePermissions_devicegroups()

GeneratedCheckMultiplePermissions_devicegroups godoc @Summary check multiple permissions @Description check multiple permissions @Tags permissions-device-groups @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} map[string]bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/device-groups [get]

func GeneratedCheckMultiplePermissions_devices added in v0.2.13 

func GeneratedCheckMultiplePermissions_devices()

GeneratedCheckMultiplePermissions_devices godoc @Summary check multiple permissions @Description check multiple permissions @Tags permissions-devices @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} map[string]bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/devices [get]

func GeneratedCheckMultiplePermissions_hubs added in v0.2.13 

func GeneratedCheckMultiplePermissions_hubs()

GeneratedCheckMultiplePermissions_hubs godoc @Summary check multiple permissions @Description check multiple permissions @Tags permissions-hubs @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} map[string]bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/hubs [get]

func GeneratedCheckMultiplePermissions_locations added in v0.2.13 

func GeneratedCheckMultiplePermissions_locations()

GeneratedCheckMultiplePermissions_locations godoc @Summary check multiple permissions @Description check multiple permissions @Tags permissions-locations @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} map[string]bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/locations [get]

func GeneratedCheckPermission_devicegroups added in v0.2.13 

func GeneratedCheckPermission_devicegroups()

GeneratedCheckPermission_devicegroups godoc @Summary check permission @Description check permission @Tags permissions-device-groups @Security Bearer @Param id path string true "Resource Id" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/device-groups/{id} [get]

func GeneratedCheckPermission_devices added in v0.2.13 

func GeneratedCheckPermission_devices()

GeneratedCheckPermission_devices godoc @Summary check permission @Description check permission @Tags permissions-devices @Security Bearer @Param id path string true "Resource Id" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/devices/{id} [get]

func GeneratedCheckPermission_hubs added in v0.2.13 

func GeneratedCheckPermission_hubs()

GeneratedCheckPermission_hubs godoc @Summary check permission @Description check permission @Tags permissions-hubs @Security Bearer @Param id path string true "Resource Id" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/hubs/{id} [get]

func GeneratedCheckPermission_locations added in v0.2.13 

func GeneratedCheckPermission_locations()

GeneratedCheckPermission_locations godoc @Summary check permission @Description check permission @Tags permissions-locations @Security Bearer @Param id path string true "Resource Id" @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Produce json @Success 200 {object} bool @Failure 400 @Failure 401 @Failure 500 @Router /permissions/check/locations/{id} [get]

func GeneratedGetResource_devicegroups added in v0.2.13 

func GeneratedGetResource_devicegroups()

GeneratedGetResource_devicegroups godoc @Summary get resource @Description get resource, requesting user must have admin right on the resource @Tags permissions-device-groups @Security Bearer @Param id path string true "Resource Id" @Produce json @Success 200 {object} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/device-groups/{id} [get]

func GeneratedGetResource_devices added in v0.2.13 

func GeneratedGetResource_devices()

GeneratedGetResource_devices godoc @Summary get resource @Description get resource, requesting user must have admin right on the resource @Tags permissions-devices @Security Bearer @Param id path string true "Resource Id" @Produce json @Success 200 {object} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/devices/{id} [get]

func GeneratedGetResource_hubs added in v0.2.13 

func GeneratedGetResource_hubs()

GeneratedGetResource_hubs godoc @Summary get resource @Description get resource, requesting user must have admin right on the resource @Tags permissions-hubs @Security Bearer @Param id path string true "Resource Id" @Produce json @Success 200 {object} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/hubs/{id} [get]

func GeneratedGetResource_locations added in v0.2.13 

func GeneratedGetResource_locations()

GeneratedGetResource_locations godoc @Summary get resource @Description get resource, requesting user must have admin right on the resource @Tags permissions-locations @Security Bearer @Param id path string true "Resource Id" @Produce json @Success 200 {object} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/locations/{id} [get]

func GeneratedListAccessibleResourceIds_devicegroups added in v0.2.13 

func GeneratedListAccessibleResourceIds_devicegroups()

GeneratedListAccessibleResourceIds_devicegroups godoc @Summary list accessible resource ids @Description list accessible resource ids @Tags permissions-device-groups @Security Bearer @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} string @Failure 400 @Failure 401 @Failure 500 @Router /permissions/accessible/device-groups [get]

func GeneratedListAccessibleResourceIds_devices added in v0.2.13 

func GeneratedListAccessibleResourceIds_devices()

GeneratedListAccessibleResourceIds_devices godoc @Summary list accessible resource ids @Description list accessible resource ids @Tags permissions-devices @Security Bearer @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} string @Failure 400 @Failure 401 @Failure 500 @Router /permissions/accessible/devices [get]

func GeneratedListAccessibleResourceIds_hubs added in v0.2.13 

func GeneratedListAccessibleResourceIds_hubs()

GeneratedListAccessibleResourceIds_hubs godoc @Summary list accessible resource ids @Description list accessible resource ids @Tags permissions-hubs @Security Bearer @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} string @Failure 400 @Failure 401 @Failure 500 @Router /permissions/accessible/hubs [get]

func GeneratedListAccessibleResourceIds_locations added in v0.2.13 

func GeneratedListAccessibleResourceIds_locations()

GeneratedListAccessibleResourceIds_locations godoc @Summary list accessible resource ids @Description list accessible resource ids @Tags permissions-locations @Security Bearer @Param permissions query string false "checked permissions in the form of 'rwxa', defaults to 'r'" @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} string @Failure 400 @Failure 401 @Failure 500 @Router /permissions/accessible/locations [get]

func GeneratedListComputedPermissions_devicegroups added in v0.2.13 

func GeneratedListComputedPermissions_devicegroups()

GeneratedListComputedPermissions_devicegroups godoc @Summary list the computed permissions to resources of the given topic (device-groups) and ids @Description list the computed permissions to resources of the given topic (device-groups) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-device-groups @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/permissions/device-groups [get]

func GeneratedListComputedPermissions_devices added in v0.2.13 

func GeneratedListComputedPermissions_devices()

GeneratedListComputedPermissions_devices godoc @Summary list the computed permissions to resources of the given topic (devices) and ids @Description list the computed permissions to resources of the given topic (devices) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-devices @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/permissions/devices [get]

func GeneratedListComputedPermissions_hubs added in v0.2.13 

func GeneratedListComputedPermissions_hubs()

GeneratedListComputedPermissions_hubs godoc @Summary list the computed permissions to resources of the given topic (hubs) and ids @Description list the computed permissions to resources of the given topic (hubs) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-hubs @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/permissions/hubs [get]

func GeneratedListComputedPermissions_locations added in v0.2.13 

func GeneratedListComputedPermissions_locations()

GeneratedListComputedPermissions_locations godoc @Summary list the computed permissions to resources of the given topic (locations) and ids @Description list the computed permissions to resources of the given topic (locations) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-locations @Security Bearer @Param ids query string true "Resource Ids, comma seperated" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/permissions/locations [get]

func GeneratedListResourcesWithAdminPermission_devicegroups added in v0.2.13 

func GeneratedListResourcesWithAdminPermission_devicegroups()

GeneratedListResourcesWithAdminPermission_devicegroups godoc @Summary lists resources the user has admin rights to @Description lists resources the user has admin rights to @Tags permissions-device-groups @Security Bearer @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/device-groups [get]

func GeneratedListResourcesWithAdminPermission_devices added in v0.2.13 

func GeneratedListResourcesWithAdminPermission_devices()

GeneratedListResourcesWithAdminPermission_devices godoc @Summary lists resources the user has admin rights to @Description lists resources the user has admin rights to @Tags permissions-devices @Security Bearer @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/devices [get]

func GeneratedListResourcesWithAdminPermission_hubs added in v0.2.13 

func GeneratedListResourcesWithAdminPermission_hubs()

GeneratedListResourcesWithAdminPermission_hubs godoc @Summary lists resources the user has admin rights to @Description lists resources the user has admin rights to @Tags permissions-hubs @Security Bearer @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/hubs [get]

func GeneratedListResourcesWithAdminPermission_locations added in v0.2.13 

func GeneratedListResourcesWithAdminPermission_locations()

GeneratedListResourcesWithAdminPermission_locations godoc @Summary lists resources the user has admin rights to @Description lists resources the user has admin rights to @Tags permissions-locations @Security Bearer @Param limit query integer false "limits size of result; 0 means unlimited" @Param offset query integer false "offset to be used in combination with limit" @Produce json @Success 200 {array} model.Resource @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/locations [get]

func GeneratedQueryListComputedPermissions_devicegroups added in v0.2.13 

func GeneratedQueryListComputedPermissions_devicegroups()

GeneratedQueryListComputedPermissions_devicegroups godoc @Summary list the computed permissions to resources of the given topic (device-groups) and ids @Description list the computed permissions to resources of the given topic (device-groups) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-device-groups @Security Bearer @Param ids body []string true "Resource Ids" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/query/permissions/device-groups [post]

func GeneratedQueryListComputedPermissions_devices added in v0.2.13 

func GeneratedQueryListComputedPermissions_devices()

GeneratedQueryListComputedPermissions_devices godoc @Summary list the computed permissions to resources of the given topic (devices) and ids @Description list the computed permissions to resources of the given topic (devices) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-devices @Security Bearer @Param ids body []string true "Resource Ids" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/query/permissions/devices [post]

func GeneratedQueryListComputedPermissions_hubs added in v0.2.13 

func GeneratedQueryListComputedPermissions_hubs()

GeneratedQueryListComputedPermissions_hubs godoc @Summary list the computed permissions to resources of the given topic (hubs) and ids @Description list the computed permissions to resources of the given topic (hubs) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-hubs @Security Bearer @Param ids body []string true "Resource Ids" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/query/permissions/hubs [post]

func GeneratedQueryListComputedPermissions_locations added in v0.2.13 

func GeneratedQueryListComputedPermissions_locations()

GeneratedQueryListComputedPermissions_locations godoc @Summary list the computed permissions to resources of the given topic (locations) and ids @Description list the computed permissions to resources of the given topic (locations) and ids, group and user permissions are merged, unknown ids will get entries in the result @Tags permissions-locations @Security Bearer @Param ids body []string true "Resource Ids" @Produce json @Success 200 {array} model.ComputedPermissions @Failure 400 @Failure 401 @Failure 500 @Router /permissions/query/permissions/locations [post]

func GeneratedSetPermission_devicegroups added in v0.2.13 

func GeneratedSetPermission_devicegroups()

GeneratedSetPermission_devicegroups godoc @Summary set resource rights @Description get resource rights, requesting user must have admin right on resource to update, requesting user must have admin rights on topic (device-groups) to create @Tags permissions-device-groups @Security Bearer @Param id path string true "Resource Id" @Param wait query bool false "if set to true, the response will be sent after the corresponding kafka done signal has been received" @Param message body model.ResourcePermissions true "Topic" @Accept json @Produce json @Success 200 {object} model.ResourcePermissions @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/device-groups/{id} [put]

func GeneratedSetPermission_devices added in v0.2.13 

func GeneratedSetPermission_devices()

GeneratedSetPermission_devices godoc @Summary set resource rights @Description get resource rights, requesting user must have admin right on resource to update, requesting user must have admin rights on topic (devices) to create @Tags permissions-devices @Security Bearer @Param id path string true "Resource Id" @Param wait query bool false "if set to true, the response will be sent after the corresponding kafka done signal has been received" @Param message body model.ResourcePermissions true "Topic" @Accept json @Produce json @Success 200 {object} model.ResourcePermissions @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/devices/{id} [put]

func GeneratedSetPermission_hubs added in v0.2.13 

func GeneratedSetPermission_hubs()

GeneratedSetPermission_hubs godoc @Summary set resource rights @Description get resource rights, requesting user must have admin right on resource to update, requesting user must have admin rights on topic (hubs) to create @Tags permissions-hubs @Security Bearer @Param id path string true "Resource Id" @Param wait query bool false "if set to true, the response will be sent after the corresponding kafka done signal has been received" @Param message body model.ResourcePermissions true "Topic" @Accept json @Produce json @Success 200 {object} model.ResourcePermissions @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/hubs/{id} [put]

func GeneratedSetPermission_locations added in v0.2.13 

func GeneratedSetPermission_locations()

GeneratedSetPermission_locations godoc @Summary set resource rights @Description get resource rights, requesting user must have admin right on resource to update, requesting user must have admin rights on topic (locations) to create @Tags permissions-locations @Security Bearer @Param id path string true "Resource Id" @Param wait query bool false "if set to true, the response will be sent after the corresponding kafka done signal has been received" @Param message body model.ResourcePermissions true "Topic" @Accept json @Produce json @Success 200 {object} model.ResourcePermissions @Failure 400 @Failure 401 @Failure 403 @Failure 500 @Router /permissions/manage/locations/{id} [put]

func GeneratedSwagger added in v0.1.15 

func GeneratedSwagger()

func GetRouter added in v0.1.15 

func GetRouter(config configuration.Config, control Controller) http.Handler

GetRouter doc @title Device-Repository API @version 0.1 @license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html @BasePath / @securityDefinitions.apikey Bearer @in header @name Authorization @description Type "Bearer" followed by a space and JWT token.

func GetRouterWithoutMiddleware added in v0.1.15 

func GetRouterWithoutMiddleware(config configuration.Config, command Controller) http.Handler

func Start 

func Start(ctx context.Context, config configuration.Config, control Controller) (err error)

Types

type AspectEndpoints added in v0.1.15 

type AspectEndpoints struct{}

func (*AspectEndpoints) Create added in v0.1.53 

func (this *AspectEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create aspect @Description create aspect with generated id @Tags aspects @Produce json @Security Bearer @Param wait query bool false "wait for done message in kafka before responding" @Param message body models.Aspect true "element" @Success 200 {object} models.Aspect @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspects [POST]

func (*AspectEndpoints) DeleteAspect added in v0.1.53 

func (this *AspectEndpoints) DeleteAspect(config configuration.Config, router *http.ServeMux, control Controller)

DeleteAspect godoc @Summary delete aspect @Description delete aspect; may only be called by admins; can also be used to only validate deletes @Tags aspects @Security Bearer @Param dry-run query bool false "only validate deletion" @Param id path string true "Aspect Id" @Success 200 @Failure 400 @Failure 500 @Router /aspects/{id} [DELETE]

func (*AspectEndpoints) Get added in v0.1.15 

func (this *AspectEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get aspect @Description get aspect @Tags aspects @Produce json @Security Bearer @Param id path string true "Aspect Id" @Success 200 {object} models.Aspect @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspects/{id} [GET]

func (*AspectEndpoints) GetMeasuringFunctions added in v0.1.15 

func (this *AspectEndpoints) GetMeasuringFunctions(config configuration.Config, router *http.ServeMux, control Controller)

GetMeasuringFunctions godoc @Summary list aspect measuring-functions @Description list measuring-functions used in combination with this aspect @Tags aspects @Produce json @Security Bearer @Param id path string true "Aspect Id" @Success 200 {array} models.Function @Param ancestors query bool false "filter; if true, returns also functions used in combination with ancestors of the input aspect" @Param descendants query bool false "filter; if true, returns also functions used in combination with descendants of the input aspect" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspects/{id}/measuring-functions [GET]

func (*AspectEndpoints) List added in v0.1.15 

func (this *AspectEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Deprecated @Summary deprecated list aspects; use GET /v2/aspects @Description deprecated list aspects; use GET /v2/aspects @Tags aspects @Produce json @Security Bearer @Param function query string false "filter; only 'measuring-function' is a valid value; if set, returns aspects used in combination with measuring-functions" @Param ancestors query bool false "filter; in combination with 'function'; if true, returns also ancestor nodes of matching aspects" @Param descendants query bool false "filter; in combination with 'function'; if true, returns also descendant nodes of matching aspects" @Success 200 {array} models.Aspect @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspects [GET]

func (*AspectEndpoints) ListAspectNodes added in v0.1.40 

func (this *AspectEndpoints) ListAspectNodes(config configuration.Config, router *http.ServeMux, control Controller)

ListAspectNodes godoc @Summary list aspect-nodes @Description list aspect-nodes @Tags aspect-nodes @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} models.AspectNode @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/aspect-nodes [GET]

func (*AspectEndpoints) ListAspects added in v0.1.40 

func (this *AspectEndpoints) ListAspects(config configuration.Config, router *http.ServeMux, control Controller)

ListAspects godoc @Summary list aspects @Description list aspects @Tags aspects @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} models.Aspect @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/aspects [GET]

func (*AspectEndpoints) Set added in v0.1.53 

func (this *AspectEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set aspect @Description set aspect @Tags aspects @Produce json @Security Bearer @Param id path string true "Aspect Id" @Param message body models.Aspect true "element" @Success 200 {object} models.Aspect @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspects/{id} [PUT]

func (*AspectEndpoints) UserDelete added in v0.1.53 

func (this *AspectEndpoints) UserDelete(config configuration.Config, router *http.ServeMux, control Controller)

UserDelete godoc @Summary delete user @Description delete user; only admins may use this method @Tags users @Security Bearer @Param id path string true "User Id" @Success 200 @Failure 400 @Failure 500 @Router /users/{id} [DELETE]

func (*AspectEndpoints) Validate added in v0.1.15 

func (this *AspectEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate aspect @Description validate aspect @Tags aspects @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Aspect true "Aspect to be validated" @Success 200 @Failure 400 @Failure 500 @Router /aspects [PUT]

type AspectNodeEndpoints added in v0.1.15 

type AspectNodeEndpoints struct{}

func (*AspectNodeEndpoints) Get added in v0.1.15 

func (this *AspectNodeEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get aspect-node @Description get aspect-node @Tags aspect-nodes @Produce json @Security Bearer @Param id path string true "Aspect-Node Id" @Success 200 {object} models.AspectNode @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspect-nodes/{id} [GET]

func (*AspectNodeEndpoints) List added in v0.1.15 

func (this *AspectNodeEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Deprecated @Summary deprecated list aspect-nodes; use GET /v2/aspect-nodes @Description deprecated list aspect-nodes; use GET /v2/aspect-nodes @Tags aspect-nodes @Produce json @Security Bearer @Param function query string false "filter; only 'measuring-function' is a valid value; if set, returns aspect-nodes used in combination with measuring-functions" @Param ancestors query bool false "filter; in combination with 'function'; if true, returns also ancestor nodes of matching nodes" @Param descendants query bool false "filter; in combination with 'function'; if true, returns also descendant nodes of matching nodes" @Success 200 {array} models.AspectNode @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspect-nodes [GET]

func (*AspectNodeEndpoints) ListMeasuringFunctions added in v0.1.15 

func (this *AspectNodeEndpoints) ListMeasuringFunctions(config configuration.Config, router *http.ServeMux, control Controller)

ListMeasuringFunctions godoc @Summary list aspect-node measuring-functions @Description list measuring-functions used in combination with this aspect-node @Tags aspect-nodes @Produce json @Security Bearer @Param id path string true "Aspect-Node Id" @Success 200 {array} models.Function @Param ancestors query bool false "filter; if true, returns also functions used in combination with ancestors of the input aspect-node" @Param descendants query bool false "filter; if true, returns also functions used in combination with descendants of the input aspect-node" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /aspect-nodes/{id}/measuring-functions [GET]

func (*AspectNodeEndpoints) Query added in v0.1.15 

func (this *AspectNodeEndpoints) Query(config configuration.Config, router *http.ServeMux, control Controller)

Query godoc @Summary query aspect-nodes @Description query aspect-nodes @Tags aspect-nodes @Accept json @Produce json @Security Bearer @Param message body AspectNodeQuery true "AspectNodeQuery" @Success 200 {array} models.AspectNode @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /query/aspect-nodes [POST]

type AspectNodeQuery 

type AspectNodeQuery struct {
	Ids *[]string `json:"ids,omitempty"`
}

type CharacteristicsEndpoints added in v0.1.15 

type CharacteristicsEndpoints struct{}

func (*CharacteristicsEndpoints) Create added in v0.1.53 

func (this *CharacteristicsEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create characteristic @Description create characteristic @Tags characteristics @Produce json @Security Bearer @Param message body models.Characteristic true "element" @Success 200 {object} models.Characteristic @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /characteristics [POST]

func (*CharacteristicsEndpoints) Delete added in v0.1.53 

func (this *CharacteristicsEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete characteristic @Description delete characteristic; may only be called by admins; can also be used to only validate deletes @Tags characteristics @Security Bearer @Param dry-run query bool false "only validate deletion" @Param id path string true "Characteristics Id" @Success 200 @Failure 400 @Failure 500 @Router /characteristics/{id} [DELETE]

func (*CharacteristicsEndpoints) Get added in v0.1.15 

func (this *CharacteristicsEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get characteristic @Description get characteristic @Tags characteristics @Produce json @Security Bearer @Param id path string true "Characteristic Id" @Success 200 {object} models.Characteristic @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /characteristics/{id} [GET]

func (*CharacteristicsEndpoints) List added in v0.1.15 

func (this *CharacteristicsEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list characteristics @Description list characteristics @Tags characteristics @Produce json @Security Bearer @Param leafsOnly query bool false "default=true; filter; return only characteristics that have no sub-characteristics" @Success 200 {array} models.Characteristic @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /characteristics [GET]

func (*CharacteristicsEndpoints) ListCharacteristics added in v0.1.48 

func (this *CharacteristicsEndpoints) ListCharacteristics(config configuration.Config, router *http.ServeMux, control Controller)

ListCharacteristics godoc @Summary list characteristics @Description list characteristics @Tags characteristics @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} models.Characteristic @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/characteristics [GET]

func (*CharacteristicsEndpoints) Update added in v0.1.53 

func (this *CharacteristicsEndpoints) Update(config configuration.Config, router *http.ServeMux, control Controller)

Update godoc @Summary set characteristic @Description set characteristic @Tags characteristics @Produce json @Security Bearer @Param id path string true "Characteristic Id" @Param message body models.Characteristic true "element" @Success 200 {object} models.Characteristic @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /characteristics/{id} [PUT]

func (*CharacteristicsEndpoints) Validate added in v0.1.15 

func (this *CharacteristicsEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate characteristic @Description validate characteristic @Tags characteristics @Accept json @Security Bearer @Param dry-run query bool false "must be true; reminder, that this is not an update but a validation" @Param message body models.Characteristic true "Characteristic to be validated" @Success 200 @Failure 400 @Failure 500 @Router /characteristics [PUT]

type ConceptEndpoints added in v0.1.15 

type ConceptEndpoints struct{}

func (*ConceptEndpoints) Create added in v0.1.53 

func (this *ConceptEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create concept @Description create concept @Tags concepts @Produce json @Security Bearer @Param message body models.Concept true "element" @Success 200 {object} models.Concept @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /concepts [POST]

func (*ConceptEndpoints) Delete added in v0.1.53 

func (this *ConceptEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete concept @Description delete concept; may only be called by admins; can also be used to only validate deletes @Tags concepts @Security Bearer @Param dry-run query bool false "only validate deletion" @Param id path string true "Concepts Id" @Success 200 @Failure 400 @Failure 500 @Router /concepts/{id} [DELETE]

func (*ConceptEndpoints) Get added in v0.1.15 

func (this *ConceptEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get concept @Description get concept @Tags concepts @Produce json @Security Bearer @Param id path string true "Concepts Id" @Param sub-class query bool false "default=false; true -> returns models.ConceptWithCharacteristics; false -> returns models.Concept" @Success 200 {object} models.Concept @Success 200 {object} models.ConceptWithCharacteristics @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /concepts/{id} [GET]

func (*ConceptEndpoints) ListConcepts added in v0.1.41 

func (this *ConceptEndpoints) ListConcepts(config configuration.Config, router *http.ServeMux, control Controller)

ListConcepts godoc @Summary list concepts @Description list concepts @Tags concepts @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} models.Concept @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/concepts [GET]

func (*ConceptEndpoints) ListConceptsWithCharacteristics added in v0.1.41 

func (this *ConceptEndpoints) ListConceptsWithCharacteristics(config configuration.Config, router *http.ServeMux, control Controller)

ListConceptsWithCharacteristics godoc @Summary list concepts with characteristics @Description list concepts with characteristics @Tags concepts @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} models.ConceptWithCharacteristics @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/concepts-with-characteristics [GET]

func (*ConceptEndpoints) Set added in v0.1.53 

func (this *ConceptEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set concept @Description set concept @Tags concepts @Produce json @Security Bearer @Param id path string true "Concept Id" @Param message body models.Concept true "element" @Success 200 {object} models.Concept @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /concepts/{id} [PUT]

func (*ConceptEndpoints) Validate added in v0.1.15 

func (this *ConceptEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate concept @Description validate concept @Tags concepts @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Concept true "Concept to be validated" @Success 200 @Failure 400 @Failure 500 @Router /concepts [PUT]

type Controller 

type Controller interface {
	ListDevices(token string, options model.DeviceListOptions) (result []models.Device, err error, errCode int)
	ReadDevice(id string, token string, action model.AuthAction) (result models.Device, err error, errCode int)
	ReadDeviceByLocalId(ownerId string, localId string, token string, action model.AuthAction) (result models.Device, err error, errCode int)
	ValidateDevice(token string, device models.Device) (err error, code int)
	SetDevice(token string, device models.Device, options model.DeviceUpdateOptions) (result models.Device, err error, code int)
	CreateDevice(token string, device models.Device) (result models.Device, err error, code int)
	DeleteDevice(token string, id string) (err error, code int)

	ListExtendedDevices(token string, options model.ExtendedDeviceListOptions) (result []models.ExtendedDevice, total int64, err error, errCode int)
	ReadExtendedDevice(id string, token string, action model.AuthAction, fullDt bool) (result models.ExtendedDevice, err error, errCode int)
	ReadExtendedDeviceByLocalId(ownerId string, localId string, token string, action model.AuthAction, fullDt bool) (result models.ExtendedDevice, err error, errCode int)

	ReadHub(id string, token string, action model.AuthAction) (result models.Hub, err error, errCode int)
	ListHubs(token string, options model.HubListOptions) (result []models.Hub, err error, errCode int)
	ListHubDeviceIds(id string, token string, action model.AuthAction, asLocalId bool) (result []string, err error, errCode int)
	ValidateHub(token string, hub models.Hub) (err error, code int)
	SetHub(token string, hub models.Hub) (result models.Hub, err error, errCode int)
	DeleteHub(token string, id string) (err error, code int)

	ListExtendedHubs(token string, options model.HubListOptions) (result []models.ExtendedHub, total int64, err error, errCode int)
	ReadExtendedHub(id string, token string, action model.AuthAction) (result models.ExtendedHub, err error, errCode int)

	ReadDeviceType(id string, token string) (result models.DeviceType, err error, errCode int)
	ListDeviceTypes(token string, limit int64, offset int64, sort string, filter []model.FilterCriteria, interactionsFilter []string, includeModified bool, includeUnmodified bool) (result []models.DeviceType, err error, errCode int)
	ListDeviceTypesV2(token string, limit int64, offset int64, sort string, filter []model.FilterCriteria, includeModified bool, includeUnmodified bool) (result []models.DeviceType, err error, errCode int)
	ListDeviceTypesV3(token string, listOptions model.DeviceTypeListOptions) (result []models.DeviceType, total int64, err error, errCode int)
	ValidateDeviceType(deviceType models.DeviceType, options model.ValidationOptions) (err error, code int)
	SetDeviceType(token string, dt models.DeviceType, options model.DeviceTypeUpdateOptions) (result models.DeviceType, err error, errCode int)
	DeleteDeviceType(token string, id string) (err error, code int)

	GetDeviceTypeSelectables(query []model.FilterCriteria, pathPrefix string, interactionsFilter []string, includeModified bool) (result []model.DeviceTypeSelectable, err error, code int)
	GetDeviceTypeSelectablesV2(query []model.FilterCriteria, pathPrefix string, includeModified bool, servicesMustMatchAllCriteria bool) (result []model.DeviceTypeSelectable, err error, code int)

	ReadDeviceGroup(id string, token string, filterGenericDuplicateCriteria bool) (result models.DeviceGroup, err error, errCode int)
	ListDeviceGroups(token string, options model.DeviceGroupListOptions) (result []models.DeviceGroup, total int64, err error, errCode int)
	ValidateDeviceGroup(token string, deviceGroup models.DeviceGroup) (err error, code int)
	ValidateDeviceGroupDelete(token string, id string) (err error, code int)
	SetDeviceGroup(token string, dg models.DeviceGroup) (result models.DeviceGroup, err error, errCode int)
	DeleteDeviceGroup(token string, id string) (err error, code int)

	ReadProtocol(id string, token string) (result models.Protocol, err error, errCode int)
	ListProtocols(token string, limit int64, offset int64, sort string) (result []models.Protocol, err error, errCode int)
	ValidateProtocol(protocol models.Protocol) (err error, code int)
	SetProtocol(token string, p models.Protocol) (result models.Protocol, err error, errCode int)
	DeleteProtocol(token string, id string) (err error, code int)

	GetService(id string) (result models.Service, err error, code int)

	ListAspects(listOptions model.AspectListOptions) (result []models.Aspect, total int64, err error, errCode int)
	GetAspects() ([]models.Aspect, error, int)
	GetAspectsWithMeasuringFunction(ancestors bool, descendants bool) ([]models.Aspect, error, int) //returns all aspects used in combination with measuring functions (usage may optionally be by its descendants or ancestors)
	GetAspect(id string) (models.Aspect, error, int)
	ValidateAspect(aspect models.Aspect) (err error, code int)
	ValidateAspectDelete(id string) (err error, code int)
	SetAspect(token string, aspect models.Aspect) (models.Aspect, error, int)
	DeleteAspect(token string, id string) (err error, code int)

	ListAspectNodes(listOptions model.AspectListOptions) (result []models.AspectNode, total int64, err error, errCode int)
	GetAspectNode(id string) (models.AspectNode, error, int)
	GetAspectNodes() ([]models.AspectNode, error, int)
	GetAspectNodesMeasuringFunctions(id string, ancestors bool, descendants bool) (result []models.Function, err error, errCode int) //returns all measuring functions used in combination with given aspect (and optional its descendants and ancestors)
	GetAspectNodesWithMeasuringFunction(ancestors bool, descendants bool) ([]models.AspectNode, error, int)                          //returns all aspect-nodes used in combination with measuring functions (usage may optionally be by its descendants or ancestors)
	GetAspectNodesByIdList(strings []string) ([]models.AspectNode, error, int)

	ListCharacteristics(listOptions model.CharacteristicListOptions) (result []models.Characteristic, total int64, err error, errCode int)
	GetCharacteristics(leafsOnly bool) (result []models.Characteristic, err error, errCode int)
	GetCharacteristic(id string) (result models.Characteristic, err error, errCode int)
	ValidateCharacteristics(characteristic models.Characteristic) (err error, code int)
	ValidateCharacteristicDelete(id string) (err error, code int)
	SetCharacteristic(token string, characteristic models.Characteristic) (result models.Characteristic, err error, errCode int)
	DeleteCharacteristic(token string, id string) (err error, code int)

	ListConceptsWithCharacteristics(listOptions model.ConceptListOptions) (result []models.ConceptWithCharacteristics, total int64, err error, errCode int)
	ListConcepts(listOptions model.ConceptListOptions) (result []models.Concept, total int64, err error, errCode int)
	GetConceptWithCharacteristics(id string) (models.ConceptWithCharacteristics, error, int)
	GetConceptWithoutCharacteristics(id string) (models.Concept, error, int)
	ValidateConcept(concept models.Concept) (err error, code int)
	ValidateConceptDelete(id string) (err error, code int)
	SetConcept(token string, concept models.Concept) (result models.Concept, err error, errCode int)
	DeleteConcept(token string, id string) (err error, code int)

	ListDeviceClasses(listOptions model.DeviceClassListOptions) (result []models.DeviceClass, total int64, err error, errCode int)
	GetDeviceClasses() ([]models.DeviceClass, error, int)
	GetDeviceClassesWithControllingFunctions() ([]models.DeviceClass, error, int)                      //returns all device-classes used in combination with controlling functions
	GetDeviceClassesFunctions(id string) (result []models.Function, err error, errCode int)            //returns all functions used in combination with given device-class
	GetDeviceClassesControllingFunctions(id string) (result []models.Function, err error, errCode int) //returns all controlling functions used in combination with given device-class
	GetDeviceClass(id string) (result models.DeviceClass, err error, errCode int)
	ValidateDeviceClass(deviceclass models.DeviceClass) (err error, code int)
	ValidateDeviceClassDelete(id string) (err error, code int)
	SetDeviceClass(token string, dc models.DeviceClass) (result models.DeviceClass, err error, errCode int)
	DeleteDeviceClass(token string, id string) (err error, code int)

	ListFunctions(options model.FunctionListOptions) (result []models.Function, total int64, err error, errCode int)
	GetFunctionsByType(rdfType string) (result []models.Function, err error, errCode int)
	GetFunction(id string) (result models.Function, err error, errCode int)
	ValidateFunction(function models.Function) (err error, code int)
	ValidateFunctionDelete(id string) (err error, code int)
	SetFunction(token string, f models.Function) (result models.Function, err error, errCode int)
	DeleteFunction(token string, id string) (err error, code int)

	GetLocation(id string, token string) (location models.Location, err error, errCode int)
	ValidateLocation(location models.Location) (err error, code int)
	ListLocations(token string, options model.LocationListOptions) (result []models.Location, total int64, err error, errCode int)
	GetUsedInDeviceType(query model.UsedInDeviceTypeQuery) (result model.UsedInDeviceTypeResponse, err error, errCode int)
	SetLocation(token string, location models.Location) (result models.Location, err error, errCode int)
	DeleteLocation(token string, id string) (err error, code int)

	DeleteUser(adminToken string, userId string) (err error, errCode int)

	SetHubConnectionState(token string, id string, connected bool) (error, int)
	SetDeviceConnectionState(token string, id string, connected bool) (error, int)

	Export(token string, options model.ImportExportOptions) (result model.ImportExport, err error, code int)
	Import(token string, importModel model.ImportExport, options model.ImportExportOptions) (err error, code int)

	ImportFrom(token string, includeOwnedInformation bool, options model.ImportFromOptions) (err error, code int)

	GetDefaultDeviceAttributes(token string) (attributes []models.Attribute, err error, code int)
	SetDefaultDeviceAttributes(token string, attributes []models.Attribute) (err error, code int)
}

type DefaultsEndpoints added in v0.2.24 

type DefaultsEndpoints struct{}

func (*DefaultsEndpoints) GetDefaultDeviceAttributes added in v0.2.24 

func (this *DefaultsEndpoints) GetDefaultDeviceAttributes(config configuration.Config, router *http.ServeMux, control Controller)

GetDefaultDeviceAttributes godoc @Summary get default device attributes @Description get default attributes for devices where the owner is the requesting user @Tags defaults @Produce json @Security Bearer @Success 200 {array} models.Attribute @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /defaults/devices/attributes [GET]

func (*DefaultsEndpoints) SetDefaultDeviceAttributes added in v0.2.24 

func (this *DefaultsEndpoints) SetDefaultDeviceAttributes(config configuration.Config, router *http.ServeMux, control Controller)

SetDefaultDeviceAttributes godoc @Summary set default device attributes @Description set default attributes for devices where the owner is the requesting user @Tags defaults @Accept json @Security Bearer @Param attributes body []models.Attribute true "attributes" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /defaults/devices/attributes [PUT]

type DeviceClassEndpoints 

type DeviceClassEndpoints struct{}

func (*DeviceClassEndpoints) Create added in v0.1.53 

func (this *DeviceClassEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create device-class @Description create device-class @Tags device-classes @Produce json @Security Bearer @Param message body models.DeviceClass true "element" @Success 200 {object} models.DeviceClass @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-classes [POST]

func (*DeviceClassEndpoints) Delete added in v0.1.53 

func (this *DeviceClassEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete device-class @Description delete device-class; may only be called by admins; can also be used to only validate deletes @Tags device-classes @Security Bearer @Param dry-run query bool false "only validate deletion" @Param id path string true "DeviceClasses Id" @Success 200 @Failure 400 @Failure 500 @Router /device-classes/{id} [DELETE]

func (*DeviceClassEndpoints) Get added in v0.1.15 

func (this *DeviceClassEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get device-class @Description get device-class @Tags device-classes @Produce json @Security Bearer @Param id path string true "Device Class Id" @Success 200 {object} models.DeviceClass @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-classes/{id} [GET]

func (*DeviceClassEndpoints) GetControllingFunctions added in v0.1.15 

func (this *DeviceClassEndpoints) GetControllingFunctions(config configuration.Config, router *http.ServeMux, control Controller)

GetControllingFunctions godoc @Summary list device-class functions @Description list controlling-functions used in combination with this device-class @Tags device-classes @Produce json @Security Bearer @Param id path string true "Device Class Id" @Success 200 {array} models.Function @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-classes/{id}/controlling-functions [GET]

func (*DeviceClassEndpoints) GetFunctions added in v0.1.15 

func (this *DeviceClassEndpoints) GetFunctions(config configuration.Config, router *http.ServeMux, control Controller)

GetFunctions godoc @Summary list device-class functions @Description list functions used in combination with this device-class @Tags device-classes @Produce json @Security Bearer @Param id path string true "Device Class Id" @Success 200 {array} models.Function @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-classes/{id}/functions [GET]

func (*DeviceClassEndpoints) List added in v0.1.15 

func (this *DeviceClassEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Deprecated @Summary deprecated list device-classes; use GET /v2/device-classes @Description deprecated list device-classes; use GET /v2/device-classes @Tags device-classes @Produce json @Security Bearer @Param function query string false "filter; only 'controlling-function' is a valid value; if set, returns device-classes used in combination with controlling-function" @Success 200 {array} models.DeviceClass @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-classes [GET]

func (*DeviceClassEndpoints) ListDeviceClasses added in v0.1.43 

func (this *DeviceClassEndpoints) ListDeviceClasses(config configuration.Config, router *http.ServeMux, control Controller)

ListDeviceClasses godoc @Summary list device-classes @Description list device-classes @Tags device-classes @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param used_with_controlling_function query bool false "filter; only 'true' is a valid value; if set, returns device-classes used in combination with controlling-function" @Success 200 {array} models.DeviceClass @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/device-classes [GET]

func (*DeviceClassEndpoints) Set added in v0.1.53 

func (this *DeviceClassEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set device-class @Description set device-class @Tags device-classes @Produce json @Security Bearer @Param id path string true "DeviceClass Id" @Param message body models.DeviceClass true "element" @Success 200 {object} models.DeviceClass @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-classes/{id} [PUT]

func (*DeviceClassEndpoints) Validate added in v0.1.15 

func (this *DeviceClassEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate device-class @Description validate device-class @Tags device-classes @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.DeviceClass true "Device-Class to be validated" @Success 200 @Failure 400 @Failure 500 @Router /device-classes [PUT]

type DeviceEndpoints 

type DeviceEndpoints struct{}

func (*DeviceEndpoints) Create added in v0.1.53 

func (this *DeviceEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create device @Description create device @Tags devices @Produce json @Security Bearer @Param message body models.Device true "element" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices [POST]

func (*DeviceEndpoints) Delete added in v0.1.53 

func (this *DeviceEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete device @Description delete device @Tags devices @Produce json @Security Bearer @Param id path string true "Device Id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices/{id} [DELETE]

func (*DeviceEndpoints) DeleteMany added in v0.1.53 

func (this *DeviceEndpoints) DeleteMany(config configuration.Config, router *http.ServeMux, control Controller)

DeleteMany godoc @Summary delete multiple devices @Description delete multiple devices @Tags devices @Produce json @Security Bearer @Param message body []string true "ids to be deleted" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices [DELETE]

func (*DeviceEndpoints) Get added in v0.1.15 

func (this *DeviceEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get device @Description get device @Tags devices @Produce json @Security Bearer @Param id path string true "Device Id" @Param as query string false "interprets the id as local_id if as=='local_id'" @Param owner_id query string false "default requesting user; used in combination with local_id (as=='local_id') to identify the device" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices/{id} [GET]

func (*DeviceEndpoints) List added in v0.1.15 

func (this *DeviceEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list devices @Description list devices @Tags devices @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param local_ids query string false "in combination with owner; fills ids filter; comma-seperated list" @Param owner query string false "used in combination with local_ids to fill ids filter; defaults to requesting user" @Param device-type-ids query string false "filter; comma-seperated list" @Param attr-keys query string false "filter; comma-seperated list; lists elements only if they have an attribute key that is in the given list" @Param attr-values query string false "filter; comma-seperated list; lists elements only if they have an attribute value that is in the given list" @Param connection-state query integer false "filter; valid values are 'online', 'offline' and an empty string for unknown states" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {array} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices [GET]

func (*DeviceEndpoints) Set added in v0.1.53 

func (this *DeviceEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set device @Description set device; admins may create new devices but only without using the UpdateOnlySameOriginAttributesKey query parameter @Tags devices @Produce json @Security Bearer @Param id path string true "Device Id" @Param update-only-same-origin-attributes query string false "comma separated list; ensure that no attribute from another origin is overwritten" @Param message body models.Device true "element" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices/{id} [PUT]

func (*DeviceEndpoints) SetAttributes added in v0.1.53 

func (this *DeviceEndpoints) SetAttributes(config configuration.Config, router *http.ServeMux, control Controller)

SetAttributes godoc @Summary set device attributes @Description set device attributes @Tags devices @Produce json @Security Bearer @Param id path string true "Device Id" @Param update-only-same-origin-attributes query string false "comma separated list; ensure that no attribute from another origin is overwritten" @Param message body []models.Attribute true "attributes" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices/{id}/attributes [PUT]

func (*DeviceEndpoints) SetConnectionState added in v0.1.53 

func (this *DeviceEndpoints) SetConnectionState(config configuration.Config, router *http.ServeMux, control Controller)

SetConnectionState godoc @Summary set device connection-state @Description set device connection-state @Tags devices @Security Bearer @Param message body bool true "connected true/false" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices/{id}/connection-state [PUT]

func (*DeviceEndpoints) SetDisplayName added in v0.1.53 

func (this *DeviceEndpoints) SetDisplayName(config configuration.Config, router *http.ServeMux, control Controller)

SetDisplayName godoc @Summary set device display name @Description set device display name @Tags devices @Produce json @Security Bearer @Param id path string true "Device Id" @Param message body string true "display name" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /devices/{id}/display_name [PUT]

func (*DeviceEndpoints) Validate added in v0.1.15 

func (this *DeviceEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate device @Description validate device @Tags devices @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Device true "Device to be validated" @Success 200 @Failure 400 @Failure 500 @Router /devices [PUT]

type DeviceGroupEndpoints 

type DeviceGroupEndpoints struct{}

func (*DeviceGroupEndpoints) Create added in v0.1.53 

func (this *DeviceGroupEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create device-group @Description create device-group @Tags device-groups @Produce json @Security Bearer @Param message body models.DeviceGroup true "element" @Success 200 {object} models.DeviceGroup @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-groups [POST]

func (*DeviceGroupEndpoints) Delete added in v0.1.53 

func (this *DeviceGroupEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete device-group @Description delete device-group; may only be called by admins; can also be used to only validate deletes @Tags device-groups @Security Bearer @Param dry-run query bool false "only validate deletion" @Param id path string true "DeviceGroup Id" @Success 200 @Failure 400 @Failure 500 @Router /device-groups/{id} [DELETE]

func (*DeviceGroupEndpoints) Get added in v0.1.15 

func (this *DeviceGroupEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get device-group @Description get device-group @Tags device-groups @Produce json @Security Bearer @Param id path string true "Device Group Id" @Param filter_generic_duplicate_criteria query bool false "remove criteria that are more generalized variations of already listed criteria (ref SNRGY-3027)" @Success 200 {object} models.DeviceGroup @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-groups/{id} [GET]

func (*DeviceGroupEndpoints) List added in v0.1.25 

func (this *DeviceGroupEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list device-group @Description list device-group @Tags device-groups @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param device-ids query string false "filter; comma-seperated list" @Param ignore-generated query bool false "filter; remove generated groups from result" @Param attr-keys query string false "filter; comma-seperated list; lists elements only if they have an attribute key that is in the given list" @Param attr-values query string false "filter; comma-seperated list; lists elements only if they have an attribute value that is in the given list" @Param criteria query string false "filter; json encoded []model.FilterCriteria" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Param filter_generic_duplicate_criteria query bool false "remove criteria that are more generalized variations of already listed criteria (ref SNRGY-3027)" @Success 200 {array} models.DeviceGroup @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-groups [GET]

func (*DeviceGroupEndpoints) Set added in v0.1.53 

func (this *DeviceGroupEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set device-group @Description set device-group @Tags device-groups @Produce json @Security Bearer @Param id path string true "DeviceGroup Id" @Param message body models.DeviceGroup true "element" @Success 200 {object} models.DeviceGroup @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-groups/{id} [PUT]

func (*DeviceGroupEndpoints) Validate added in v0.1.15 

func (this *DeviceGroupEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate device-group @Description validate device-group @Tags device-groups @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.DeviceGroup true "DeviceGroup to be validated" @Success 200 @Failure 400 @Failure 500 @Router /device-groups [PUT]

type DeviceTypeEndpoints 

type DeviceTypeEndpoints struct{}

func (*DeviceTypeEndpoints) Create added in v0.1.53 

func (this *DeviceTypeEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create device-type @Description create device-type @Tags device-types @Produce json @Security Bearer @Param distinct_attributes query string false "comma separated list of attribute keys; no other device-type with the same attribute key/value may exist" @Param message body models.DeviceType true "element" @Success 200 {object} models.DeviceType @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-types [POST]

func (*DeviceTypeEndpoints) Delete added in v0.1.53 

func (this *DeviceTypeEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete device-type @Description delete device-type @Tags device-types @Produce json @Security Bearer @Param id path string true "DeviceType Id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-types/{id} [DELETE]

func (*DeviceTypeEndpoints) Get added in v0.1.15 

func (this *DeviceTypeEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get device-type @Description get device-type @Tags device-types @Produce json @Security Bearer @Param id path string true "Device-Type Id" @Success 200 {object} models.DeviceType @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-types/{id} [GET]

func (*DeviceTypeEndpoints) List added in v0.1.15 

func (this *DeviceTypeEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

deprecated

func (*DeviceTypeEndpoints) ListV3 added in v0.1.15 

func (this *DeviceTypeEndpoints) ListV3(config configuration.Config, router *http.ServeMux, control Controller)

ListV3 godoc @Summary list device-types @Description list device-types @Tags device-types @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param protocol-ids query string false "filter; comma-seperated list; lists elements only if they use a protocol that is in the given list" @Param attr-keys query string false "filter; comma-seperated list; lists elements only if they have an attribute key that is in the given list" @Param attr-values query string false "filter; comma-seperated list; lists elements only if they have an attribute value that is in the given list" @Param include-modified query bool false "include id-modified device-types" @Param ignore-unmodified query bool false "no unmodified device-types" @Param criteria query string false "filter; json encoded []model.FilterCriteria" @Header 200 {integer} X-Total-Count "count of all matching elements; does not count modified elements; used for pagination" @Success 200 {array} models.DeviceType @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v3/device-types [GET]

func (*DeviceTypeEndpoints) Set added in v0.1.53 

func (this *DeviceTypeEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set device-type @Description set device-type @Tags device-types @Produce json @Security Bearer @Param id path string true "DeviceType Id" @Param distinct_attributes query string false "comma separated list of attribute keys; no other device-type with the same attribute key/value may exist" @Param message body models.DeviceType true "element" @Success 200 {object} models.DeviceType @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /device-types/{id} [PUT]

func (*DeviceTypeEndpoints) Validate added in v0.1.15 

func (this *DeviceTypeEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate device-type @Description validate device-type @Tags device-types @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.DeviceType true "Device-Type to be validated" @Success 200 @Failure 400 @Failure 500 @Router /device-types [PUT]

type DeviceTypeSelectableEndpoints 

type DeviceTypeSelectableEndpoints struct{}

func (*DeviceTypeSelectableEndpoints) Query added in v0.1.15 

func (this *DeviceTypeSelectableEndpoints) Query(config configuration.Config, router *http.ServeMux, control Controller)

Query godoc @Summary validate device-type @Description validate device-type @Tags device-types @Accept json @Produce json @Security Bearer @Param message body []model.FilterCriteria true "filtered by criteria" @Param path-prefix query string false "prefix added to variable paths" @Param interactions-filter query string false "'event', 'request', 'event+request'" @Param include_id_modified query bool false "include id-modified device-types" @Success 200 {array} model.DeviceTypeSelectable @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /query/device-type-selectables [POST]

func (*DeviceTypeSelectableEndpoints) QueryV2 added in v0.1.15 

func (this *DeviceTypeSelectableEndpoints) QueryV2(config configuration.Config, router *http.ServeMux, control Controller)

QueryV2 godoc @Summary validate device-type @Description validate device-type @Tags device-types @Accept json @Produce json @Security Bearer @Param message body []model.FilterCriteria true "filtered by criteria" @Param path-prefix query string false "prefix added to variable paths" @Param services_must_match_all_criteria query bool false "toggle if filter criteria is 'and' or 'or' combination" @Param include_id_modified query bool false "include id-modified device-types" @Success 200 {array} model.DeviceTypeSelectable @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /v2/query/device-type-selectables [POST]

type EndpointMethod added in v0.1.15 

type EndpointMethod = func(config configuration.Config, router *http.ServeMux, ctrl Controller)

type ExtendedDeviceEndpoints added in v0.1.0 

type ExtendedDeviceEndpoints struct{}

func (*ExtendedDeviceEndpoints) Get added in v0.1.15 

func (this *ExtendedDeviceEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get extended-device @Description get extended-device @Tags extended-devices @Produce json @Security Bearer @Param id path string true "Device Id" @Param as query string false "interprets the id as local_id if as=='local_id'" @Param owner_id query string false "default requesting user; used in combination with local_id (as=='local_id') to identify the device" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Param fulldt query bool false "if true, result contains full device-type" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /extended-devices/{id} [GET]

func (*ExtendedDeviceEndpoints) List added in v0.1.15 

func (this *ExtendedDeviceEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list extended-device @Description list extended-device @Tags extended-devices @Produce json @Security Bearer @Param fulldt query bool false "if true, result contains full device-type" @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param local_ids query string false "in combination with owner; fills ids filter; comma-seperated list" @Param owner query string false "used in combination with local_ids to fill ids filter; defaults to requesting user" @Param device-type-ids query string false "filter; comma-seperated list" @Param attr-keys query string false "filter; comma-seperated list; lists elements only if they have an attribute key that is in the given list" @Param attr-values query string false "filter; comma-seperated list; lists elements only if they have an attribute value that is in the given list" @Param connection-state query integer false "filter; valid values are 'online', 'offline' and an empty string for unknown states" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {array} models.ExtendedDevice @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /extended-devices [GET]

type ExtendedHubEndpoints added in v0.1.0 

type ExtendedHubEndpoints struct{}

func (*ExtendedHubEndpoints) Get added in v0.1.15 

func (this *ExtendedHubEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get extended-hubs @Description get extended-hubs @Tags extended-hubs @Produce json @Security Bearer @Param id path string true "Hub Id" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {object} models.ExtendedHub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /extended-hubs/{id} [GET]

func (*ExtendedHubEndpoints) List added in v0.1.15 

func (this *ExtendedHubEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list extended-hubs @Description list extended-hubs @Tags extended-hubs @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param connection-state query integer false "filter; valid values are 'online', 'offline' and an empty string for unknown states" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {array} models.ExtendedHub @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /extended-hubs [GET]

type FunctionsEndpoints 

type FunctionsEndpoints struct{}

func (*FunctionsEndpoints) Create added in v0.1.53 

func (this *FunctionsEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create function @Description create function @Tags functions @Produce json @Security Bearer @Param message body models.Function true "element" @Success 200 {object} models.Function @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /functions [POST]

func (*FunctionsEndpoints) Delete added in v0.1.53 

func (this *FunctionsEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete function @Description delete function; may only be called by admins; can also be used to only validate deletes @Tags functions @Security Bearer @Param dry-run query bool false "only validate deletion" @Param id path string true "Functions Id" @Success 200 @Failure 400 @Failure 500 @Router /functions/{id} [DELETE]

func (*FunctionsEndpoints) Get added in v0.1.15 

func (this *FunctionsEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get function @Description get function @Tags functions @Produce json @Security Bearer @Param id path string true "Function Id" @Success 200 {object} models.DeviceClass @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /functions/{id} [GET]

func (*FunctionsEndpoints) ListControllingFunctions added in v0.1.15 

func (this *FunctionsEndpoints) ListControllingFunctions(config configuration.Config, router *http.ServeMux, control Controller)

ListControllingFunctions godoc @Summary list controlling-functions @Description list controlling-functions @Tags functions @Produce json @Security Bearer @Success 200 {array} models.Function @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /controlling-functions [GET]

func (*FunctionsEndpoints) ListFunctions added in v0.1.38 

func (this *FunctionsEndpoints) ListFunctions(config configuration.Config, router *http.ServeMux, control Controller)

ListFunctions godoc @Summary list functions @Description list functions @Tags functions @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param rdf_type query string false "filter; https://senergy.infai.org/ontology/ControllingFunction || https://senergy.infai.org/ontology/MeasuringFunction" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Success 200 {array} models.Function @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /functions [GET]

func (*FunctionsEndpoints) ListMeasuringFunctions added in v0.1.15 

func (this *FunctionsEndpoints) ListMeasuringFunctions(config configuration.Config, router *http.ServeMux, control Controller)

ListMeasuringFunctions godoc @Summary list measuring-functions @Description list measuring-functions @Tags functions @Produce json @Security Bearer @Success 200 {array} models.Function @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /measuring-functions [GET]

func (*FunctionsEndpoints) QueryFunctions added in v0.2.16 

func (this *FunctionsEndpoints) QueryFunctions(config configuration.Config, router *http.ServeMux, control Controller)

QueryFunctions godoc @Summary list functions @Description list functions @Tags functions @Accept json @Produce json @Security Bearer @Param query body model.FunctionListOptions true "list options" @Success 200 {array} models.Function @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /query/functions [POST]

func (*FunctionsEndpoints) Set added in v0.1.53 

func (this *FunctionsEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set function @Description set function @Tags functions @Produce json @Security Bearer @Param id path string true "Function Id" @Param message body models.Function true "element" @Success 200 {object} models.Function @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /functions/{id} [PUT]

func (*FunctionsEndpoints) Validate added in v0.1.15 

func (this *FunctionsEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate function @Description validate function @Tags functions @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Function true "Function to be validated" @Success 200 @Failure 400 @Failure 500 @Router /functions [PUT]

type HelperEndpoints added in v0.1.53 

type HelperEndpoints struct{}

func (*HelperEndpoints) Id added in v0.1.53 

func (this *HelperEndpoints) Id(config configuration.Config, router *http.ServeMux, control Controller)

Id godoc @Summary transforms short id to long id @Description transforms short id to long id @Tags helper @Produce json @Security Bearer @Param short_id query string true "short id" @Param prefix query string true "prefix added to generated long id" @Success 200 {object} string @Failure 400 @Router /helper/id [GET]

type HubEndpoints 

type HubEndpoints struct{}

func (*HubEndpoints) Create added in v0.1.53 

func (this *HubEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create hub @Description create hub @Tags hubs @Produce json @Security Bearer @Param message body models.Hub true "element" @Success 200 {object} models.Hub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs [POST]

func (*HubEndpoints) Delete added in v0.1.53 

func (this *HubEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete hub @Description delete hub @Tags hubs @Produce json @Security Bearer @Param id path string true "Hub Id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id} [DELETE]

func (*HubEndpoints) Get added in v0.1.15 

func (this *HubEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get hub @Description get hub @Tags hubs @Produce json @Security Bearer @Param id path string true "Hub Id" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {object} models.Hub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id} [GET]

func (*HubEndpoints) GetDevices added in v0.1.15 

func (this *HubEndpoints) GetDevices(config configuration.Config, router *http.ServeMux, control Controller)

GetDevices godoc @Summary get device ids of hub @Description get device ids of hub @Tags hubs @Produce json @Security Bearer @Param id path string true "Hub Id" @Param as query string false "default 'local_id'; valid values 'local_id', 'localId', 'id'; selects if device ids or device local-ids should be returned" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {array} string @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id}/devices [GET]

func (*HubEndpoints) Head added in v0.1.15 

func (this *HubEndpoints) Head(config configuration.Config, router *http.ServeMux, control Controller)

Head godoc @Summary head hub @Description head hub @Tags hubs @Security Bearer @Param id path string true "Hub Id" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id} [HEAD]

func (*HubEndpoints) List added in v0.1.15 

func (this *HubEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list hubs @Description list hubs @Tags hubs @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param connection-state query integer false "filter; valid values are 'online', 'offline' and an empty string for unknown states" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {array} models.Hub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs [GET]

func (*HubEndpoints) Set added in v0.1.53 

func (this *HubEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set hub @Description set hub @Tags hubs @Produce json @Security Bearer @Param id path string true "Hub Id" @Param user_id query string false "only admins may set user_id; overwrites hub.OwnerId; defaults to existing hub.OwnerId and falls back to user-id of requesting user if hub does not exist" @Param message body models.Hub true "element" @Success 200 {object} models.Hub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id} [PUT]

func (*HubEndpoints) SetConnectionState added in v0.1.53 

func (this *HubEndpoints) SetConnectionState(config configuration.Config, router *http.ServeMux, control Controller)

SetConnectionState godoc @Summary set hub connection-state @Description set hub connection-state @Tags hubs @Security Bearer @Param message body bool true "connected true/false" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id}/connection-state [PUT]

func (*HubEndpoints) SetName added in v0.1.53 

func (this *HubEndpoints) SetName(config configuration.Config, router *http.ServeMux, control Controller)

SetName godoc @Summary set hub name @Description set hub name @Tags hubs @Produce json @Security Bearer @Param id path string true "Hub Id" @Param message body string true "name" @Success 200 {object} models.Hub @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /hubs/{id}/name [PUT]

func (*HubEndpoints) Validate added in v0.1.15 

func (this *HubEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate hub @Description validate hub @Tags hubs @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Hub true "Hub to be validated" @Success 200 @Failure 400 @Failure 500 @Router /hubs [PUT]

type ImportExportEndpoints added in v0.1.53 

type ImportExportEndpoints struct{}

func (*ImportExportEndpoints) Export added in v0.1.53 

func (this *ImportExportEndpoints) Export(config configuration.Config, router *http.ServeMux, control Controller)

Export godoc @Summary export @Description export @Tags import/export @Produce json @Security Bearer @Param include_owned_information query bool false "default false; if true, export includes resources like devices, hubs and locations" @Param filter_resource_types query string false "comma separated list of resource-types; export only given resource-types (device-types,aspects,functions...)" @Param filter_ids query string false "comma separated list of ids; export only given ids" @Success 200 {object} model.ImportExport @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /export [GET]

func (*ImportExportEndpoints) Import added in v0.1.53 

func (this *ImportExportEndpoints) Import(config configuration.Config, router *http.ServeMux, control Controller)

Import godoc @Summary import @Description import @Tags import/export @Security Bearer @Param include_owned_information query bool false "default false; if true, import handles resources like devices, hubs and locations" @Param message body model.ImportExport true "import" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /import [PUT]

func (*ImportExportEndpoints) ImportFrom added in v0.2.11 

func (this *ImportExportEndpoints) ImportFrom(config configuration.Config, router *http.ServeMux, control Controller)

ImportFrom godoc @Summary import-from @Description import-from @Tags import/export @Security Bearer @Param include_owned_information query bool false "default false; if true, import handles resources like devices, hubs and locations" @Param message body model.ImportFromOptions true "options containing information what should be imported from where; filter_resource_types and filter_ids are optional but empty lists result in empty results; filter_resource_types allows filtering by resource-types like 'aspects' (plural like the http endpoints); filter_ids allows filtering by resource id; ref documentation of GET /export" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /import-from [POST]

type InvalidElements added in v0.0.5 

type InvalidElements struct{}

func (*InvalidElements) DeviceTypes added in v0.1.15 

func (this *InvalidElements) DeviceTypes(config configuration.Config, router *http.ServeMux, control Controller)

DeviceTypes godoc @Summary @Description validate existing device-types @Tags device-types @Produce json @Security Bearer @Param limit query integer false "default 100; limit of checked device-types not of returned errors" @Param offset query integer false "default 0" @Param sort query string false "default name.asc" @Param allow_none_leaf_aspect_nodes_in_device_types query string false "allow none leaf aspect nodes in device-types" @Success 200 {array} ValidationError @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /invalid/device-type [GET]

type LocalDevicesEndpoints added in v0.1.53 

type LocalDevicesEndpoints struct{}

func (*LocalDevicesEndpoints) Create added in v0.1.53 

func (this *LocalDevicesEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create device (local-id variant) @Description create device (local-id variant) @Tags devices @Produce json @Security Bearer @Param message body models.Device true "element" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /local-devices/{id} [POST]

func (*LocalDevicesEndpoints) Delete added in v0.1.53 

func (this *LocalDevicesEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete device (local-id variant) @Description delete device (local-id variant) @Tags devices @Produce json @Security Bearer @Param id path string true "Device Local Id" @Param owner_id query string false "defaults to requesting user; used in combination with id to find device" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /local-devices/{id} [DELETE]

func (*LocalDevicesEndpoints) Get added in v0.1.53 

func (this *LocalDevicesEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get device by local id @Description get device by local id @Tags devices @Produce json @Security Bearer @Param id path string true "Device Local Id" @Param owner_id query string false "defaults to requesting user; used in combination with id to find device" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /local-devices/{id} [GET]

func (*LocalDevicesEndpoints) List added in v0.1.53 

func (this *LocalDevicesEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list devices (local-id variant) @Description list devices (local-id variant) @Tags devices @Produce json @Security Bearer @Param ids query string false "comma separated list of local ids" @Param owner_id query string false "defaults to requesting user; used in combination with local_id to find devices" @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param device-type-ids query string false "filter; comma-seperated list" @Param attr-keys query string false "filter; comma-seperated list; lists elements only if they have an attribute key that is in the given list" @Param attr-values query string false "filter; comma-seperated list; lists elements only if they have an attribute value that is in the given list" @Param connection-state query integer false "filter; valid values are 'online', 'offline' and an empty string for unknown states" @Success 200 {array} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /local-devices/{id} [GET]

func (*LocalDevicesEndpoints) Set added in v0.1.53 

func (this *LocalDevicesEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set device (local-id variant) @Description set device (local-id variant) @Tags devices @Produce json @Security Bearer @Param id path string true "Device Local Id" @Param update-only-same-origin-attributes query string false "comma separated list; ensure that no attribute from another origin is overwritten" @Param message body models.Device true "element" @Success 200 {object} models.Device @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /local-devices/{id} [PUT]

type LocationEndpoints 

type LocationEndpoints struct{}

func (*LocationEndpoints) Create added in v0.1.53 

func (this *LocationEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create location @Description create location @Tags locations @Produce json @Security Bearer @Param id path string true "Location Id" @Param message body models.Location true "element" @Success 200 {object} models.Location @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /locations [POST]

func (*LocationEndpoints) Delete added in v0.1.53 

func (this *LocationEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete location @Description delete location @Tags locations @Produce json @Security Bearer @Param id path string true "Location Id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /locations/{id} [DELETE]

func (*LocationEndpoints) Get added in v0.1.15 

func (this *LocationEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get location @Description get location @Tags locations @Produce json @Security Bearer @Param id path string true "Location Id" @Success 200 {object} models.Location @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /locations/{id} [GET]

func (*LocationEndpoints) List added in v0.1.30 

func (this *LocationEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary list location @Description list location @Tags locations @Produce json @Security Bearer @Param limit query integer false "default 100, will be ignored if 'ids' is set" @Param offset query integer false "default 0, will be ignored if 'ids' is set" @Param search query string false "filter" @Param sort query string false "default name.asc" @Param ids query string false "filter; ignores limit/offset; comma-seperated list" @Param p query string false "default 'r'; used to check permissions on request; valid values are 'r', 'w', 'x', 'a' for read, write, execute, administrate" @Success 200 {array} models.Location @Header 200 {integer} X-Total-Count "count of all matching elements; used for pagination" @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /locations [GET]

func (*LocationEndpoints) Set added in v0.1.53 

func (this *LocationEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set location @Description set location @Tags locations @Produce json @Security Bearer @Param id path string true "Location Id" @Param message body models.Location true "element" @Success 200 {object} models.Location @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /locations/{id} [PUT]

func (*LocationEndpoints) Validate added in v0.1.15 

func (this *LocationEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate location @Description validate location @Tags locations @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Location true "Location to be validated" @Success 200 @Failure 400 @Failure 500 @Router /functions [PUT]

type ProtocolEndpoints 

type ProtocolEndpoints struct{}

func (*ProtocolEndpoints) Create added in v0.1.53 

func (this *ProtocolEndpoints) Create(config configuration.Config, router *http.ServeMux, control Controller)

Create godoc @Summary create protocol @Description create protocol @Tags protocols @Produce json @Security Bearer @Param message body models.Protocol true "element" @Success 200 {object} models.Protocol @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /protocols [POST]

func (*ProtocolEndpoints) Delete added in v0.1.53 

func (this *ProtocolEndpoints) Delete(config configuration.Config, router *http.ServeMux, control Controller)

Delete godoc @Summary delete protocol @Description delete protocol @Tags protocols @Produce json @Security Bearer @Param id path string true "Protocol Id" @Success 200 @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /protocols/{id} [DELETE]

func (*ProtocolEndpoints) Get added in v0.1.15 

func (this *ProtocolEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get protocol @Description get protocol @Tags protocols @Produce json @Security Bearer @Param id path string true "Protocol Id" @Success 200 {object} models.Protocol @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /protocols/{id} [GET]

func (*ProtocolEndpoints) List added in v0.1.15 

func (this *ProtocolEndpoints) List(config configuration.Config, router *http.ServeMux, control Controller)

List godoc @Summary get protocol @Description get protocol @Tags protocols @Produce json @Security Bearer @Param limit query integer false "default 100" @Param offset query integer false "default 0" @Param sort query string false "default name.asc" @Success 200 {array} models.Protocol @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /protocols [GET]

func (*ProtocolEndpoints) Set added in v0.1.53 

func (this *ProtocolEndpoints) Set(config configuration.Config, router *http.ServeMux, control Controller)

Set godoc @Summary set protocol @Description set protocol @Tags protocols @Produce json @Security Bearer @Param id path string true "Protocol Id" @Param message body models.Protocol true "element" @Success 200 {object} models.Protocol @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /protocols/{id} [PUT]

func (*ProtocolEndpoints) Validate added in v0.1.15 

func (this *ProtocolEndpoints) Validate(config configuration.Config, router *http.ServeMux, control Controller)

Validate godoc @Summary validate protocol @Description validate protocol @Tags protocols @Accept json @Security Bearer @Param dry-run query bool true "must be true; reminder, that this is not an update but a validation" @Param message body models.Protocol true "Location to be validated" @Success 200 @Failure 400 @Failure 500 @Router /protocols [PUT]

type QueryEndpoint added in v0.0.6 

type QueryEndpoint struct{}

func (*QueryEndpoint) Query added in v0.1.15 

func (this *QueryEndpoint) Query(config configuration.Config, router *http.ServeMux, control Controller)

Query godoc @Summary query used-in-device-type @Description query used-in-device-type @Tags device-types @Accept json @Produce json @Security Bearer @Param message body model.UsedInDeviceTypeQuery true "filter" @Success 200 {object} model.UsedInDeviceTypeResponse @Failure 400 @Failure 404 @Failure 500 @Router /query/used-in-device-type [POST]

type ServiceEndpoints 

type ServiceEndpoints struct{}

func (*ServiceEndpoints) Get added in v0.1.15 

func (this *ServiceEndpoints) Get(config configuration.Config, router *http.ServeMux, control Controller)

Get godoc @Summary get service @Description get service @Tags services @Produce json @Security Bearer @Param id path string true "Service Id" @Success 200 {object} models.Service @Failure 400 @Failure 401 @Failure 403 @Failure 404 @Failure 500 @Router /services/{id} [GET]

type Swagger added in v0.1.15 

type Swagger struct{}

func (*Swagger) Swagger added in v0.1.15 

func (this *Swagger) Swagger(config configuration.Config, router *http.ServeMux, control Controller)

type UsersEndpoints added in v0.1.53 

type UsersEndpoints struct{}

type ValidationError added in v0.0.5 

type ValidationError struct {
	Id    string `json:"id"`
	Name  string `json:"name"`
	Error string `json:"error"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.