Asset service (gRPC)#

An asset is a physical entity within an organization, such as a vehicle or ground station. Assets are comprised of some metadata about the data, as well as a set of data scopes that define the data belonging to the asset. API endpoints allow for CRUD operations on asset objects.

Endpoints#

Archive#

gRPC /nominal.asset.v2.AssetService/Archive

Archives the asset with the given RID.

Request: ArchiveRequest

asset_rid string
include_linked_workbooks boolean: If true, all workbooks that are linked to the asset and associated runs will be archived as well. Defaults to false.

Response: ArchiveResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.ArchiveRequest(
    asset_rid="<asset rid>",
    include_linked_workbooks=True,
)
response = asset_service.Archive(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/v2"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
	"google.golang.org/protobuf/proto"
)

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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.ArchiveRequest{
		AssetRid:               "<asset rid>",
		IncludeLinkedWorkbooks: proto.Bool(true),
	}
	response, err := assetService.Archive(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Archive type#

gRPC /nominal.asset.v2.AssetService/ArchiveType

Archives the asset type with the given RID.

Request: ArchiveTypeRequest

type_rid string

Response: ArchiveTypeResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.ArchiveTypeRequest(type_rid="<type rid>")
response = asset_service.ArchiveType(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.ArchiveTypeRequest{
		TypeRid: "<type rid>",
	}
	response, err := assetService.ArchiveType(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Create type#

gRPC /nominal.asset.v2.AssetService/CreateType

Creates a new type.

Request: CreateTypeRequest

name string

property_configs map of string to PropertyConfig

Fields of PropertyConfig

requirement PropertyRequirement

Values of PropertyRequirement

PROPERTY_REQUIREMENT_UNSPECIFIED
REQUIRED
SUGGESTED

value_type PropertyValueType

Values of PropertyValueType

PROPERTY_VALUE_TYPE_UNSPECIFIED
STRING
NUMBER

description string

icon_name string

workspace string

The workspace in which to create the asset type. If not provided, the asset type will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

primary_key string

The property that identifies an asset of this type. It is a required nonempty string and is not repeated in property_configs.

data_requirements DataRequirements

Requirements on the data of assets of this type.

Fields of DataRequirements

series SeriesRequirements

Fields of SeriesRequirements

series array of SeriesRequirement

At most 200, with unique names. At most 200 items.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

links array of LinkDefinition

A link to the new type itself can only be added by a later update, once the type has a rid. At most 20 items.

Fields of LinkDefinition

rid string

Server-assigned. In an update, names one of the type’s existing links, whose kind and target type cannot change; absent adds a new link. Must be absent on create.

source_type_rid string

Read-only: always present in responses. Leave it unset in requests, where the source is the type being created or updated; a value sent there is ignored.

target_type_rid string

May be the source type itself.

forward_label string

The link’s name seen from the source type, absent if not set. Clients typically fall back to the target type’s name. 1 to 100 characters.

inverse_label string

The link’s name seen from the target type, absent if not set. Clients typically fall back to the source type’s name. 1 to 100 characters.

direct DirectLink

Fields of DirectLink

source_property string: A string property declared in the source type’s property_configs, other than its primary key. Whether every source asset must set it is that property’s requirement. At least 1 character.

Response: CreateTypeResponse

type Type

Fields of Type

rid string

name string

description string

property_configs map of string to PropertyConfig

Fields of PropertyConfig

requirement PropertyRequirement

Values of PropertyRequirement

PROPERTY_REQUIREMENT_UNSPECIFIED
REQUIRED
SUGGESTED

value_type PropertyValueType

Values of PropertyValueType

PROPERTY_VALUE_TYPE_UNSPECIFIED
STRING
NUMBER

created_at string (date-time)

icon_name string

The name of the icon to display for the type. This name maps to a Lucide icon in the frontend.

primary_key string

The property that identifies an asset of this type. It is a required nonempty string and is not repeated in property_configs.

is_archived boolean

data_requirements DataRequirements

Requirements on the data of assets of this type, absent if none were ever set. Checked when the type is attached to an asset; later data or definition changes are not rechecked.

Fields of DataRequirements

series SeriesRequirements

Fields of SeriesRequirements

series array of SeriesRequirement

At most 200, with unique names. At most 200 items.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

outgoing_links array of LinkDefinition

Links this type declares, oldest first.

Fields of LinkDefinition

rid string

Server-assigned. In an update, names one of the type’s existing links, whose kind and target type cannot change; absent adds a new link. Must be absent on create.

source_type_rid string

Read-only: always present in responses. Leave it unset in requests, where the source is the type being created or updated; a value sent there is ignored.

target_type_rid string

May be the source type itself.

forward_label string

The link’s name seen from the source type, absent if not set. Clients typically fall back to the target type’s name. 1 to 100 characters.

inverse_label string

The link’s name seen from the target type, absent if not set. Clients typically fall back to the source type’s name. 1 to 100 characters.

direct DirectLink

Fields of DirectLink

source_property string: A string property declared in the source type’s property_configs, other than its primary key. Whether every source asset must set it is that property’s requirement. At least 1 character.

incoming_links array of LinkDefinition

Links other types declare that target this type, including this type’s links to itself, oldest first. Read-only: a link is changed through its source type.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.CreateTypeRequest(
    name="<name>",
    property_configs={"<key>": {"requirement": "REQUIRED", "value_type": "STRING"}},
    description="<description>",
    icon_name="<icon name>",
    workspace="<workspace>",
    primary_key="<primary key>",
    data_requirements={"series": {"series": [{"name": "<name>", "type": "NUMERIC"}]}},
    links=[
        {
            "rid": "<rid>",
            "source_type_rid": "<source type rid>",
            "target_type_rid": "<target type rid>",
            "forward_label": "<forward label>",
            "inverse_label": "<inverse label>",
            "direct": {"source_property": "<source property>"},
        },
    ],
)
response = asset_service.CreateType(request, metadata=auth)
print(response)

Response

{
  "type": {
    "rid": "<rid>",
    "name": "<name>",
    "description": "<description>",
    "property_configs": {
      "<key>": {
        "requirement": "REQUIRED",
        "value_type": "STRING"
      }
    },
    "created_at": "2026-01-01T00:00:00Z",
    "icon_name": "<icon name>",
    "primary_key": "<primary key>",
    "is_archived": true,
    "data_requirements": {
      "series": {
        "series": [
          {
            "name": "<name>",
            "type": "NUMERIC"
          }
        ]
      }
    },
    "outgoing_links": [
      {
        "rid": "<rid>",
        "source_type_rid": "<source type rid>",
        "target_type_rid": "<target type rid>",
        "forward_label": "<forward label>",
        "inverse_label": "<inverse label>",
        "direct": {
          "source_property": "<source property>"
        }
      }
    ],
    "incoming_links": [
      {
        "rid": "<rid>",
        "source_type_rid": "<source type rid>",
        "target_type_rid": "<target type rid>",
        "forward_label": "<forward label>",
        "inverse_label": "<inverse label>",
        "direct": {
          "source_property": "<source property>"
        }
      }
    ]
  }
}

Delete type#

gRPC /nominal.asset.v2.AssetService/DeleteType

Deletes a type. The type must not be referenced by any assets.

Request: DeleteTypeRequest

type_rid string

Response: DeleteTypeResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.DeleteTypeRequest(type_rid="<type rid>")
response = asset_service.DeleteType(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.DeleteTypeRequest{
		TypeRid: "<type rid>",
	}
	response, err := assetService.DeleteType(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Get asset data conformance#

gRPC /nominal.asset.v2.AssetService/GetAssetDataConformance

Reports, for each asset, whether its current data meets the data requirements of its types. Requirements are only enforced when a type is attached, so an asset whose data changed since may no longer meet them. Needs view permission on each asset; assets that are missing or not viewable are left out of the response.

Request: GetAssetDataConformanceRequest

asset_rids array of string: 1 to 100 unique asset RIDs. 1 to 100 items. No duplicates.

Response: GetAssetDataConformanceResponse

assets map of string to AssetDataConformance

Keyed by asset RID. An asset none of whose types have data requirements has an empty types map. Assets that do not exist or that the caller cannot view are left out.

Fields of AssetDataConformance

types map of string to TypeDataConformance

Keyed by type RID, with an entry for each type on the asset that has data requirements.

Fields of TypeDataConformance

one of met, unmet, unknown

met

met DataRequirementsMet

unmet

unmet DataRequirementsUnmet

Fields of DataRequirementsUnmet

missing_series array of SeriesRequirement

Every required series that the asset’s data has no series of that name and type for, by name. Nonempty.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

unknown

unknown DataRequirementsUnknown

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.GetAssetDataConformanceRequest(asset_rids=["<asset rids>"])
response = asset_service.GetAssetDataConformance(request, metadata=auth)
print(response)

Response

{
  "assets": {
    "<key>": {
      "types": {
        "<key>": {
          "met": {}
        }
      }
    }
  }
}

Get types#

gRPC /nominal.asset.v2.AssetService/GetTypes

Returns the asset types for the given type RIDs.

Request: GetTypesRequest

rids array of string

Response: GetTypesResponse

responses map of string to Type

Fields of Type

rid string

name string

description string

property_configs map of string to PropertyConfig

Fields of PropertyConfig

requirement PropertyRequirement

Values of PropertyRequirement

PROPERTY_REQUIREMENT_UNSPECIFIED
REQUIRED
SUGGESTED

value_type PropertyValueType

Values of PropertyValueType

PROPERTY_VALUE_TYPE_UNSPECIFIED
STRING
NUMBER

created_at string (date-time)

icon_name string

The name of the icon to display for the type. This name maps to a Lucide icon in the frontend.

primary_key string

The property that identifies an asset of this type. It is a required nonempty string and is not repeated in property_configs.

is_archived boolean

data_requirements DataRequirements

Requirements on the data of assets of this type, absent if none were ever set. Checked when the type is attached to an asset; later data or definition changes are not rechecked.

Fields of DataRequirements

series SeriesRequirements

Fields of SeriesRequirements

series array of SeriesRequirement

At most 200, with unique names. At most 200 items.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

outgoing_links array of LinkDefinition

Links this type declares, oldest first.

Fields of LinkDefinition

rid string

Server-assigned. In an update, names one of the type’s existing links, whose kind and target type cannot change; absent adds a new link. Must be absent on create.

source_type_rid string

Read-only: always present in responses. Leave it unset in requests, where the source is the type being created or updated; a value sent there is ignored.

target_type_rid string

May be the source type itself.

forward_label string

The link’s name seen from the source type, absent if not set. Clients typically fall back to the target type’s name. 1 to 100 characters.

inverse_label string

The link’s name seen from the target type, absent if not set. Clients typically fall back to the source type’s name. 1 to 100 characters.

direct DirectLink

Fields of DirectLink

source_property string: A string property declared in the source type’s property_configs, other than its primary key. Whether every source asset must set it is that property’s requirement. At least 1 character.

incoming_links array of LinkDefinition

Links other types declare that target this type, including this type’s links to itself, oldest first. Read-only: a link is changed through its source type.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.GetTypesRequest(rids=["<rids>"])
response = asset_service.GetTypes(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.GetTypesRequest{
		Rids: []string{
			"<rids>",
		},
	}
	response, err := assetService.GetTypes(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{
  "responses": {
    "<key>": {
      "rid": "<rid>",
      "name": "<name>",
      "description": "<description>",
      "property_configs": {
        "<key>": {
          "requirement": "REQUIRED",
          "value_type": "STRING"
        }
      },
      "created_at": "2026-01-01T00:00:00Z",
      "icon_name": "<icon name>",
      "primary_key": "<primary key>",
      "is_archived": true,
      "data_requirements": {
        "series": {
          "series": [
            {
              "name": "<name>",
              "type": "NUMERIC"
            }
          ]
        }
      },
      "outgoing_links": [
        {
          "rid": "<rid>",
          "source_type_rid": "<source type rid>",
          "target_type_rid": "<target type rid>",
          "forward_label": "<forward label>",
          "inverse_label": "<inverse label>",
          "direct": {
            "source_property": "<source property>"
          }
        }
      ],
      "incoming_links": [
        {
          "rid": "<rid>",
          "source_type_rid": "<source type rid>",
          "target_type_rid": "<target type rid>",
          "forward_label": "<forward label>",
          "inverse_label": "<inverse label>",
          "direct": {
            "source_property": "<source property>"
          }
        }
      ]
    }
  }
}

Search types#

gRPC /nominal.asset.v2.AssetService/SearchTypes

Searches for asset types matching the given query.

Request: SearchTypesRequest

sort TypeSortOptions

Fields of TypeSortOptions

is_descending boolean

field TypeSortField

Values of TypeSortField

TYPE_SORT_FIELD_UNSPECIFIED
CREATED_AT

page_size integer

Page sizes greater than 10_000 will be rejected. Default pageSize is 100.

next_page_token string

query SearchTypesQuery

Fields of SearchTypesQuery

one of 5 fields required

search_text

search_text string

property

property string

and

and SearchTypesQueryList

Fields of SearchTypesQueryList

queries array of SearchTypesQuery

or SearchTypesQueryList

workspace

workspace string

archived_statuses ArchivedStatusSet

Fields of ArchivedStatusSet

archived_statuses array of ArchivedStatus

Values of ArchivedStatus

ARCHIVED_STATUS_UNSPECIFIED
NOT_ARCHIVED
ARCHIVED

Response: SearchTypesResponse

results array of Type

Fields of Type

rid string

name string

description string

property_configs map of string to PropertyConfig

Fields of PropertyConfig

requirement PropertyRequirement

Values of PropertyRequirement

PROPERTY_REQUIREMENT_UNSPECIFIED
REQUIRED
SUGGESTED

value_type PropertyValueType

Values of PropertyValueType

PROPERTY_VALUE_TYPE_UNSPECIFIED
STRING
NUMBER

created_at string (date-time)

icon_name string

The name of the icon to display for the type. This name maps to a Lucide icon in the frontend.

primary_key string

The property that identifies an asset of this type. It is a required nonempty string and is not repeated in property_configs.

is_archived boolean

data_requirements DataRequirements

Requirements on the data of assets of this type, absent if none were ever set. Checked when the type is attached to an asset; later data or definition changes are not rechecked.

Fields of DataRequirements

series SeriesRequirements

Fields of SeriesRequirements

series array of SeriesRequirement

At most 200, with unique names. At most 200 items.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

outgoing_links array of LinkDefinition

Links this type declares, oldest first.

Fields of LinkDefinition

rid string

Server-assigned. In an update, names one of the type’s existing links, whose kind and target type cannot change; absent adds a new link. Must be absent on create.

source_type_rid string

Read-only: always present in responses. Leave it unset in requests, where the source is the type being created or updated; a value sent there is ignored.

target_type_rid string

May be the source type itself.

forward_label string

The link’s name seen from the source type, absent if not set. Clients typically fall back to the target type’s name. 1 to 100 characters.

inverse_label string

The link’s name seen from the target type, absent if not set. Clients typically fall back to the source type’s name. 1 to 100 characters.

direct DirectLink

Fields of DirectLink

source_property string: A string property declared in the source type’s property_configs, other than its primary key. Whether every source asset must set it is that property’s requirement. At least 1 character.

incoming_links array of LinkDefinition

Links other types declare that target this type, including this type’s links to itself, oldest first. Read-only: a link is changed through its source type.

next_page_token string

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.SearchTypesRequest(
    sort={"is_descending": True, "field": "CREATED_AT"},
    page_size=1,
    next_page_token="<next page token>",
    query={"search_text": "<search text>"},
    archived_statuses={"archived_statuses": ["NOT_ARCHIVED"]},
)
response = asset_service.SearchTypes(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/v2"
	"github.com/nominal-io/nominal-api-protos-go/nominal/protos/types"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
	"google.golang.org/protobuf/proto"
)

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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.SearchTypesRequest{
		Sort: &assetv2.TypeSortOptions{
			IsDescending: true,
			Field:        assetv2.TypeSortOptions_CREATED_AT,
		},
		PageSize:      proto.Int32(1),
		NextPageToken: proto.String("<next page token>"),
		Query: &assetv2.SearchTypesQuery{
			Query: &assetv2.SearchTypesQuery_SearchText{SearchText: "<search text>"},
		},
		ArchivedStatuses: &assetv2.ArchivedStatusSet{
			ArchivedStatuses: []types.ArchivedStatus{
				types.ArchivedStatus_NOT_ARCHIVED,
			},
		},
	}
	response, err := assetService.SearchTypes(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{
  "results": [
    {
      "rid": "<rid>",
      "name": "<name>",
      "description": "<description>",
      "property_configs": {
        "<key>": {
          "requirement": "REQUIRED",
          "value_type": "STRING"
        }
      },
      "created_at": "2026-01-01T00:00:00Z",
      "icon_name": "<icon name>",
      "primary_key": "<primary key>",
      "is_archived": true,
      "data_requirements": {
        "series": {
          "series": [
            {
              "name": "<name>",
              "type": "NUMERIC"
            }
          ]
        }
      },
      "outgoing_links": [
        {
          "rid": "<rid>",
          "source_type_rid": "<source type rid>",
          "target_type_rid": "<target type rid>",
          "forward_label": "<forward label>",
          "inverse_label": "<inverse label>",
          "direct": {
            "source_property": "<source property>"
          }
        }
      ],
      "incoming_links": [
        {
          "rid": "<rid>",
          "source_type_rid": "<source type rid>",
          "target_type_rid": "<target type rid>",
          "forward_label": "<forward label>",
          "inverse_label": "<inverse label>",
          "direct": {
            "source_property": "<source property>"
          }
        }
      ]
    }
  ],
  "next_page_token": "<next page token>"
}

Traverse links#

gRPC /nominal.asset.v2.AssetService/TraverseLinks

Follows a link from a batch of assets to the assets it reaches. Fails with LinkNotFound when the link does not exist or its source type is in a workspace the caller cannot view, and with AssetNotFound when a requested asset does not exist or the caller cannot view it. A custom method rather than an asset search, since each edge pairs a requested asset with what it reaches, and forward edges can end in a value that names no asset.

Request: TraverseLinksRequest

asset_rids array of string

The assets to start from, archived or not. The caller must be able to view each one. The assets reached are always active, in both directions. 1 to 1,000 items.

link LinkRef required

Fields of LinkRef

link_rid string

direction LinkDirection

Values of LinkDirection

LINK_DIRECTION_UNSPECIFIED
LINK_DIRECTION_FORWARD: From assets of the link’s source type to the assets of its target type they link to.
LINK_DIRECTION_INVERSE: From assets of the link’s target type to the assets of its source type that link to them.

page_size integer

Defaults to 100. From 1 to 1,000.

page_token string

Response: TraverseLinksResponse

edges array of LinkEdge

Ordered by requested asset RID, then by linked asset RID. Inverse edges from assets the caller cannot view are left out. Every page but the last holds page_size edges; the last may hold fewer, or none.

Fields of LinkEdge

requested_asset_rid string

one of linked_asset_rid, unresolved_value

linked_asset_rid

linked_asset_rid string: An active asset at the other end of the link that the caller can view.

unresolved_value

unresolved_value string: Forward on a direct link only: the source property’s string value when it names no active asset of the target type that the caller can view, including blank values and values longer than any primary key. An asset the caller cannot view is indistinguishable from a missing one. Absent properties produce no edge.

next_page_token string

Present while more edges may follow. It names only the last edge returned, so it reveals nothing about edges left out.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.TraverseLinksRequest(
    link={"link_rid": "<link rid>", "direction": "LINK_DIRECTION_FORWARD"},
)
response = asset_service.TraverseLinks(request, metadata=auth)
print(response)

Response

{
  "edges": [
    {
      "requested_asset_rid": "<requested asset rid>",
      "linked_asset_rid": "<linked asset rid>"
    }
  ],
  "next_page_token": "<next page token>"
}

Unarchive#

gRPC /nominal.asset.v2.AssetService/Unarchive

Unarchives the asset with the given RID.

Request: UnarchiveRequest

asset_rid string
include_linked_workbooks boolean: If true, all auto-archived workbooks that are linked to the asset and associated runs will be unarchived as well. Defaults to false.

Response: UnarchiveResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.UnarchiveRequest(
    asset_rid="<asset rid>",
    include_linked_workbooks=True,
)
response = asset_service.Unarchive(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/v2"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/metadata"
	"google.golang.org/protobuf/proto"
)

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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.UnarchiveRequest{
		AssetRid:               "<asset rid>",
		IncludeLinkedWorkbooks: proto.Bool(true),
	}
	response, err := assetService.Unarchive(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Unarchive type#

gRPC /nominal.asset.v2.AssetService/UnarchiveType

Unarchives the asset type with the given RID.

Request: UnarchiveTypeRequest

type_rid string

Response: UnarchiveTypeResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.UnarchiveTypeRequest(type_rid="<type rid>")
response = asset_service.UnarchiveType(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.UnarchiveTypeRequest{
		TypeRid: "<type rid>",
	}
	response, err := assetService.UnarchiveType(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Update asset attachments#

gRPC /nominal.asset.v2.AssetService/UpdateAssetAttachments

Update the attachments associated with an asset.

Request: UpdateAssetAttachmentsRequest

asset_rid string
attachments_to_add array of string
attachments_to_remove array of string

Response: UpdateAssetAttachmentsResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.UpdateAssetAttachmentsRequest(
    asset_rid="<asset rid>",
    attachments_to_add=["<attachments to add>"],
    attachments_to_remove=["<attachments to remove>"],
)
response = asset_service.UpdateAssetAttachments(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.UpdateAssetAttachmentsRequest{
		AssetRid: "<asset rid>",
		AttachmentsToAdd: []string{
			"<attachments to add>",
		},
		AttachmentsToRemove: []string{
			"<attachments to remove>",
		},
	}
	response, err := assetService.UpdateAssetAttachments(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Update asset ref names#

gRPC /nominal.asset.v2.AssetService/UpdateAssetRefNames

Update the ref names for the data scopes on the asset. This update will also be applied on all associated workbooks.

Request: UpdateAssetRefNamesRequest

asset_rid string
data_scope_ref_name_updates map of string to string

Response: UpdateAssetRefNamesResponse

A message with no fields.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.UpdateAssetRefNamesRequest(
    asset_rid="<asset rid>",
    data_scope_ref_name_updates={"<key>": "<value>"},
)
response = asset_service.UpdateAssetRefNames(request, metadata=auth)
print(response)

package main

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

	assetv2 "github.com/nominal-io/nominal-api-protos-go/nominal/protos/asset/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()
	assetService := assetv2.NewAssetServiceClient(conn)
	ctx := metadata.AppendToOutgoingContext(context.Background(), "authorization", "Bearer <api key>")

	request := &assetv2.UpdateAssetRefNamesRequest{
		AssetRid: "<asset rid>",
		DataScopeRefNameUpdates: map[string]string{
			"<key>": "<value>",
		},
	}
	response, err := assetService.UpdateAssetRefNames(ctx, request)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(response)
}

Response

{}

Update type#

gRPC /nominal.asset.v2.AssetService/UpdateType

Updates a type. Will throw unless all assets that reference the type pass the updated type check.

Request: UpdateTypeRequest

type_rid string

name string

property_configs PropertyConfigMap

Tri-state: an absent wrapper leaves the value untouched; a present wrapper replaces it.

Fields of PropertyConfigMap

property_configs map of string to PropertyConfig

Fields of PropertyConfig

requirement PropertyRequirement

Values of PropertyRequirement

PROPERTY_REQUIREMENT_UNSPECIFIED
REQUIRED
SUGGESTED

value_type PropertyValueType

Values of PropertyValueType

PROPERTY_VALUE_TYPE_UNSPECIFIED
STRING
NUMBER

description string

icon_name string

primary_key string

data_requirements DataRequirements

Absent leaves the requirements unchanged. Present replaces them; requiring no series clears them. Assets that already have the type are not rechecked, unlike property_configs, which every such asset must still satisfy.

Fields of DataRequirements

series SeriesRequirements

Fields of SeriesRequirements

series array of SeriesRequirement

At most 200, with unique names. At most 200 items.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

links LinkDefinitionList

Absent leaves the links unchanged. Present replaces the type’s outgoing links: an entry with a rid keeps that link and replaces its labels, an entry without one adds a link, and an existing link whose rid is left out is removed. A type’s outgoing_links can be sent back as read. Present property configs must still declare every remaining link’s property as a string.

Fields of LinkDefinitionList

links array of LinkDefinition

At most 20 items.

Fields of LinkDefinition

rid string

Server-assigned. In an update, names one of the type’s existing links, whose kind and target type cannot change; absent adds a new link. Must be absent on create.

source_type_rid string

Read-only: always present in responses. Leave it unset in requests, where the source is the type being created or updated; a value sent there is ignored.

target_type_rid string

May be the source type itself.

forward_label string

The link’s name seen from the source type, absent if not set. Clients typically fall back to the target type’s name. 1 to 100 characters.

inverse_label string

The link’s name seen from the target type, absent if not set. Clients typically fall back to the source type’s name. 1 to 100 characters.

direct DirectLink

Fields of DirectLink

source_property string: A string property declared in the source type’s property_configs, other than its primary key. Whether every source asset must set it is that property’s requirement. At least 1 character.

Response: UpdateTypeResponse

type Type

Fields of Type

rid string

name string

description string

property_configs map of string to PropertyConfig

Fields of PropertyConfig

requirement PropertyRequirement

Values of PropertyRequirement

PROPERTY_REQUIREMENT_UNSPECIFIED
REQUIRED
SUGGESTED

value_type PropertyValueType

Values of PropertyValueType

PROPERTY_VALUE_TYPE_UNSPECIFIED
STRING
NUMBER

created_at string (date-time)

icon_name string

The name of the icon to display for the type. This name maps to a Lucide icon in the frontend.

primary_key string

The property that identifies an asset of this type. It is a required nonempty string and is not repeated in property_configs.

is_archived boolean

data_requirements DataRequirements

Requirements on the data of assets of this type, absent if none were ever set. Checked when the type is attached to an asset; later data or definition changes are not rechecked.

Fields of DataRequirements

series SeriesRequirements

Fields of SeriesRequirements

series array of SeriesRequirement

At most 200, with unique names. At most 200 items.

Fields of SeriesRequirement

name string

A channel name of 1 to 200 characters, matched exactly. 1 to 200 characters.

type SeriesType

Values of SeriesType

SERIES_TYPE_UNSPECIFIED
NUMERIC: Double, int64 or uint64 points.
STRING
LOG
NUMERIC_ARRAY
STRING_ARRAY
STRUCT

outgoing_links array of LinkDefinition

Links this type declares, oldest first.

Fields of LinkDefinition

rid string

Server-assigned. In an update, names one of the type’s existing links, whose kind and target type cannot change; absent adds a new link. Must be absent on create.

source_type_rid string

Read-only: always present in responses. Leave it unset in requests, where the source is the type being created or updated; a value sent there is ignored.

target_type_rid string

May be the source type itself.

forward_label string

The link’s name seen from the source type, absent if not set. Clients typically fall back to the target type’s name. 1 to 100 characters.

inverse_label string

The link’s name seen from the target type, absent if not set. Clients typically fall back to the source type’s name. 1 to 100 characters.

direct DirectLink

Fields of DirectLink

source_property string: A string property declared in the source type’s property_configs, other than its primary key. Whether every source asset must set it is that property’s requirement. At least 1 character.

incoming_links array of LinkDefinition

Links other types declare that target this type, including this type’s links to itself, oldest first. Read-only: a link is changed through its source type.

Request

Python

import grpc
from nominal.protos.asset.v2 import asset_pb2, asset_pb2_grpc

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

request = asset_pb2.UpdateTypeRequest(
    type_rid="<type rid>",
    name="<name>",
    property_configs={
        "property_configs": {
            "<key>": {"requirement": "REQUIRED", "value_type": "STRING"},
        },
    },
    description="<description>",
    icon_name="<icon name>",
    primary_key="<primary key>",
    data_requirements={"series": {"series": [{"name": "<name>", "type": "NUMERIC"}]}},
    links={
        "links": [
            {
                "rid": "<rid>",
                "source_type_rid": "<source type rid>",
                "target_type_rid": "<target type rid>",
                "forward_label": "<forward label>",
                "inverse_label": "<inverse label>",
                "direct": {"source_property": "<source property>"},
            },
        ],
    },
)
response = asset_service.UpdateType(request, metadata=auth)
print(response)

Response

{
  "type": {
    "rid": "<rid>",
    "name": "<name>",
    "description": "<description>",
    "property_configs": {
      "<key>": {
        "requirement": "REQUIRED",
        "value_type": "STRING"
      }
    },
    "created_at": "2026-01-01T00:00:00Z",
    "icon_name": "<icon name>",
    "primary_key": "<primary key>",
    "is_archived": true,
    "data_requirements": {
      "series": {
        "series": [
          {
            "name": "<name>",
            "type": "NUMERIC"
          }
        ]
      }
    },
    "outgoing_links": [
      {
        "rid": "<rid>",
        "source_type_rid": "<source type rid>",
        "target_type_rid": "<target type rid>",
        "forward_label": "<forward label>",
        "inverse_label": "<inverse label>",
        "direct": {
          "source_property": "<source property>"
        }
      }
    ],
    "incoming_links": [
      {
        "rid": "<rid>",
        "source_type_rid": "<source type rid>",
        "target_type_rid": "<target type rid>",
        "forward_label": "<forward label>",
        "inverse_label": "<inverse label>",
        "direct": {
          "source_property": "<source property>"
        }
      }
    ]
  }
}

Errors#

Errors shows how these errors are sent.

Code	Reason	Message
`INVALID_ARGUMENT`	`ASSET_ERROR_INVALID_REQUEST`	InvalidAssetRequest
`NOT_FOUND`	`ASSET_ERROR_LINK_NOT_FOUND`	LinkNotFound
`PERMISSION_DENIED`	`ASSET_ERROR_PERMISSION_DENIED`	AssetPermissionDenied

Asset service (gRPC)#

Endpoints#

Add data scopes to asset#

Archive#

Archive type#

Batch edit asset metadata#

Create asset#

Create or update asset by primary key#

Create type#

Delete type#

Get asset data conformance#

Get assets#

Get assets by data source#

Get types#

Search assets#

Search types#

Traverse links#

Unarchive#

Unarchive type#

Update asset#

Update asset attachments#

Update asset ref names#

Update type#

Errors#

Types#

ArchivedStatus#

ArchivedStatusSet#

Asset#

AssetData#

AssetDataConformance#

AssetRidsFilter#

AssetSortField#

AssetSortOptions#

AssetTypesFilter#

ConflictBehavior#

CreateAssetDataScope#

CreateAssetDataScopeList#

CreateAssetRequest#

DataRequirements#

DataRequirementsMet#

DataRequirementsUnknown#

DataRequirementsUnmet#

DataScope#

DataSource#

DirectLink#

Duration#

IfAssetExists#

LabelsFilter#

LabelUpdateWrapper#

Link#

LinkDefinition#

LinkDefinitionList#

LinkDirection#

LinkEdge#

LinkList#

LinkRef#

MergePropertyValuesForKey#

MetadataChange#

NumericPropertyPredicate#

NumericPropertyRangeOperator#

NumericPropertyRangePredicate#

OverwriteOnConflict#

PropertiesFilter#

Property#

PropertyComparisonOperator#

PropertyConfig#

PropertyConfigMap#

PropertyRequirement#

PropertyUpdateWrapper#

PropertyValueType#

RenameLabel#

RenamePropertyKey#

SearchAssetsQuery#

SearchAssetsQueryList#

SearchTypesQuery#

SearchTypesQueryList#

SeriesRequirement#

SeriesRequirements#

SeriesType#

SetOperator#