Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdvancedController

type AdvancedController struct {
	Controller
	AdvancedService *service.AdvancedService
}

func (*AdvancedController) AddAdvanced

func (ac *AdvancedController) AddAdvanced(c echo.Context) error

swagger:route POST /advanced advanced advancedAddAdvanced

Add advanced item --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AdvancedController) DeleteAdvancedAgainstGUID

func (ac *AdvancedController) DeleteAdvancedAgainstGUID(c echo.Context) error

swagger:operation DELETE /advanced/{guid} advanced advancedDeleteAdvancedAgainstGUID

Delete advanced item by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of item
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AdvancedController) GetAdvancedAgainstGUID

func (ac *AdvancedController) GetAdvancedAgainstGUID(c echo.Context) error

swagger:operation GET /advanced/{guid} advanced advancedGetAdvancedAgainstGUID

Get advanced item by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of item
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AdvancedController) GetAll

func (ac *AdvancedController) GetAll(c echo.Context) error

swagger:route GET /advanced advanced advancedGetAll

Get all advanced items --- produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:AliasStruct

func (*AdvancedController) UpdateAdvancedAgainstGUID

func (ac *AdvancedController) UpdateAdvancedAgainstGUID(c echo.Context) error

swagger:operation PUT /advanced/{guid} advanced advancedUpdateAdvancedAgainstGUID

Update advanced item by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of item
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

type AgentsubController

type AgentsubController struct {
	Controller
	AgentsubService *service.AgentsubService
}

func (*AgentsubController) AddAgentsubWithKey

func (ass *AgentsubController) AddAgentsubWithKey(c echo.Context) error

swagger:operation POST /agent/subscribe agent agentsSubAddAgentsubWithKey

Add agent --- consumes: - application/json produces: - application/json parameters: - name: AgentsLocation Struct

in: body
description: agent parameters
schema:
  "$ref": "#/definitions/AgentsLocation"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AgentsubController) DeleteAgentsubAgainstGUID

func (ass *AgentsubController) DeleteAgentsubAgainstGUID(c echo.Context) error

swagger:operation DELETE /agent/subscribe/{guid} agent agentsSubDeleteAgentsubAgainstGUID

Delete agent by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of agent
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AgentsubController) GetAgentSearchByTypeAndGUID

func (ass *AgentsubController) GetAgentSearchByTypeAndGUID(c echo.Context) error

swagger:operation POST /agent/search/{guid}/{type} agent agentsSubGetAgentSearchByTypeAndGUID

Get agent by guid and type --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of agent
required: true
type: string

- name: type

in: path
example: home
description: type of agent
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AgentsubController) GetAgentsub

func (ass *AgentsubController) GetAgentsub(c echo.Context) error

swagger:route GET /agent/subscribe agent agentsSubGetAgentsub

Get all agents --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:AgentsLocation
'400': body:FailureResponse

func (*AgentsubController) GetAgentsubAgainstGUID

func (ass *AgentsubController) GetAgentsubAgainstGUID(c echo.Context) error

swagger:operation GET /agent/subscribe/{guid} agent agentsSubGetAgentsubAgainstGUID

Get agent by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of agent
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:AgentsLocation
'400': body:FailureResponse

func (*AgentsubController) GetAgentsubByType

func (ass *AgentsubController) GetAgentsubByType(c echo.Context) error

swagger:operation GET /agent/type/{type} agent agentsSubGetAgentsubByType

Get agent by type --- consumes: - application/json produces: - application/json parameters: - name: type

in: path
example: home
description: type of agent
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:AgentsLocation
'400': body:FailureResponse

func (*AgentsubController) UpdateAgentsubAgainstGUID

func (ass *AgentsubController) UpdateAgentsubAgainstGUID(c echo.Context) error

swagger:operation PUT /agent/subscribe/{guid} agent agentsSubUpdateAgentsubAgainstGUID

Update agent by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of agent
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:AgentsLocation
'400': body:FailureResponse

type AliasController

