Event service (gRPC)#

An Event is an annotated moment or time range. The Event Service is responsible for creating and retrieving events for a particular data source.

Endpoints#

Archive event#

gRPC /nominal.event.v2.EventService/ArchiveEvent

Archives an event.

Request: ArchiveEventRequest

uuid string

Response: ArchiveEventResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.event.v2 import event_pb2, event_pb2_grpc

channel = grpc.secure_channel("api.gov.nominal.io:443", grpc.ssl_channel_credentials())
event_service = event_pb2_grpc.EventServiceStub(channel)
auth = [("authorization", "Bearer <api key>")]

request = event_pb2.ArchiveEventRequest(uuid="<uuid>")
response = event_service.ArchiveEvent(request, metadata=auth)
print(response)

package main

import (
	"context"
	"crypto/tls"
	"fmt"
	"log"

	eventv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/event/v2"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
)

func main() {
	conn, err := grpc.NewClient("api.gov.nominal.io:443",
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()
	eventService := eventv2.NewEventServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &eventv2.ArchiveEventRequest{
		Uuid: "<uuid>",
	}
	response, err := eventService.ArchiveEvent(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Batch archive event#

gRPC /nominal.event.v2.EventService/BatchArchiveEvent

Archives a set of events.

Request: BatchArchiveEventRequest

event_rids array of string

Response: BatchArchiveEventResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.event.v2 import event_pb2, event_pb2_grpc

channel = grpc.secure_channel("api.gov.nominal.io:443", grpc.ssl_channel_credentials())
event_service = event_pb2_grpc.EventServiceStub(channel)
auth = [("authorization", "Bearer <api key>")]

request = event_pb2.BatchArchiveEventRequest(event_rids=["<event rids>"])
response = event_service.BatchArchiveEvent(request, metadata=auth)
print(response)

package main

import (
	"context"
	"crypto/tls"
	"fmt"
	"log"

	eventv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/event/v2"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
)

func main() {
	conn, err := grpc.NewClient("api.gov.nominal.io:443",
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()
	eventService := eventv2.NewEventServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &eventv2.BatchArchiveEventRequest{
		EventRids: []string{
			"<event rids>",
		},
	}
	response, err := eventService.BatchArchiveEvent(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Batch unarchive event#

gRPC /nominal.event.v2.EventService/BatchUnarchiveEvent

Unarchives a set of events.

Request: BatchUnarchiveEventRequest

event_rids array of string

Response: BatchUnarchiveEventResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.event.v2 import event_pb2, event_pb2_grpc

channel = grpc.secure_channel("api.gov.nominal.io:443", grpc.ssl_channel_credentials())
event_service = event_pb2_grpc.EventServiceStub(channel)
auth = [("authorization", "Bearer <api key>")]

request = event_pb2.BatchUnarchiveEventRequest(event_rids=["<event rids>"])
response = event_service.BatchUnarchiveEvent(request, metadata=auth)
print(response)

package main

import (
	"context"
	"crypto/tls"
	"fmt"
	"log"

	eventv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/event/v2"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
)

func main() {
	conn, err := grpc.NewClient("api.gov.nominal.io:443",
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()
	eventService := eventv2.NewEventServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &eventv2.BatchUnarchiveEventRequest{
		EventRids: []string{
			"<event rids>",
		},
	}
	response, err := eventService.BatchUnarchiveEvent(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

List properties and labels#

gRPC /nominal.event.v2.EventService/ListPropertiesAndLabels

Lists the properties and labels of active events in the provided workspaces.

Request: ListPropertiesAndLabelsRequest

workspace_rids array of string: If empty, results come from all workspaces the user belongs to.

Response: ListPropertiesAndLabelsResponse

properties map of string to PropertyValues deprecated

Deprecated: use the paginated SearchPropertyKeys and SearchPropertyValues methods instead. Legacy string-only property values. proto3 forbids a repeated map value, so the property values are wrapped.

Fields of PropertyValues

value array of string

labels array of string

Request

Python

import grpc
from nominal.protos.event.v2 import event_pb2, event_pb2_grpc

channel = grpc.secure_channel("api.gov.nominal.io:443", grpc.ssl_channel_credentials())
event_service = event_pb2_grpc.EventServiceStub(channel)
auth = [("authorization", "Bearer <api key>")]

request = event_pb2.ListPropertiesAndLabelsRequest(workspace_rids=["<workspace rids>"])
response = event_service.ListPropertiesAndLabels(request, metadata=auth)
print(response)

package main

import (
	"context"
	"crypto/tls"
	"fmt"
	"log"

	eventv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/event/v2"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
)

func main() {
	conn, err := grpc.NewClient("api.gov.nominal.io:443",
		grpc.WithTransportCredentials(credentials.NewTLS(&tls.Config{})))
	if err != nil {
		log.Fatal(err)
	}
	defer conn.Close()
	eventService := eventv2.NewEventServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &eventv2.ListPropertiesAndLabelsRequest{
		WorkspaceRids: []string{
			"<workspace rids>",
		},
	}
	response, err := eventService.ListPropertiesAndLabels(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{
  "properties": {
    "<key>": {
      "value": [
        "<value>"
      ]
    }
  },
  "labels": [
    "<labels>"
  ]
}

Errors#

Errors shows how these errors are sent.

Code	Reason	Message
`INVALID_ARGUMENT`	`EVENT_ERROR_FIND_EVENTS_INDEX_INVALID`	FindEventsIndexInvalid
`INVALID_ARGUMENT`	`EVENT_ERROR_FIND_EVENTS_QUERY_COUNT_TOO_LARGE`	FindEventsQueryCountTooLarge
`INVALID_ARGUMENT`	`EVENT_ERROR_INVALID_EVENT_REQUEST`	InvalidEventRequest
`INVALID_ARGUMENT`	`EVENT_ERROR_SEARCH_QUERY_TOO_BROAD`	EventSearchQueryTooBroad

Event service (gRPC)#

Endpoints#

Aggregate events#

Archive event#

Batch aggregate events#

Batch archive event#

Batch filter events#

Batch find events#

Batch get events#

Batch unarchive event#

Batch update disposition#

Batch update event#

Create event#

Get events#

Get events histogram#

List properties and labels#

Search events#

Update event#

Errors#

Types#

AggregateEventsRequest#

AggregateEventsResponse#

AggregateType#

AggregateValue#

ApiEventOrigin#

ArchivedStatus#

AssetRidSet#

AssetsFilter#

AssigneesFilter#

CheckOriginMetadata#

ClosedWithFurtherActionDispositionState#

ClosedWithIgnoreDispositionState#

DataReviewChecksFilter#

DataReviewEventOrigin#

DataReviewsFilter#

DispositionState#

Duration#

Event#

EventDisposition#

EventDispositionStatus#

EventDispositionStatusList#

EventOrigin#

EventsHistogramBucket#

EventTimeFilter#

EventTimeFilterCondition#

EventType#

EventTypeList#

EventUpdate#

FindEventsQuery#

FindEventsResult#

HistogramFilterQuery#

HistogramFilterQueryList#

LabelsFilter#

LabelUpdateWrapper#

NumericPropertyPredicate#

NumericPropertyRangeOperator#

NumericPropertyRangePredicate#

OriginTypesFilter#

PendingReviewDispositionState#

Priority#

PriorityList#

ProcedureEventOrigin#

PropertiesFilter#

Property#

PropertyComparisonOperator#

PropertyUpdateWrapper#

PropertyValues#

SearchEventOriginType#

SearchQuery#

SearchQueryList#

SetOperator#

SortField#

SortOptions#

StreamingChecklistEventOrigin#

StreamingCheckOriginMetadata#

TemplateEventOrigin#

TimeSeriesChannelAssociation#

Timestamp#

TypedPropertyUpdateWrapper#

TypedPropertyValue#