Event service#

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

OpenAPI file: nominal.event.v2.json

Endpoints#

Archive event#

POST /event/v2/events/archive

Archives an event.

Body

uuid string

Response

An empty JSON object, {}.

Request

curl

curl -X POST "https://api.gov.nominal.io/api/event/v2/events/archive" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "uuid": "<uuid>"
}'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v2/events/archive",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuid": "<uuid>"},
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v2/events/archive",
    headers={"Authorization": "Bearer <api key>"},
    json={"uuid": "<uuid>"},
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/event/v2/events/archive",
            headers={"Authorization": "Bearer <api key>"},
            json={"uuid": "<uuid>"},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{}

Batch archive event#

POST /event/v2/events/batch-archive

Archives a set of events.

Body

eventRids array of string

Response

An empty JSON object, {}.

Request

curl

curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-archive" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "eventRids": [
    "<event rids>"
  ]
}'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v2/events/batch-archive",
    headers={"Authorization": "Bearer <api key>"},
    json={"eventRids": ["<event rids>"]},
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v2/events/batch-archive",
    headers={"Authorization": "Bearer <api key>"},
    json={"eventRids": ["<event rids>"]},
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/event/v2/events/batch-archive",
            headers={"Authorization": "Bearer <api key>"},
            json={"eventRids": ["<event rids>"]},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{}

Batch unarchive event#

POST /event/v2/events/batch-unarchive

Unarchives a set of events.

Body

eventRids array of string

Response

An empty JSON object, {}.

Request

curl

curl -X POST "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "eventRids": [
    "<event rids>"
  ]
}'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive",
    headers={"Authorization": "Bearer <api key>"},
    json={"eventRids": ["<event rids>"]},
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive",
    headers={"Authorization": "Bearer <api key>"},
    json={"eventRids": ["<event rids>"]},
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/event/v2/events/batch-unarchive",
            headers={"Authorization": "Bearer <api key>"},
            json={"eventRids": ["<event rids>"]},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

{}

List properties and labels#

POST /event/v2/list-properties-labels

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

Body

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

Response

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

curl

curl -X POST "https://api.gov.nominal.io/api/event/v2/list-properties-labels" \
  -H "Authorization: Bearer <api key>" \
  -H "Content-Type: application/json" \
  --data '{
  "workspaceRids": [
    "<workspace rids>"
  ]
}'

requests

import requests

response = requests.post(
    "https://api.gov.nominal.io/api/event/v2/list-properties-labels",
    headers={"Authorization": "Bearer <api key>"},
    json={"workspaceRids": ["<workspace rids>"]},
)
response.raise_for_status()
print(response.json())

httpx

import httpx

response = httpx.post(
    "https://api.gov.nominal.io/api/event/v2/list-properties-labels",
    headers={"Authorization": "Bearer <api key>"},
    json={"workspaceRids": ["<workspace rids>"]},
)
response.raise_for_status()
print(response.json())

aiohttp

import asyncio

import aiohttp


async def main() -> None:
    async with aiohttp.ClientSession() as session:
        async with session.post(
            "https://api.gov.nominal.io/api/event/v2/list-properties-labels",
            headers={"Authorization": "Bearer <api key>"},
            json={"workspaceRids": ["<workspace rids>"]},
        ) as response:
            response.raise_for_status()
            print(await response.json())


asyncio.run(main())

Response: 200

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

Errors#

Errors shows how these errors are sent.

Each error’s errorName is NominalEventV2: followed by its name below.

Status	Name	Notes
400	`EventErrorFindEventsIndexInvalid`	FindEventsIndexInvalid
400	`EventErrorFindEventsQueryCountTooLarge`	FindEventsQueryCountTooLarge
400	`EventErrorInvalidEventRequest`	InvalidEventRequest
400	`EventErrorSearchQueryTooBroad`	EventSearchQueryTooBroad

Event service#

Endpoints#

Create event#

Aggregate events#

Archive event#

Batch aggregate events#

Batch archive event#

Batch filter events#

Batch find events#

Batch get events#

Batch unarchive event#

Batch update event#

Batch update disposition#

Get events#

Get events histogram#

Search events#

Update event#

List properties and labels#

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#