type AliasController struct {
	Controller
	AliasService *service.AliasService
}

func (*AliasController) AddAlias

func (alc *AliasController) AddAlias(c echo.Context) error

swagger:operation POST /alias alias aliasAddAlias

Add alias --- consumes: - application/json produces: - application/json parameters: - name: aliasstruct

in: body
description: alias parameters
schema:
  "$ref": "#/definitions/AliasStruct"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:UserLoginSuccessResponse
'401': body:UserLoginFailureResponse

func (*AliasController) DeleteAlias

func (als *AliasController) DeleteAlias(c echo.Context) error

swagger:operation DELETE /alias/{guid} alias aliasDeleteAlias

Delete alias --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of the alias
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:AliasStruct

func (*AliasController) GetAllAlias

func (alc *AliasController) GetAllAlias(c echo.Context) error

swagger:route GET /alias alias aliasGetAllAlias

Get all aliases --- produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:AliasStruct

func (*AliasController) UpdateAlias

func (als *AliasController) UpdateAlias(c echo.Context) error

swagger:operation PUT /alias/{guid} alias aliasUpdateAlias

Update alias --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: uuid of the alias to update
required: true
type: string

- name: aliasStruct

in: body
description: alias parameters
schema:
  "$ref": "#/definitions/AliasStruct"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:AliasStruct

type AuthtokenController

type AuthtokenController struct {
	Controller
	AuthtokenService *service.AuthtokenService
}

func (*AuthtokenController) AddAuthtoken

func (ass *AuthtokenController) AddAuthtoken(c echo.Context) error

swagger:operation POST /token/auth token authTokenAddAuthToken

Add token --- consumes: - application/json produces: - application/json parameters: - name: authTokenStruct

in: body
description: authToken parameters
schema:
  "$ref": "#/definitions/AuthToken"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AuthtokenController) DeleteAuthtokenAgainstGUID

func (ass *AuthtokenController) DeleteAuthtokenAgainstGUID(c echo.Context) error

swagger:operation DELETE /token/auth/{guid} token authTokenDeleteAuthtokenAgainstGUID

Delete token by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of token
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AuthtokenController) GetAuthtoken

func (ass *AuthtokenController) GetAuthtoken(c echo.Context) error

swagger:route GET /token/auth token authTokenGetAuthtoken

Get all tokens --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AuthtokenController) GetAuthtokenAgainstGUID

func (ass *AuthtokenController) GetAuthtokenAgainstGUID(c echo.Context) error

swagger:operation GET /token/auth/{guid} token authTokenGetAuthtokenAgainstGUID

Get token by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of token
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*AuthtokenController) UpdateAuthtokenAgainstGUID

func (ass *AuthtokenController) UpdateAuthtokenAgainstGUID(c echo.Context) error

swagger:operation PUT /token/auth/{guid} token authTokenUpdateAuthtokenAgainstGUID

Update token by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of token
required: true
type: string

- name: authTokenStruct

in: body
description: authToken parameters
schema:
  "$ref": "#/definitions/AuthToken"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

type Controller

type Controller struct {
}

type DashBoardController

type DashBoardController struct {
	Controller
	DashBoardService *service.DashBoardService
}

func (*DashBoardController) DeleteDashboard

func (dbc *DashBoardController) DeleteDashboard(c echo.Context) error

swagger:operation DELETE /dashboard/store/{dashboardId} dashboard dashboardDeleteDashboard

Delete dashboard --- consumes: - application/json produces: - application/json parameters: - name: dashboard param

in: path
example: home
description: the param of dashboard
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:SuccessResponse
'400': body:FailureResponse

func (*DashBoardController) GetDashBoard

func (dbc *DashBoardController) GetDashBoard(c echo.Context) error

swagger:operation GET /dashboard/store/{dashboardId} dashboard dashboardGetDashBoard

Get dashboard by param --- consumes: - application/json produces: - application/json parameters: - name: dashboard param

