pub struct FactsResource<'a> { /* private fields */ }Expand description
client.facts()
Implementations§
Source§impl<'a> FactsResource<'a>
impl<'a> FactsResource<'a>
Sourcepub fn create(&self, body: &Value) -> Result<Value>
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);Sourcepub fn delete(&self, id: impl Display) -> Result<()>
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)?;Sourcepub fn delete_with(
&self,
id: impl Display,
query: &DeleteFactsIdQuery,
) -> Result<()>
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).
Sourcepub fn get(&self, id: impl Display) -> Result<Value>
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);Sourcepub fn list(&self) -> Result<Vec<Value>>
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);
}Sourcepub fn update(&self, id: impl Display, body: &Value) -> Result<Value>
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);