Struct ListRelationsQuery 

pub struct ListRelationsQuery {
    pub direction: String,
    pub relation_type: String,
    pub include_superseded: bool,
    pub include_tombstoned: bool,
    pub limit: Option<u32>,
}

GET /v1/entities/{id}/relations query parameters. The anchor entity comes from the path id.

Fields

direction: String

from/outgoing (default) or to/incoming.

relation_type: String

Relation-type filter; omitted → any type.

include_superseded: bool

Include superseded relations (default false).

include_tombstoned: bool

Include tombstoned relations (default false).

limit: Option<u32>

Page size; omitted → 100, clamped to 1..=1000.

Implementations

impl ListRelationsQuery

pub fn side(&self) -> Result<RelationSide, String>

Resolve the requested side (outgoing vs incoming).

pub fn to_from_request( &self, id: &str, ) -> Result<RelationListFromRequest, String>

Build the outgoing (RELATION_LIST_FROM) wire request from the path id.

pub fn to_to_request(&self, id: &str) -> Result<RelationListToRequest, String>

Build the incoming (RELATION_LIST_TO) wire request from the path id.

Trait Implementations

impl Debug for ListRelationsQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListRelationsQuery

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListRelationsQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.