Skip to main content

FactsResource

Struct FactsResource 

Source
pub struct FactsResource<'a> { /* private fields */ }
Expand description

client.facts()

Implementations§

Source§

impl<'a> FactsResource<'a>

Source

pub fn create(&self, body: &Value) -> Result<Value>

Create a fact definition

POST /facts

Creates a reusable metric or selection definition. Values for individual events are managed separately. Requires the “edit masterdata” permission for the service planning domain.

§Example
let body = serde_json::json!({
    "name": "Attendance",
    "type": "number",
    "unit": "people"
});
let result = client.facts().create(&body)?;
println!("{:?}", result);
Source

pub fn delete(&self, id: impl Display) -> Result<()>

Delete a fact definition

DELETE /facts/{id}

Deletes the reusable definition, all values recorded for it on events, its assignments in event templates and its fact-specific permissions. To remove only one recorded value, use DELETE /events/{eventId}/facts/{factId}. With dry_run=true, no deletion is performed and the API returns 409 with a deletion report even when deletable is true. A successful actual deletion returns 204. Requires permission to edit service-planning master data (the “edit masterdata” permission for the service planning domain).

Use Self::delete_with to pass query parameters.

§Example
client.facts().delete(3)?;
Source

pub fn delete_with( &self, id: impl Display, query: &DeleteFactsIdQuery, ) -> Result<()>

Delete a fact definition

Like Self::delete, with query parameters.

DELETE /facts/{id}

Deletes the reusable definition, all values recorded for it on events, its assignments in event templates and its fact-specific permissions. To remove only one recorded value, use DELETE /events/{eventId}/facts/{factId}. With dry_run=true, no deletion is performed and the API returns 409 with a deletion report even when deletable is true. A successful actual deletion returns 204. Requires permission to edit service-planning master data (the “edit masterdata” permission for the service planning domain).

Source

pub fn get(&self, id: impl Display) -> Result<Value>

Get a fact definition

GET /facts/{id}

Returns the reusable definition, including the numeric unit or available selection labels. This does not return values recorded for events and does not check permission to view those values.

§Example
let result = client.facts().get(3)?;
println!("{:?}", result);
Source

pub fn list(&self) -> Result<Vec<Value>>

List fact definitions

GET /facts

A fact definition describes a reusable metric (number) or selection (select), such as attendance or service type. It is separate from the value recorded for an individual event. Returns all definitions, ordered by sortKey ascending and then name ascending, without pagination. Definitions are not filtered by permissions to view recorded fact values.

§Example
for fact in client.facts().list()? {
    println!("{:?}", fact);
}
Source

pub fn update(&self, id: impl Display, body: &Value) -> Result<Value>

Replace a fact definition

PUT /facts/{id}

Replaces the definition’s name, type, sort order and type-specific settings. Stored event values are not migrated or validated against a changed type or option list. Requires the “edit masterdata” permission for the service planning domain; permission to edit an individual fact value is not sufficient.

§Example
let body = serde_json::json!({
    "name": "Attendance",
    "type": "number",
    "unit": "people"
});
let result = client.facts().update(3, &body)?;
println!("{:?}", result);

Trait Implementations§

Source§

impl<'a> Clone for FactsResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for FactsResource<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for FactsResource<'a>

§

impl<'a> !UnwindSafe for FactsResource<'a>

§

impl<'a> Freeze for FactsResource<'a>

§

impl<'a> Send for FactsResource<'a>

§

impl<'a> Sync for FactsResource<'a>

§

impl<'a> Unpin for FactsResource<'a>

§

impl<'a> UnsafeUnpin for FactsResource<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more