Search Objects

Use SearchObjects to retrieve a snapshot of Objects that match filter criteria. The operation evaluates the query at request time and returns paginated results. For initial state plus live changes, use Stream instead.

Query Criteria

The query selects which Objects to return. An omitted or empty query returns all Objects. Multiple values within one field combine with OR; different fields combine with AND.

Field Selects Objects by

Field	Selects Objects by
`object_ids`	Specific Object IDs.
`statuses`	Lifecycle status, such as `OBJECT_STATUS_ACTIVE`.
`affiliations`	Assessed affiliation, such as `AFFILIATION_FRIEND` or `AFFILIATION_HOSTILE`.
`environments`	Operating environment, such as surface, air, or subsurface.
`flags`	Operational flags, such as simulation, exercise, and actionability.
`provenance`	Source, update time, or source node.

object_ids

Specific Object IDs.

statuses

Lifecycle status, such as OBJECT_STATUS_ACTIVE.

affiliations

Assessed affiliation, such as AFFILIATION_FRIEND or AFFILIATION_HOSTILE.

environments

Operating environment, such as surface, air, or subsurface.

flags

Operational flags, such as simulation, exercise, and actionability.

provenance

Source, update time, or source node.

Pagination

Results are returned in pages using an opaque cursor.

Omit cursor to request the first page.
page_size sets the maximum Objects per page. The default is 10 and the maximum is 1000.
Each response returns next_cursor. Pass it back as cursor to read the next page.
next_cursor is empty when there are no more results.

Treat next_cursor as opaque and do not parse it.

Minimal Shape

{
  "query": {
    "statuses": ["OBJECT_STATUS_ACTIVE"],
    "affiliations": ["AFFILIATION_FRIEND"]
  },
  "page_size": 100
}

Related Operations

Use Get when you already know the Object ID. Use Publish to create, update, or delete Objects. Use Stream for initial state plus live updates.