in: path
example: home
description: param of dashboard
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:UserSettings
'400': body:FailureResponse

func (*DashBoardController) GetDashBoardLists

func (dbc *DashBoardController) GetDashBoardLists(c echo.Context) error

swagger:route GET /dashboard/info dashboard dashboardGetDashBoardLists

Get all dashboards --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:DashboardElements
'400': body:FailureResponse

func (*DashBoardController) InsertDashboard

func (dbc *DashBoardController) InsertDashboard(c echo.Context) error

swagger:operation POST /dashboard/store/{dashboardId} dashboard dashboardInsertDashboard

Add dashboard --- consumes: - application/json produces: - application/json parameters: - name: dashboard param

in: path
example: home
description: the param of dashboard
required: true
type: string

- name: dashboard data

in: body
schema:
  type: string
required: true
description: json of dashboard

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:UserSettings
'400': body:FailureResponse

type GrafanaController

type GrafanaController struct {
	Controller
	GrafanaService *service.GrafanaService
}

func (*GrafanaController) GrafanaFolders

func (pc *GrafanaController) GrafanaFolders(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*GrafanaController) GrafanaGetDashboardAgainstUUID

func (pc *GrafanaController) GrafanaGetDashboardAgainstUUID(c echo.Context) error

swagger:operation GET /proxy/grafana/dashboards/uid/{uid} proxy grafanaGrafanaGetDashboardAgainstUUID

Returns data based upon filtered json --- produces: - application/json parameters: - name: uid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: uid
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*GrafanaController) GrafanaGetFoldersAgainstUUID

func (pc *GrafanaController) GrafanaGetFoldersAgainstUUID(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*GrafanaController) GrafanaORG

func (pc *GrafanaController) GrafanaORG(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*GrafanaController) GrafanaURL

func (pc *GrafanaController) GrafanaURL(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

type HepsubController

type HepsubController struct {
	Controller
	HepsubService *service.HepsubService
}

func (*HepsubController) AddHepSub

func (hsc *HepsubController) AddHepSub(c echo.Context) error

swagger:operation POST /hepsub/protocol hep hepSubAddHepSub

Add new Hepsub information --- consumes: - application/json produces: - application/json parameters: - name: hepSubStruct

in: body
description: hepSub parameters
schema:
  "$ref": "#/definitions/HepsubSchema"

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*HepsubController) DeleteHepSubAgainstGUID

func (hsc *HepsubController) DeleteHepSubAgainstGUID(c echo.Context) error

swagger:operation DELETE /hepsub/protocol/{guid} hep hepSubDeleteHepSubAgainstGUID

Delete hepsub by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of hepsub item
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*HepsubController) GetHepSub

func (hsc *HepsubController) GetHepSub(c echo.Context) error

swagger:route GET /hepsub/protocol hep hepSubGetHepSub

Get all hepsub --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*HepsubController) GetHepSubAgainstGUID

func (hsc *HepsubController) GetHepSubAgainstGUID(c echo.Context) error

swagger:operation GET /hepsub/protocol/{guid} hep hepSubGetHepSubAgainstGUID

Get hepsub by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of item
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*HepsubController) GetHepSubFields

func (hsc *HepsubController) GetHepSubFields(c echo.Context) error

swagger:operation GET /hepsub/protocol/{id}/{transaction} hep hepSubGetHepSubFields

Get hepsub by id and transaction --- consumes: - application/json produces: - application/json parameters: - name: id

in: path
example: 1
description: hepid
required: true
type: string

- name: transaction

in: path
example: call
description: profile
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*HepsubController) UpdateHepSubAgainstGUID

func (hsc *HepsubController) UpdateHepSubAgainstGUID(c echo.Context) error

swagger:operation PUT /hepsub/protocol/{guid} hep hepSubUpdateHepSubAgainstGUID

Update hepsub by guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: eacdae5b-4203-40a2-b388-969312ffcffe
description: guid of hepsub item
required: true
type: string

- name: hepSubStruct

