pub struct MetadataApi<'a> { /* private fields */ }Implementations§
Source§impl<'a> MetadataApi<'a>
Sub-API for metadata endpoints.
impl<'a> MetadataApi<'a>
Sub-API for metadata endpoints.
Sourcepub async fn get_field_options(
&self,
request: GetFieldOptionsRequest,
) -> Result<Value, RsError>
pub async fn get_field_options( &self, request: GetFieldOptionsRequest, ) -> Result<Value, RsError>
For a given field, return all the available tags (nodes) or selectable options.
§Arguments
request- Parameters built viaGetFieldOptionsRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn get_node_id(
&self,
request: GetNodeIdRequest,
) -> Result<Value, RsError>
pub async fn get_node_id( &self, request: GetNodeIdRequest, ) -> Result<Value, RsError>
Find a node ID (entry in a fixed tag field) given the name of the node.
§Arguments
request- Parameters built viaGetNodeIdRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn get_nodes(
&self,
request: GetNodesRequest,
) -> Result<Value, RsError>
pub async fn get_nodes( &self, request: GetNodesRequest, ) -> Result<Value, RsError>
Get all nodes (fixed keywords) from database for a specific metadata field or parent.
§Arguments
request- Parameters built viaGetNodesRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn add_resource_nodes(
&self,
request: AddResourceNodesRequest,
) -> Result<Value, RsError>
pub async fn add_resource_nodes( &self, request: AddResourceNodesRequest, ) -> Result<Value, RsError>
Add all node IDs (field options) in the list to a resource.
§Arguments
request- Parameters built viaAddResourceNodesRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn add_resource_nodes_multi(
&self,
request: AddResourceNodesMultiRequest,
) -> Result<Value, RsError>
pub async fn add_resource_nodes_multi( &self, request: AddResourceNodesMultiRequest, ) -> Result<Value, RsError>
Add all node IDs (field options) in the list to the resources specified.
§Arguments
request- Parameters built viaAddResourceNodesMultiRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn set_node(&self, request: SetNodeRequest) -> Result<Value, RsError>
pub async fn set_node(&self, request: SetNodeRequest) -> Result<Value, RsError>
Create a new node (option for a fixed list field).
§Arguments
request- Parameters built viaSetNodeRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn get_resource_type_fields(
&self,
request: GetResourceTypeFieldsRequest,
) -> Result<Value, RsError>
pub async fn get_resource_type_fields( &self, request: GetResourceTypeFieldsRequest, ) -> Result<Value, RsError>
Get metadata field information for all (matching) fields.
Available from RS version 10.3+ and requires permission a.
§Arguments
request- Parameters built viaGetResourceTypeFieldsRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn create_resource_type_field(
&self,
request: CreateResourceTypeFieldRequest,
) -> Result<Value, RsError>
pub async fn create_resource_type_field( &self, request: CreateResourceTypeFieldRequest, ) -> Result<Value, RsError>
Create a metadata field.
Available from RS version 10.3+ and requires permission a.
§Arguments
request- Parameters built viaCreateResourceTypeFieldRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn toggle_active_state_for_nodes(
&self,
request: ToggleActiveStatesForNodesRequest,
) -> Result<Value, RsError>
pub async fn toggle_active_state_for_nodes( &self, request: ToggleActiveStatesForNodesRequest, ) -> Result<Value, RsError>
Toggle nodes’ active state.
Available from RS version 10.4+ and requires permission k.
§Arguments
request- Parameters built viaToggleActiveStatesForNodesRequest
§TODO: Returns
§TODO: Errors
§TODO: Examples
Sourcepub async fn update_field(
&self,
request: UpdateFieldRequest,
) -> Result<Value, RsError>
pub async fn update_field( &self, request: UpdateFieldRequest, ) -> Result<Value, RsError>
Set the value of a metadata field.
§Arguments
request- Parameters built viaUpdateFieldRequest