in: body
description: hepSub parameters
schema:
  "$ref": "#/definitions/HepsubSchema"

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

type HepsubsearchController

type HepsubsearchController struct {
	Controller
	HepsubsearchService *service.HepsubsearchService
}

func (*HepsubsearchController) DoHepsubsearch

func (hss *HepsubsearchController) DoHepsubsearch(c echo.Context) error

swagger:operation POST /hepsub/search hep hepSubSearchDoHepsubsearch

Add hepsubsearch item --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

type MappingController

type MappingController struct {
	Controller
	MappingService *service.MappingService
}

func (*MappingController) AddMapping

func (mpc *MappingController) AddMapping(c echo.Context) error

swagger:operation POST /mapping/protocol mapping mappingAddMapping

Add mapping --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*MappingController) DeleteMappingAgainstGUID

func (mpc *MappingController) DeleteMappingAgainstGUID(c echo.Context) error

swagger:operation DELETE /mapping/protocol/{guid} mapping mappingDeleteMappingAgainstGUID

Delete mapping using guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of mapping
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*MappingController) GetMapping

func (mpc *MappingController) GetMapping(c echo.Context) error

swagger:route GET /mapping/protocol mapping mappingGetMapping

Get all mappings --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*MappingController) GetMappingAgainstGUID

func (mpc *MappingController) GetMappingAgainstGUID(c echo.Context) error

swagger:operation GET /mapping/protocol/{guid} mapping mappingGetMappingAgainstGUID

Get mapping using guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of mapping
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*MappingController) GetMappingFields

func (mpc *MappingController) GetMappingFields(c echo.Context) error

swagger:operation GET /mapping/protocol/{id}/{transaction} mapping mappingGetMappingFields

Get mapping using id and transaction --- consumes: - application/json produces: - application/json parameters: - name: id

in: path
example: 1
description: hepid
required: true
type: int

parameters: - name: transaction

in: path
example: call
description: profile
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*MappingController) GetSmartHepProfile

func (mpc *MappingController) GetSmartHepProfile(c echo.Context) error

swagger:operation GET /smart/search/tag/{hepid}/{profile} mapping mappingGetSmartHepProfile

Get smart hep profile using hepid and profile --- consumes: - application/json produces: - application/json parameters: - name: hepid

in: path
example: 1
description: hepid
required: true
type: string

- name: profile

in: path
example:
description: profile
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

func (*MappingController) UpdateMappingAgainstGUID

func (mpc *MappingController) UpdateMappingAgainstGUID(c echo.Context) error

swagger:operation PUT /mapping/protocol/{guid} mapping mappingUpdateMappingAgainstGUID

Update mapping using guid --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of mapping
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:UserCreateSuccessfulResponse

type ProfileController

type ProfileController struct {
	Controller
	ProfileService *service.ProfileService
}

func (*ProfileController) GetDBNodeList

func (pc *ProfileController) GetDBNodeList(c echo.Context) error

swagger:route GET /database/node/list profile profileGetDBNodeList

Get mappings --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserCreateSuccessfulResponse
'400': body:FailureResponse

func (*ProfileController) GetDashboardList

func (pc *ProfileController) GetDashboardList(c echo.Context) error

swagger:route GET /admin/profiles profile profileGetDashboardList

Get mappings --- consumes: - application/json produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:HepsubSchema
'400': body:FailureResponse

func (*ProfileController) GetHepsub

func (pc *ProfileController) GetHepsub(c echo.Context) error

type PrometheusController

type PrometheusController struct {
	Controller
	PrometheusService *service.PrometheusService
}

func (*PrometheusController) PrometheusData

func (pc *PrometheusController) PrometheusData(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*PrometheusController) PrometheusLabelData

func (pc *PrometheusController) PrometheusLabelData(c echo.Context) error

responses:

'200': body:ListLabels
'400': body:UserLoginFailureResponse

func (*PrometheusController) PrometheusLabels

func (pc *PrometheusController) PrometheusLabels(c echo.Context) error

responses:

'200': body:ListLabels
'400': body:UserLoginFailureResponse

func (*PrometheusController) PrometheusValue

func (pc *PrometheusController) PrometheusValue(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

type RemoteController

type RemoteController struct {
	Controller
	RemoteService *service.RemoteService
}

func (*RemoteController) RemoteData

func (pc *RemoteController) RemoteData(c echo.Context) error

responses:

'200': body:ListValues
'400': body:UserLoginFailureResponse

func (*RemoteController) RemoteLabel

func (pc *RemoteController) RemoteLabel(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*RemoteController) RemoteValues

func (pc *RemoteController) RemoteValues(c echo.Context) error

responses:

'200': body:ListValues
'400': body:UserLoginFailureResponse

type SearchController

type SearchController struct {
	Controller
	SearchService  *service.SearchService
	SettingService *service.UserSettingsService
	AliasService   *service.AliasService
}

func (*SearchController) GetDecodeMessageById

func (sc *SearchController) GetDecodeMessageById(c echo.Context) error

swagger:operation POST /search/call/decode/message search searchGetDecodeMessageById

Returns data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) GetMessageById

func (sc *SearchController) GetMessageById(c echo.Context) error

swagger:operation POST /search/call/message search searchGetMessageById

Returns message data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) GetMessagesAsPCap

func (sc *SearchController) GetMessagesAsPCap(c echo.Context) error

swagger:operation POST /export/call/messages/pcap search searchGetMessagesAsPCap

Returns pcap data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) GetMessagesAsText

func (sc *SearchController) GetMessagesAsText(c echo.Context) error

swagger:operation POST /export/call/messages/text search searchGetMessagesAsText

Returns text data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) GetTransaction

func (sc *SearchController) GetTransaction(c echo.Context) error

swagger:operation POST /call/transaction search searchGetTransaction

Returns transaction data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) GetTransactionHepSub

func (sc *SearchController) GetTransactionHepSub(c echo.Context) error

func (*SearchController) GetTransactionLog

func (sc *SearchController) GetTransactionLog(c echo.Context) error

swagger:operation POST /call/report/log search searchGetTransactionLog

Returns log data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) GetTransactionQos

func (sc *SearchController) GetTransactionQos(c echo.Context) error

swagger:operation POST /call/report/qos search searchGetTransactionQos

Returns qos data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*SearchController) SearchData

func (sc *SearchController) SearchData(c echo.Context) error

swagger:operation POST /search/call/data search searchSearchData

Returns data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

type StatisticController

type StatisticController struct {
	Controller
	StatisticService *service.StatisticService
}

func (*StatisticController) GetStatisticDBList

func (sc *StatisticController) GetStatisticDBList(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*StatisticController) GetStatisticMeasurementsList

func (sc *StatisticController) GetStatisticMeasurementsList(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*StatisticController) GetStatisticMetricsList

func (sc *StatisticController) GetStatisticMetricsList(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*StatisticController) GetStatisticRetentionsList

func (sc *StatisticController) GetStatisticRetentionsList(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*StatisticController) GetStatisticTagsList

func (sc *StatisticController) GetStatisticTagsList(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*StatisticController) StatisticData

func (sc *StatisticController) StatisticData(c echo.Context) error

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

type UserController

type UserController struct {
	Controller
	UserService *service.UserService
}

func (*UserController) CreateUser

func (uc *UserController) CreateUser(c echo.Context) error

swagger:operation POST /users user userCreateUser

Create a New user --- consumes: - application/json produces: - application/json parameters: - name: userstruct

in: body
description: user structure
schema:
  "$ref": "#/definitions/CreateUserStruct"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:SuccessResponse
'400': body:FailureResponse

func (*UserController) DeleteUser

func (uc *UserController) DeleteUser(c echo.Context) error

swagger:operation DELETE /users/{userGuid} user userDeleteUser

Delete an existing User --- consumes: - application/json produces: - application/json parameters: - name: userGuid

in: path
example: 11111111-1111-1111-1111-111111111111
description: uuid of the user to update
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:SuccessResponse
'400': body:FailureResponse

func (*UserController) GetUser

func (uc *UserController) GetUser(c echo.Context) error

swagger:route GET /users user userGetUser

Returns the list of Users --- produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:FailureResponse

func (*UserController) LoginUser

func (uc *UserController) LoginUser(c echo.Context) error

swagger:operation POST /auth user auth userLoginUser

Returns a JWT Token and UUID attached to user --- consumes: - application/json produces: - application/json parameters: - name: userLoginStruct

in: body
description: user login structure
schema:
  "$ref": "#/definitions/UserLogin"
required: true

responses:

'201': body:UserLoginSuccessResponse
'400': body:FailureResponse

func (*UserController) UpdateUser

func (uc *UserController) UpdateUser(c echo.Context) error

swagger:operation PUT /users/{userGuid} user userUpdateUser

Update an existing user --- consumes: - application/json produces: - application/json parameters: - name: userGuid

in: path
example: 11111111-1111-1111-1111-111111111111
description: uuid of the user to update
required: true
type: string

- name: createUserStruct

in: body
description: user parameters
schema:
  "$ref": "#/definitions/CreateUserStruct"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:SuccessResponse
'400': body:FailureResponse

type UserSettingsController

type UserSettingsController struct {
	Controller
	UserSettingsService *service.UserSettingsService
}

func (*UserSettingsController) AddUserSettings

func (usc *UserSettingsController) AddUserSettings(c echo.Context) error

swagger:operation POST /user/settings settings settingsAddUserSettings

Adds user settings --- consumes: - application/json produces: - application/json parameters: - name: userSettingsStruct

in: body
description: TableUserSettings struct
schema:
  "$ref": "#/definitions/UserSettings"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:UserLoginSuccessResponse
'400': body:UserLoginFailureResponse

func (*UserSettingsController) DeleteUserSettings

func (usc *UserSettingsController) DeleteUserSettings(c echo.Context) error

swagger:operation DELETE /user/settings/{guid} settings settingsDeleteUserSettings

Delete user settings --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of user settings
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:SuccessResponse

func (*UserSettingsController) GetAll

func (usc *UserSettingsController) GetAll(c echo.Context) error

swagger:route GET /user/settings settings settingsGetAll

Returns the list of settings --- produces: - application/json Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*UserSettingsController) GetCategory

func (usc *UserSettingsController) GetCategory(c echo.Context) error

swagger:operation GET /user/settings/{category} settings settingsGetCategory

Returns the list of settings --- consumes: - application/json produces: - application/json parameters: - name: category

in: path
description: user settings category
example: dashboard
required: true
type: string

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse

func (*UserSettingsController) UpdateUserSettings

func (usc *UserSettingsController) UpdateUserSettings(c echo.Context) error

swagger:operation PUT /user/settings/{guid} settings settingsUpdateUserSettings

Update user settings --- consumes: - application/json produces: - application/json parameters: - name: guid

in: path
example: 11111111-1111-1111-1111-111111111111
description: guid of user settings
required: true
type: string

- name: tableUserSettingsStruct

in: body
description: TableUserSettings
schema:
  "$ref": "#/definitions/UserSettings"
required: true

Security: - bearer: []

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'201': body:SuccessResponse

type WebSocketController

type WebSocketController struct {
	Controller
	Addr *string
}

func (*WebSocketController) RelayHepData

func (wb *WebSocketController) RelayHepData(c echo.Context) error

swagger:operation GET /ws WebSocket

Returns data based upon filtered json --- consumes: - application/json produces: - application/json parameters: - name: SearchObject

in: body
type: object
description: SearchObject parameters
schema:
  "$ref": "#/definitions/SearchCallData"
required: true

SecurityDefinitions: bearer:

type: apiKey
name: Authorization
in: header

responses:

'200': body:ListUsers
'400': body:UserLoginFailureResponse